Chapter 4Completeness


A successful book is not made of what is in it, but what is left out of it.

—Mark Twain

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, and all promised information is included.

Ensuring completeness involves more than checking items off of a list—it starts with building the right list of what to include. To determine whether the information that you write is complete, you must first know your audience. You need to understand the purpose ...

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