Chapter 12. Applying more than one quality characteristic

This book presents each quality characteristic in a separate chapter, but in practice you will apply the guidelines for more than one quality characteristic to the information that you create. With practice, you can discern the effects of each quality characteristic and how to make improvements.

Good embedded assistance, for example, must be task oriented, accurate, well organized, clear, and retrievable. Good embedded assistance primarily contributes to task orientation, but it also contributes to organization by providing information where users expect it and to retrievability by providing paths to more detailed information where necessary.

You can best improve technical information ...

Get Developing Quality Technical Information: A Handbook for Writers and Editors, Third Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.