Chapter 5. Completeness

Image

I try to leave out the parts that people skip.

—Elmore Leonard

From the user’s point of view, completeness means that all of the required information is available. A subject is covered completely when:

• All of the relevant information is covered

• Each subject is covered in sufficient detail

• All promised information is included

Ensuring that your information is complete involves more than checking items off of a list—it starts with building the right list of what to include. You need to understand the purpose of the information that you are creating, for example:

• Who is your audience?

• What is your audience’s level ...

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

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