Document Review Process

4,631 views
4,106 views

Published on

Proofread and quality check

Published in: Technology, Business
0 Comments
2 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
4,631
On SlideShare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
99
Comments
0
Likes
2
Embeds 0
No embeds

No notes for slide

Document Review Process

  1. 1. Document Review Process<br />Presented By: SujoyDutta<br />
  2. 2. Introduction<br />Document review is a process of identifying the both grammatical and functional errors. This process is important to enhance the quality of the document and very well fits in the Document Development Life Cycle (DDLC).<br />Document Review Process<br />
  3. 3. Challenges<br />Document quality is often ignored or forgotten in the current drive of Project delivery<br />Manager or SME doesn’t have time to check the document for which they are responsible <br />Author doesn’t get peer reviewer at the time of submission<br />Document Review Process<br />
  4. 4. Challenges<br />No accountability of the document<br />Review comments are not acceptable by the author<br />Managers are not comfortable with edits with track changes<br />No proper document checklist available<br />Document Review Process<br />
  5. 5. Review Workflow<br />Customer<br />Manager<br />Reviewer (Ext.)<br />Author<br />Reviewer (Int.)<br />Create/Upload Content<br />Proofread & Edit<br />Self Review<br />Correction<br />Functional Review<br />Correction<br />Change Request<br />Correction<br />Freeze & Publish Doc.<br />Document Review Process<br />
  6. 6. Review Process<br />Examination the requirements and scope of the document<br />Estimated the completion time required<br />Print the document; take a pen or marker to identify the changesPay attention to new and updated itemsComplete the edit or change process<br />Integrate changes from other reviewersSubmit the reviewed document to the main author<br />Discuss on review comments or edits if any confusion arises<br />Document Review Process<br />
  7. 7. Review Checklist<br />Scope<br />Get the detail scope of review<br />Know the origin of the client for whom. U.S/U.K<br />Document Properties<br />Check the release date<br />Check the document properties<br />Update the document version<br />Check the trademark and copyright notices.<br />Document Review Process<br />
  8. 8. Review Checklist<br />Screenshot<br />Compare screen images to on-screen versions<br />Verify that caption relates to the screenshot<br />Check the clarity of images <br />Section Head<br />Check the hierarchy of the sections headings<br />Chapter should start from a new page<br />Document Review Process<br />
  9. 9. Review Checklist<br />Style and Format<br />Body text, bullets, and number lists should be consistent<br />Avoid blank spaces within the document<br /><ul><li>Update Field</li></ul>After finalizing the document update the whole document, i.e., TOC, List of Figures, cross-sections, Captions<br />Check the links: URL and cross-sections. Verify email address<br />Document Review Process<br />
  10. 10. Review Checklist<br />Grammar<br />Run the Spell Check <br />Check the logical flow of the content. Check for clarity and readability<br />Keep the verb tense consistent. Remove passive sentences. For example, can/could. Shall/will/would, is to be, has been<br />Remove abbreviations like: e.g., i.e., viz. Check with commonly misused words like: Its/It’s, don’t, can’t<br />Document Review Process<br />
  11. 11. Review Checklist<br /><ul><li>Grammar</li></ul>Check for gender specificationsFor example, He or She<br />Check for number format. For example, one to nine should be in words, rest should be in numeric value<br />Document Review Process<br />
  12. 12. Advantage<br />The accuracy documentation benefits your company and customers by offering a credible resource for how to use your product<br />Unknown functionalities are surfaced<br />Promote a corporate image<br />Document Review Process<br />
  13. 13. Document Review Process<br />

×