Document Review ProcessPresented By: SujoyDutta
IntroductionDocument 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).Document Review Process
ChallengesDocument quality is often ignored or forgotten in the current drive of Project deliveryManager or SME doesn’t have time to check the document for which they are responsible Author doesn’t get peer reviewer at the time of submissionDocument Review Process
ChallengesNo accountability of the documentReview comments are not acceptable by the authorManagers are not comfortable with edits with track changesNo proper document checklist availableDocument Review Process
Review WorkflowCustomerManagerReviewer (Ext.)AuthorReviewer (Int.)Create/Upload ContentProofread & EditSelf  ReviewCorrectionFunctional ReviewCorrectionChange RequestCorrectionFreeze & Publish Doc.Document Review Process
Review ProcessExamination the requirements and scope of the documentEstimated the completion time requiredPrint the document; take a pen or marker to identify the changesPay attention to new and updated itemsComplete the edit or change processIntegrate changes from other reviewersSubmit the reviewed document to the main authorDiscuss on review comments or edits if any confusion arisesDocument Review Process
Review ChecklistScopeGet the detail scope of reviewKnow the origin of the client for whom. U.S/U.KDocument PropertiesCheck the release dateCheck the document propertiesUpdate the document versionCheck the trademark and copyright notices.Document Review Process
Review ChecklistScreenshotCompare screen images to on-screen versionsVerify that caption relates to the screenshotCheck the clarity of images Section HeadCheck the hierarchy of the sections headingsChapter should start from a new pageDocument Review Process
Review ChecklistStyle and FormatBody text, bullets, and number lists should be consistentAvoid blank spaces within the documentUpdate FieldAfter finalizing the document update the whole document, i.e., TOC, List of Figures, cross-sections, CaptionsCheck the links: URL and cross-sections. Verify email addressDocument Review Process
Review ChecklistGrammarRun the Spell Check Check the logical flow of the content. Check for clarity and readabilityKeep the verb tense consistent. Remove passive sentences. For example, can/could. Shall/will/would, is to be, has beenRemove abbreviations like: e.g., i.e., viz. Check with commonly misused words like: Its/It’s, don’t, can’tDocument Review Process
Review ChecklistGrammarCheck for gender specificationsFor example, He or SheCheck for number format. For example, one to  nine should be in words, rest should be in numeric valueDocument Review Process
AdvantageThe accuracy documentation benefits your company and customers by offering a credible resource for how to use your productUnknown functionalities are surfacedPromote a corporate imageDocument Review Process
Document Review Process

Document Review Process

  • 1.
  • 2.
    IntroductionDocument review isa 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).Document Review Process
  • 3.
    ChallengesDocument quality isoften ignored or forgotten in the current drive of Project deliveryManager or SME doesn’t have time to check the document for which they are responsible Author doesn’t get peer reviewer at the time of submissionDocument Review Process
  • 4.
    ChallengesNo accountability ofthe documentReview comments are not acceptable by the authorManagers are not comfortable with edits with track changesNo proper document checklist availableDocument Review Process
  • 5.
    Review WorkflowCustomerManagerReviewer (Ext.)AuthorReviewer(Int.)Create/Upload ContentProofread & EditSelf ReviewCorrectionFunctional ReviewCorrectionChange RequestCorrectionFreeze & Publish Doc.Document Review Process
  • 6.
    Review ProcessExamination therequirements and scope of the documentEstimated the completion time requiredPrint the document; take a pen or marker to identify the changesPay attention to new and updated itemsComplete the edit or change processIntegrate changes from other reviewersSubmit the reviewed document to the main authorDiscuss on review comments or edits if any confusion arisesDocument Review Process
  • 7.
    Review ChecklistScopeGet thedetail scope of reviewKnow the origin of the client for whom. U.S/U.KDocument PropertiesCheck the release dateCheck the document propertiesUpdate the document versionCheck the trademark and copyright notices.Document Review Process
  • 8.
    Review ChecklistScreenshotCompare screenimages to on-screen versionsVerify that caption relates to the screenshotCheck the clarity of images Section HeadCheck the hierarchy of the sections headingsChapter should start from a new pageDocument Review Process
  • 9.
    Review ChecklistStyle andFormatBody text, bullets, and number lists should be consistentAvoid blank spaces within the documentUpdate FieldAfter finalizing the document update the whole document, i.e., TOC, List of Figures, cross-sections, CaptionsCheck the links: URL and cross-sections. Verify email addressDocument Review Process
  • 10.
    Review ChecklistGrammarRun theSpell Check Check the logical flow of the content. Check for clarity and readabilityKeep the verb tense consistent. Remove passive sentences. For example, can/could. Shall/will/would, is to be, has beenRemove abbreviations like: e.g., i.e., viz. Check with commonly misused words like: Its/It’s, don’t, can’tDocument Review Process
  • 11.
    Review ChecklistGrammarCheck forgender specificationsFor example, He or SheCheck for number format. For example, one to nine should be in words, rest should be in numeric valueDocument Review Process
  • 12.
    AdvantageThe accuracy documentationbenefits your company and customers by offering a credible resource for how to use your productUnknown functionalities are surfacedPromote a corporate imageDocument Review Process
  • 13.