Developing Quality Technical Information: A Handbook for Writers and Editors (IBM Press)

The #1 Guide to Excellence in Technical Communication—Fully Updated for Embedded Assistance, Mobile, Search, Multimedia, and More

 

Direct from IBM’s own content design experts, this guide shows you how to design product interfaces and technical information that always place users front and center. This edition has been fully revised to help you consistently deliver the right content at the right time.

 

You’ll master today’s best practices to apply nine essential characteristics of high-quality technical information: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness.

 

Coverage Includes

• Advocating for users throughout the entire product development process
• Delivering information in an ordered manner by following progressive disclosure techniques
• Optimizing content so that users can find it from anywhere
• Streamlining information for mobile delivery
• Helping users right where they are

Whether you’re a writer, editor, information architect, user experience professional, or reviewer, this book shows you how to create great technical information, from the product design to the user interface, topics, and other media.

• Thoroughly revised and updated
• Extensive new coverage of self-documenting interfaces and embedded assistance
• Updated practical guidelines and checklists
• Hundreds of new examples