Part 3: Easy to understand

Image

Users appreciate technical information that can be understood with as little effort as possible. After all, people don’t read technical information for pleasure; they read it to accomplish a task quickly. Information that is easy to understand is clear, unambiguous, concrete, and consistent where it counts.

Chapter 6. Clarity

Focus on the meaning

Eliminate wordiness

Write coherently

Avoid ambiguity

Use words as only one part of speech

Avoid empty words

Use words with a clear meaning

Write positively

Make the syntax of sentences clear

Use pronouns correctly

Place modifiers appropriately

Use technical terms consistently ...

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.