Part 3Easy to find

Image

Finding information is essential, whether you're a new user trying to figure out where to start and what to do or an experienced user looking for a parameter for a command. The organization, retrievability, and visual effectiveness of information contribute most to whether users can find the information that they need.

Chapter 8. Organization

Organize information into discrete topics by type

Organize tasks by order of use

Organize topics for quick retrieval

Separate contextual information from other types of information

Organize information consistently

Provide an appropriate number of subentries for each branch

Emphasize ...

Get Developing Quality Technical Information: A Handbook for Writers and Editors, Second 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.