Review

Sep 3, 2012 Ξ Leave a comment

Checklists in documentation

posted by nanda

Having a comprehensive checklist is like covering an entire, voluminous style guide in a nutshell. Ideally, a checklist would consist of series of items wherein each item has a checkbox that needs to be selected if the item is taken care during writing or review process.

Preparing checklists is a tedious part in documentation. Nevertheless, it works to our advantage. As we assemble points to prepare a checklist for a given review, the entire scope of the review becomes very understandable.

It is very difficult to track or keep in mind all the points while reviewing a document without use of checklist. Checklists come in handy when just about to begin the job. These would significantly lessen the chances of missing out on various necessary standards to be followed in designing and writing technical documents. Furthermore, using a checklist is a way to more easily check and validate whether a document complies with the template or a specific style guide.

The effect of using the checklist is profound. Instead of just beginning to write or review a document, we look intently at every little detail and make sure that we are in the right track.

Checklist makes our reviews organized. It keeps our mind focused. Checklist saves our time by ensuring consistency and completeness while performing a review.

Writers and reviewers should remember to revise their checklists when new updates are made. When we have a checklist for a complete process, and when we strictly adhere to the checklist, it is rest assured that everything is in place.

Share This

Leave a Reply

You must be logged in to post a comment.

Log in with:

Subscribe to our Newsletter

To subscribe to Techitive newsletter simply add your email below. A confirmation email will be sent to you!

Tweets

Resources

Understanding Source Documents – E-Book

Understanding Source Documents - E-Book

July 24th, 2013

Techitive Press presents the second E-Book for ready reference - Understanding Source Documents. [...]

E-Book – Technical Writing Process – An Overview

E-Book - Technical Writing Process - An Overview

July 15th, 2013

Techitive Press presents small E-Books for ready reference. [...]

Understanding articles

Understanding articles

September 22nd, 2012

[...]

Self Review Checklist

Self Review Checklist

September 16th, 2012

Grammar Verify the text for spelling mistakes and typographical errors. Verify the text fo[...]

Search on Techitive

Subscribe on Facebook