Saturday, 16 May 2015

Improve Quality of a Technical document


It is very necessary to review the document for maintaining quality of a document. More review the document, better the quality of the document. A quality of a document reflects the standard of organization. 

Document Review:- 
The review is a process in which  document is read thoroughly and find out mistakes, if any. In simple words, the review process improves the document quality.

Objectives of Reviewing:-

  • Review the document for accuracy, completeness.
  • Identify errors in writing

Types of Review:- 
1.     Self Review:- A self review is a process in which you review your own work. In this review, the writer goes through the document to ensure that the document is free from basic errors, such as grammar, spelling errors.

2.     Peer Review:- It is done by a peer technical writer. 

3.     Technical Review:- It is the review done by SME (Subject matter expert) to review the technical aspect of the document. A technical review ensures accuracy and completeness of the document. The SMEs validate the technical correctness of the content written in the document.

4.     Editorial Review:- It is done by editors to review the language and structure of the documents.

5.     Usability Review:- It is done by usability experts to review how usable is the information to users. In this review, the document is checked for its accuracy, usability and user friendliness.

Advantages of Reviews:-
The various advantages of a review are:
  •     It helps to reduce the errors and improve the documentation standard.
  •     It helps to create accurate documents for delivery.
  •     It helps in providing a technically correct document and thus satisfying the user requirement.

1 comment: