Developing Quality Technical Information: A Handbook for Writers and Editors, Second Edition

Appendix CQuality characteristics and elements

Many technical writing books are organized around information elements. They deal with what to do and not do at the level of words, sentences, tables, and so on.

Table 9 on page 399 shows how the quality characteristics apply to these elements.

Looking at the quality characteristics

Some quality characteristics operate mainly from the bottom up. Large semantic elements (such as task topics) have the quality characteristic because the small elements (such as headings and ordered lists) do. You need to focus on the small elements to ensure that information has these quality characteristics:

Accuracy ...