The document discusses the document review process. It outlines challenges in the current review process such as lack of time and accountability. It then describes the workflow involving various roles from customer to author. Finally, it provides a detailed checklist for reviewers to examine scope, formatting, grammar, and more to enhance document quality.
Introduction to document review process by Sujoy Dutta.
The document review process aims to identify grammatical and functional errors to enhance document quality in the Document Development Life Cycle (DDLC).
Challenges include neglect of document quality due to time constraints faced by managers and SMEs.
Additional challenges involve lack of accountability, unaccepted review comments, discomfort with edits, and absence of a document checklist.
Review workflow involves roles of customer, manager, author, and internal/external reviewers through various review steps.
Steps in the review process include examining requirements, estimating time, marking changes, and integrating feedback.
Checklist items focus on defining the scope, client origin, checking properties, release date, and updating version.
Verification of screenshots, clarity of images, and proper section headings and structure are key checklist items.
Ensure consistency in body text, bullet points, update cross-references and links, maintaining format standards.
Grammar checks include spelling, logical flow, verb tense consistency, and clarity of language used.
Additional checks on gender specifications and numerical formats ensure comprehensive grammar quality.
Accurate documentation enhances company credibility, reveals functionalities, and promotes a positive corporate image.
Final remarks on the importance and impact of the document review process.
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
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