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

More Related Content

What's hot

Document Control
Document ControlDocument Control
Document Control
Dan Junkins
 
Guidelines for quality management system documentation
Guidelines for quality management system documentationGuidelines for quality management system documentation
Guidelines for quality management system documentation
selinasimpson331
 

What's hot (20)

4. capa industry basics - final
4. capa   industry basics - final4. capa   industry basics - final
4. capa industry basics - final
 
Documentation and document control
Documentation and document controlDocumentation and document control
Documentation and document control
 
Document Control
Document ControlDocument Control
Document Control
 
Deviation control system
Deviation control systemDeviation control system
Deviation control system
 
Introduction to Quality (Training for Beginners)
Introduction to Quality (Training for Beginners)Introduction to Quality (Training for Beginners)
Introduction to Quality (Training for Beginners)
 
Root cause analysis
Root cause analysisRoot cause analysis
Root cause analysis
 
CAPA
CAPACAPA
CAPA
 
Auditing and inspection
Auditing and inspectionAuditing and inspection
Auditing and inspection
 
Corrective Action & Preventive Action
Corrective Action & Preventive ActionCorrective Action & Preventive Action
Corrective Action & Preventive Action
 
Quality Systems Approach Overview
Quality Systems Approach OverviewQuality Systems Approach Overview
Quality Systems Approach Overview
 
GMP Training: Handling of deviation
GMP Training: Handling of deviationGMP Training: Handling of deviation
GMP Training: Handling of deviation
 
Cleaning validation
Cleaning validationCleaning validation
Cleaning validation
 
Document control
Document controlDocument control
Document control
 
Root cause analysis - tools and process
Root cause analysis - tools and processRoot cause analysis - tools and process
Root cause analysis - tools and process
 
CAPA Training Presentation
CAPA Training PresentationCAPA Training Presentation
CAPA Training Presentation
 
Overview of computer system validation
Overview of computer system validationOverview of computer system validation
Overview of computer system validation
 
Presentation on QRM_NS
Presentation on QRM_NSPresentation on QRM_NS
Presentation on QRM_NS
 
Guidelines for quality management system documentation
Guidelines for quality management system documentationGuidelines for quality management system documentation
Guidelines for quality management system documentation
 
Deviation, OOS & complaint investigation and CAPA
Deviation, OOS & complaint investigation and CAPADeviation, OOS & complaint investigation and CAPA
Deviation, OOS & complaint investigation and CAPA
 
Capa presentation
Capa presentationCapa presentation
Capa presentation
 

Viewers also liked

Effective Document Review
Effective Document ReviewEffective Document Review
Effective Document Review
lturner
 
Documentation the basics
Documentation   the basicsDocumentation   the basics
Documentation the basics
aifl
 
Week12 Obtain Client Sign Off On Technical Documentation
Week12 Obtain Client Sign Off On Technical DocumentationWeek12 Obtain Client Sign Off On Technical Documentation
Week12 Obtain Client Sign Off On Technical Documentation
hapy
 

Viewers also liked (15)

Good documentation practice
Good documentation practiceGood documentation practice
Good documentation practice
 
Effective Document Review
Effective Document ReviewEffective Document Review
Effective Document Review
 
Cmmi with Agile - Demystified
Cmmi with Agile - DemystifiedCmmi with Agile - Demystified
Cmmi with Agile - Demystified
 
Document Development Life Cycle
Document Development Life CycleDocument Development Life Cycle
Document Development Life Cycle
 
Documentation the basics
Documentation   the basicsDocumentation   the basics
Documentation the basics
 
Week12 Obtain Client Sign Off On Technical Documentation
Week12 Obtain Client Sign Off On Technical DocumentationWeek12 Obtain Client Sign Off On Technical Documentation
Week12 Obtain Client Sign Off On Technical Documentation
 
CMMi level 3 presentation
CMMi level 3 presentationCMMi level 3 presentation
CMMi level 3 presentation
 
Documentation
DocumentationDocumentation
Documentation
 
A Simple Introduction To CMMI For Beginer
A Simple Introduction To CMMI For BeginerA Simple Introduction To CMMI For Beginer
A Simple Introduction To CMMI For Beginer
 
CMMI Agile Mapping
CMMI Agile MappingCMMI Agile Mapping
CMMI Agile Mapping
 
Principles of Documentation
Principles of  DocumentationPrinciples of  Documentation
Principles of Documentation
 
CMMI Capability Maturity Model Integration
CMMI   Capability Maturity Model Integration CMMI   Capability Maturity Model Integration
CMMI Capability Maturity Model Integration
 
Root Cause Analysis Presentation
Root Cause Analysis PresentationRoot Cause Analysis Presentation
Root Cause Analysis Presentation
 
QUALITY ASSURANCE
QUALITY ASSURANCEQUALITY ASSURANCE
QUALITY ASSURANCE
 
Interview
InterviewInterview
Interview
 

Similar to Document Review Process

Architecture DocumentChecklistThis checklist provides criteria.docx
Architecture DocumentChecklistThis checklist provides criteria.docxArchitecture DocumentChecklistThis checklist provides criteria.docx
Architecture DocumentChecklistThis checklist provides criteria.docx
festockton
 
Revision, Editing & Proof reading by Sohail Ahmed
Revision, Editing & Proof reading by Sohail AhmedRevision, Editing & Proof reading by Sohail Ahmed
Revision, Editing & Proof reading by Sohail Ahmed
Sohail Ahmed Solangi
 
912 AM (CDT)Privacy Statement Terms and Conditions Contac.docx
912 AM (CDT)Privacy Statement Terms and Conditions Contac.docx912 AM (CDT)Privacy Statement Terms and Conditions Contac.docx
912 AM (CDT)Privacy Statement Terms and Conditions Contac.docx
ransayo
 
Writing engineering report
Writing engineering reportWriting engineering report
Writing engineering report
Khaled Eid
 
NUR 350 Journal Guidelines and Rubric Journal ac.docx
NUR 350 Journal Guidelines and Rubric   Journal ac.docxNUR 350 Journal Guidelines and Rubric   Journal ac.docx
NUR 350 Journal Guidelines and Rubric Journal ac.docx
vannagoforth
 
Foundation Course: Information Technology UNIT 3
Foundation Course: Information Technology UNIT 3Foundation Course: Information Technology UNIT 3
Foundation Course: Information Technology UNIT 3
University of Delhi
 
HRMT20024, T3 2017 – Assessment 2 HR Planning and Recruitment Guid.docx
HRMT20024, T3 2017 – Assessment 2 HR Planning and Recruitment Guid.docxHRMT20024, T3 2017 – Assessment 2 HR Planning and Recruitment Guid.docx
HRMT20024, T3 2017 – Assessment 2 HR Planning and Recruitment Guid.docx
wellesleyterresa
 

Similar to Document Review Process (20)

Business and technical
Business and technicalBusiness and technical
Business and technical
 
Phases of a formal review
Phases of a formal reviewPhases of a formal review
Phases of a formal review
 
Presentation1.update.pptx
Presentation1.update.pptxPresentation1.update.pptx
Presentation1.update.pptx
 
Documentation Process Technical Communication
Documentation Process Technical Communication Documentation Process Technical Communication
Documentation Process Technical Communication
 
Static techniques software development - Testing & Implementation
Static techniques software development - Testing & ImplementationStatic techniques software development - Testing & Implementation
Static techniques software development - Testing & Implementation
 
Elements of technical document
Elements of technical documentElements of technical document
Elements of technical document
 
Architecture DocumentChecklistThis checklist provides criteria.docx
Architecture DocumentChecklistThis checklist provides criteria.docxArchitecture DocumentChecklistThis checklist provides criteria.docx
Architecture DocumentChecklistThis checklist provides criteria.docx
 
Static Technique
Static TechniqueStatic Technique
Static Technique
 
Copy editing Vs substantive Editing.pptx
Copy editing Vs substantive Editing.pptxCopy editing Vs substantive Editing.pptx
Copy editing Vs substantive Editing.pptx
 
Good Documentation Practice (GDP)
Good Documentation Practice (GDP)Good Documentation Practice (GDP)
Good Documentation Practice (GDP)
 
Revision, Editing & Proof reading by Sohail Ahmed
Revision, Editing & Proof reading by Sohail AhmedRevision, Editing & Proof reading by Sohail Ahmed
Revision, Editing & Proof reading by Sohail Ahmed
 
Localization -WritePoint & Net Translators
Localization -WritePoint & Net TranslatorsLocalization -WritePoint & Net Translators
Localization -WritePoint & Net Translators
 
Presentation1
Presentation1Presentation1
Presentation1
 
912 AM (CDT)Privacy Statement Terms and Conditions Contac.docx
912 AM (CDT)Privacy Statement Terms and Conditions Contac.docx912 AM (CDT)Privacy Statement Terms and Conditions Contac.docx
912 AM (CDT)Privacy Statement Terms and Conditions Contac.docx
 
Editing And Proofreading Your Research Paper - Pubrica.pptx
Editing And Proofreading Your Research Paper - Pubrica.pptxEditing And Proofreading Your Research Paper - Pubrica.pptx
Editing And Proofreading Your Research Paper - Pubrica.pptx
 
Testing Documentation.pptx
Testing Documentation.pptxTesting Documentation.pptx
Testing Documentation.pptx
 
Writing engineering report
Writing engineering reportWriting engineering report
Writing engineering report
 
NUR 350 Journal Guidelines and Rubric Journal ac.docx
NUR 350 Journal Guidelines and Rubric   Journal ac.docxNUR 350 Journal Guidelines and Rubric   Journal ac.docx
NUR 350 Journal Guidelines and Rubric Journal ac.docx
 
Foundation Course: Information Technology UNIT 3
Foundation Course: Information Technology UNIT 3Foundation Course: Information Technology UNIT 3
Foundation Course: Information Technology UNIT 3
 
HRMT20024, T3 2017 – Assessment 2 HR Planning and Recruitment Guid.docx
HRMT20024, T3 2017 – Assessment 2 HR Planning and Recruitment Guid.docxHRMT20024, T3 2017 – Assessment 2 HR Planning and Recruitment Guid.docx
HRMT20024, T3 2017 – Assessment 2 HR Planning and Recruitment Guid.docx
 

Recently uploaded

EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptxEIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
Earley Information Science
 

Recently uploaded (20)

EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptxEIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
 
🐬 The future of MySQL is Postgres 🐘
🐬  The future of MySQL is Postgres   🐘🐬  The future of MySQL is Postgres   🐘
🐬 The future of MySQL is Postgres 🐘
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivity
 
Strategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a FresherStrategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a Fresher
 
Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024
 
Partners Life - Insurer Innovation Award 2024
Partners Life - Insurer Innovation Award 2024Partners Life - Insurer Innovation Award 2024
Partners Life - Insurer Innovation Award 2024
 
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...
 
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
 
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemkeProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
 
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
 
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
 
Tech Trends Report 2024 Future Today Institute.pdf
Tech Trends Report 2024 Future Today Institute.pdfTech Trends Report 2024 Future Today Institute.pdf
Tech Trends Report 2024 Future Today Institute.pdf
 
Automating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps ScriptAutomating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps Script
 
Data Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt RobisonData Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt Robison
 
Boost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfBoost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdf
 
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking Men08448380779 Call Girls In Greater Kailash - I Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
 
Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024
 
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
 

Document Review Process

  • 1. Document Review Process Presented By: SujoyDutta
  • 2. Introduction 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). Document Review Process
  • 3. Challenges Document quality is often ignored or forgotten in the current drive of Project delivery Manager 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 submission Document Review Process
  • 4. Challenges No accountability of the document Review comments are not acceptable by the author Managers are not comfortable with edits with track changes No proper document checklist available Document Review Process
  • 5. Review Workflow Customer Manager Reviewer (Ext.) Author Reviewer (Int.) Create/Upload Content Proofread & Edit Self Review Correction Functional Review Correction Change Request Correction Freeze & Publish Doc. Document Review Process
  • 6. Review Process Examination the requirements and scope of the document Estimated the completion time required Print the document; take a pen or marker to identify the changesPay attention to new and updated itemsComplete the edit or change process Integrate changes from other reviewersSubmit the reviewed document to the main author Discuss on review comments or edits if any confusion arises Document Review Process
  • 7. Review Checklist Scope Get the detail scope of review Know the origin of the client for whom. U.S/U.K Document Properties Check the release date Check the document properties Update the document version Check the trademark and copyright notices. Document Review Process
  • 8. Review Checklist Screenshot Compare screen images to on-screen versions Verify that caption relates to the screenshot Check the clarity of images Section Head Check the hierarchy of the sections headings Chapter should start from a new page Document Review Process
  • 9.
  • 10. Review Checklist Grammar Run the Spell Check Check the logical flow of the content. Check for clarity and readability Keep the verb tense consistent. Remove passive sentences. For example, can/could. Shall/will/would, is to be, has been Remove abbreviations like: e.g., i.e., viz. Check with commonly misused words like: Its/It’s, don’t, can’t Document Review Process
  • 11.
  • 12. Advantage The accuracy documentation benefits your company and customers by offering a credible resource for how to use your product Unknown functionalities are surfaced Promote a corporate image Document Review Process