Consider Your Audience

The reader can use this document to…(purpose of document).

I have checked readability levels.

I have included all necessary information, and left out all other.

Organize the Content

I’ve included an overview or forecasting statement.

Informative headings describe content.

Text is broken into logical pieces; plenty of white space is used.

My paragraphs proceed logically from general to specific.

I have given examples to reduce abstractions.

I’ve included lists and tables to give overviews and summaries.

I have used bulleted and numbered lists appropriately.

Style and Clear Sentences

Sentences are of varying length, not too long.

I’ve used readable, straightforward sentence patterns.

In general, the sentences are in active voice.

I’ve explained abbreviations when first used.

I’ve avoided difficult words and unnecessary jargon, and omitted needless words.

I have avoided too many nominalizations.

I’ve used positive rather than negative statements.

Step-by-Step Procedures

The steps of the procedure are in logical order and numbered.

Somebody checked my procedure.

The capitalization and spelling of interface items is correct.

Short cut keys are clearly described.

Graphics and Tables

Tables and graphics are placed near the text that refers to them.

I’ve included graphs, screen shots or flowcharts where necessary.

Layout - Typography

I have used bold, and maybe italics, underlining or color to aid comprehension.

I haven’t written much in ALL CAPS, except in key names.

Type face and type size are readable, and I’ve used ragged right margins

There is ample white space and my document looks good.

Spelling and Grammar

I have checked for my usual grammar errors.

I have done a spelling check.