Part 2: Easy to use

Image

Users access technical information to accomplish a goal, which typically involves doing one or more tasks. Technical information should make it easy for users to successfully achieve their goals. It should be trustworthy. Users should have all of the information they need without being overloaded with extraneous information.

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 ...

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

O’Reilly members experience live online training, plus books, videos, and digital content from nearly 200 publishers.