Developing Quality Technical Information: A Handbook for Writers and Editors, 3rd edition

Published by IBM Press (June 25, 2014) © 2014

  • Michelle Carey
  • Moira McFadden Lanyi All of IBM, San Jose, California
  • Deirdre Longo both of Santa Teresa Laboratory, San Jose, California
  • Shannon Rouiller All of IBM, San Jose, California
  • Eric Radzinski IBM Santa Theresa Labs., San Jose, California
  • Elizabeth Wilde

eTextbook

$47.99

  • Available for purchase from all major ebook resellers, including InformIT.com.
  • To request a review copy, click on the "Request a Review Copy" button.
$39.99

  • A print text (hardcover or paperback) 
  • Free shipping
  • Also available for purchase as an ebook from all major ebook resellers, including InformIT.com

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.

  • Reflects the changing and growing role of technical communicators in designing more usable products and embedding the right help at the right time, exactly where users need it
  • Brings together IBM's proven guidelines and checklists for creating exceptionally effective content
  • Helps you meet 9 core quality characteristics: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness
  • Extensive "before-and-after" examples show how to avoid or fix problems

The previous (second) edition emphasizes topic-based writing. In the new third edition, the authors address the changing role of technical communicators as core members of user interface design teams. They emphasize guidelines covering the full range of content that technical communicators are now responsible for, including content embedded in a product's user interface. These guidelines establish breakthrough best practices, and are supported with many new before-and-after examples.

The full text downloaded to your computer

With eBooks you can:

  • search for key concepts, words and phrases
  • make highlights and notes as you study
  • share your notes with friends

eBooks are downloaded to your computer and accessible either offline through the Bookshelf (available as a free download), available online and also via the iPad and Android apps.

Upon purchase, you'll gain instant access to this eBook.

  • Preface    
  • Acknowledgments   
  • About the authors    
  • Part 1. Introduction   
  • Chapter 1. Technical information continues to evolve   
  • Embedded assistance  
  • Progressive disclosure of information   
  • The technical writer’s role today   
  • Redefining quality technical information   
  • Chapter 2. Developing quality technical information   
  • Preparing to write: understanding users, goals, and product tasks   
  • Writing and rewriting   
  • Reviewing, testing, and evaluating technical information   
  • Part 2. Easy to use   
  • Chapter 3. Task orientation   
  • Write for the intended audience   
  • Present information from the users’ point of view   
  • Focus on users’ goals   
  • Identify tasks that support users’ goals   
  • Write user-oriented task topics, not function-oriented task topics   
  • Avoid an unnecessary focus on product features   
  • Indicate a practical reason for information   
  • Provide clear, step-by-step instructions   
  • Make each step a clear action for users to take   
  • Group steps for usability   
  • Clearly identify steps that are optional or conditional   
  • Task orientation checklist   
  • Chapter 4. Accuracy   
  • Research before you write   
  • Verify information that you write   
  • Maintain information currency   
  • Keep up with technical changes   
  • Avoid writing information that will become outdated   
  • Maintain consistency in all information about a subject   
  • Reuse information when possible   

The authors are all long-standing and respected members of the information development community at IBM. Although the authors have served in various roles throughout their careers, information quality has always been and continues to be their primary focus.

Michelle Carey is an information architect and technical editor at IBM and has taught technical communication at University of California Santa Cruz Extension. Michelle is the co-author of the book DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA. She is an expert on topic-based information systems, software product error messages, grammar, embedded assistance for user interfaces, and writing for international audiences. She also writes computational linguistic rules for a grammar, style, and terminology management tool. Michelle enjoys teaching, grammar, herding cats, and riding and driving anything with a lot of horsepower.

Moira McFadden Lanyi is an information architect and technical editor at IBM. She has experience with topic-based writing, DITA, embedded assistance, user interface design, and visual design. She created 99% of the artwork in this book. She is a co-author of the book An Introduction to IMS. Moira enjoys visiting San Francisco with her family as often as possible, cooking fresh, healthy meals, and watching her courageous son ride his unicycle and surf.

Deirdre Longo is an information architect and strategist at IBM. She has been a pioneer for embedded assistance in IBM: defining the scope of that term, developing standards for embedded assistance, and modeling how to work effectively in cross-disciplinary teams. She has taught webinars for the Society of Technical Communication (STC) and published articles on information architecture topics in STC’s Intercom. She is an avid yoga practitioner.

Eric Radzinski is a technical editor and information architect for industry-leading mainframe database software at IBM. He is a co-author of The IBM Style Guide: Conventions for Writers and Editors and is well versed in topic-based writing, embedded assistance, DITA, and writing for a global audience. Eric makes his home in San Jose, California, with his wife and their three children.

Shannon Rouiller is an information architect and technical editor at IBM. She has experience with quality metrics, topic-based information systems, DITA, videos, embedded assistance, and user interface design. She is a co-author of the book Designing Effective Wizards. Shannon dabbles in sports photography and likes to solve puzzles.

Elizabeth Wilde is an information quality strategist at IBM, developing strategies and education for developing high-quality content. She develops Acrolinx computational linguistic rules that enforce grammar, style, and DITA tagging rules. She teaches an extension course in technical writing at the University of California Santa Cruz. Her hobbies include growing cacti and succulents and collecting tattoos.

Need help? Get in touch

Video
Play
Privacy and cookies
By watching, you agree Pearson can share your viewership data for marketing and analytics for one year, revocable by deleting your cookies.

Pearson eTextbook: What’s on the inside just might surprise you

They say you can’t judge a book by its cover. It’s the same with your students. Meet each one right where they are with an engaging, interactive, personalized learning experience that goes beyond the textbook to fit any schedule, any budget, and any lifestyle.Â