Email this Page Log Support Call Send Feedback Print

Previous Topic

Next Topic

Book Contents

Book Index

Reviewing Your Document

After you have completed your first draft, you will need to have it reviewed. We recommend that the document is reviewed by people other than the authors. Reviewing your own work is almost impossible - you tend to read the document as you want it to read, not as it actually is.

There are usually four drafts in a good documentation process:

  • First Draft: to check all the content for technical accuracy and completeness. The first draft review should be performed by technical people with an intricate knowledge of the subject matter. They do not have to worry about spelling and grammar (however, they should obviously note any problems they do find).
  • Second Draft: to confirm that the comments of the first draft have been included and to provide a thorough check on grammar and spelling of the content. This review should be passed back to the reviewers of the First review to check that their comments were accurately included, and then to people with good grammar skills.
  • Final Draft: to confirm the comments of the second draft and to allow final comments on any aspect of the content, presentation and layout of the document.
  • Proof Draft: this is the finished document, and is just given the final OK before mass distribution or printing. At this point, only very minor changes to fix errors should be made.

You should put all output formats of your document through the Final Draft and Proof Draft stages.

In This Section

Using Release States in the Review Cycle

Reviewing a Document in Author-it

Reviewing a Document Using Word

See Also

The Documentation Process With Author-it

Where to Begin

Setting up Your Standards and Conventions

Creating an Outline of the Contents

Writing the First Draft

Indexing

Finishing and Publishing For Print

Linking the Program to its Help System

Top of Page Email this Page Log Support Call Send Feedback Print