Author : Michelle Carey
Publisher : Pearson Education
Page : 612 pages
File Size : 37,87 MB
Release : 2014
Category : Computers
ISBN : 0133118975
Drawing on IBM's unsurpassed technical communications experience, readers discover today's best practices for meeting nine quality characteristics: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness. Packed with guidelines, checklists, and before-and-after examples, Developing Quality Technical Information, Third Edition is an indispensable resource for the future of technical communication.
Author :
Publisher : BRILL
Page : 275 pages
File Size : 10,53 MB
Release : 2021-11-22
Category : Language Arts & Disciplines
ISBN : 9004484515
User manuals, reference guides, project documentation, equipment specifications and other technical documents are increasingly subjected to high quality standards. However, it is not clear whether research efforts are keeping pace with this increasing importance of documentation quality. This volume includes studies from researchers as well as practitioners, exemplifying three approaches towards document quality: • Product-orientation, with an eye for usability in various manifestations such as tutorials, concept definitions, tools for users of documentation to find information, methods of eliciting user feedback, and cultural differences; • Process-orientation, in which the quality of technical documentation is regarded as an outgrowth of a process involving sub-steps such as storyboarding, pre-testing and use of automation tools in writing and producing documents; • Professional orientation, in which attention is focused on those who create technical documentation. The volume will be of interest to a broad audience of writers, managers and trainers with technical and non-technical backgrounds, such as: quality managers; communication managers; technical communicators; trainers in computer usage; teachers, researchers and students of (technical) communication.
Author : Gretchen Hargis
Publisher : Pearson Education
Page : 550 pages
File Size : 13,52 MB
Release : 2004-04-06
Category : Technology & Engineering
ISBN : 0137034784
"The examples are excellent--right on target and easy to understand and adapt. Even those who don't adopt the entire procedure can profit from the parts, but the greatest value will flow to those who adopt the whole." --Carolyn Mulford, senior writer and editor of Writing That Works "This is also a book that students can keep for their professional libraries because it will increase in its value to them after they leave class and face real life experiences on the job. It is plain enough for them to understand while they are learning, and at the same time comprehensive enough to support them as professionals." --Elizabeth Boling, Instructional Systems Technology, Indiana University "It practices what it preaches. Its guidelines are understandable and appropriate; its examples clear. It contains exactly what writers and editors need to know. It is the book that I would have written." --Cynthia E. Spellman, Unisys The #1 guide to excellence in documentation--now completely updated! A systematic, proven approach to creating great documentation Thoroughly revised and updated More practical examples More coverage of topic-based information, search, and internationalization Direct from IBM's own documentation experts, this is the definitive guide to developing outstanding technical documentation--for the Web and for print. Using extensive before-and-after examples, illustrations, and checklists, the authors show exactly how to create documentation that's easy to find, understand, and use. This edition includes extensive new coverage of topic-based information, simplifying search and retrievability, internationalization, visual effectiveness, and much more. Coverage includes: Focusing on the tasks and topics users care about most Saying more with fewer words Using organization and other means to deliver faster access to information Presenting information in more visually inviting ways Improving the effectiveness of your review process Learning from example: sample text, screen captures, illustrations, tables, and much more Whether you're a writer, editor, designer, or reviewer, if you want to create great documentation, this book shows you how!
Author : Jared Bhatti
Publisher : Apress
Page : 0 pages
File Size : 18,90 MB
Release : 2021-10-01
Category : Computers
ISBN : 9781484272169
Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users’ needs to publishing, measuring, and maintaining useful developer documentation. Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects. Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation—tools you can adapt to the needs of your own organization. What You'll Learn Create friction logs and perform user research to understand your users’ frustrations Research, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notes Publish and maintain documentation alongside regular code releases Measure the success of the content you create through analytics and user feedback Organize larger sets of documentation to help users find the right information at the right time Who This Book Is For Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.
Author : Alison Black
Publisher : Taylor & Francis
Page : 767 pages
File Size : 30,88 MB
Release : 2017-01-12
Category : Business & Economics
ISBN : 1317125290
Information Design provides citizens, business and government with a means of presenting and interacting with complex information. It embraces applications from wayfinding and map reading to forms design; from website and screen layout to instruction. Done well it can communicate across languages and cultures, convey complicated instructions, even change behaviours. Information Design offers an authoritative guide to this important multidisciplinary subject. The book weaves design theory and methods with case studies of professional practice from leading information designers across the world. The heavily illustrated text is rigorous yet readable and offers a single, must-have, reference to anyone interested in information design or any of its related disciplines such as interaction design and information architecture, information graphics, document design, universal design, service design, map-making and wayfinding.
Author : Katherine Haramundanis
Publisher :
Page : 292 pages
File Size : 48,71 MB
Release : 1992
Category : Computers
ISBN : 9781555580803
An explanation of how to gather, dissect and understand technical information and how to organize and present it for the reader.
Author : Michaël Steehouder
Publisher : Rodopi
Page : 282 pages
File Size : 49,9 MB
Release : 1994
Category : Language Arts & Disciplines
ISBN : 9789051836271
User manuals, reference guides, project documentation, equipment specifications and other technical documents are increasingly subjected to high quality standards. However, it is not clear whether research efforts are keeping pace with this increasing importance of documentation quality. This volume includes studies from researchers as well as practitioners, exemplifying three approaches towards document quality: - Product-orientation, with an eye for usability in various manifestations such as tutorials, concept definitions, tools for users of documentation to find information, methods of eliciting user feedback, and cultural differences; - Process-orientation, in which the quality of technical documentation is regarded as an outgrowth of a process involving sub-steps such as storyboarding, pre-testing and use of automation tools in writing and producing documents; - Professional orientation, in which attention is focused on those who create technical documentation. The volume will be of interest to a broad audience of writers, managers and trainers with technical and non-technical backgrounds, such as: quality managers; communication managers; technical communicators; trainers in computer usage; teachers, researchers and students of (technical) communication.
Author : Microsoft Corporation
Publisher : Pearson Education
Page : 823 pages
File Size : 40,91 MB
Release : 2012-01-15
Category : Computers
ISBN : 0735669791
Maximize the impact and precision of your message! Now in its fourth edition, the Microsoft Manual of Style provides essential guidance to content creators, journalists, technical writers, editors, and everyone else who writes about computer technology. Direct from the Editorial Style Board at Microsoft—you get a comprehensive glossary of both general technology terms and those specific to Microsoft; clear, concise usage and style guidelines with helpful examples and alternatives; guidance on grammar, tone, and voice; and best practices for writing content for the web, optimizing for accessibility, and communicating to a worldwide audience. Fully updated and optimized for ease of use, the Microsoft Manual of Style is designed to help you communicate clearly, consistently, and accurately about technical topics—across a range of audiences and media.
Author : Mary K. McCaskill
Publisher :
Page : 128 pages
File Size : 14,37 MB
Release : 1990
Category : Technical writing
ISBN :
Author : Joost Schilperoord
Publisher : BRILL
Page : 347 pages
File Size : 19,64 MB
Release : 2022-03-07
Category : Language Arts & Disciplines
ISBN : 900445859X
A central issue of cognitive studies of text production is What goes on in people's minds when they produce a text?, How do they plan the text?, How do they decide in what order to express their thoughts? In this volume, writers are followed in their footsteps during the moment-to-moment process of producing routine business letters. Their writing processes are explored in real time with the ultimate goal to contribute to a cognitive theory of text production. Such a theory should tell what kind of mental structures underly text production, how these structures are converted into coherent texts, and how this process is framed within real writing time. The study starts from a large corpus of real-life text production processes. It combines methods to explore both process and product of text production. Processes are described by analyzing the pause patterns that emerge in the course of writing. Products are described by analyzing their hierarchical structure. Together, these descriptions yield several significant insights in the real time organization of cognitive processes in production. The study can be characterized as a cognitive linguistic approach to text production. This volume will be of special interest to researchers in the field of (psycho-)linguistics, textlinguistics and cognitive science.
