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