SlideShare ist ein Scribd-Unternehmen logo
1 von 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

Weitere ähnliche Inhalte

Was ist angesagt?

Guidelines for quality management system documentation
Guidelines for quality management system documentationGuidelines for quality management system documentation
Guidelines for quality management system documentation
selinasimpson331
 

Was ist angesagt? (20)

ISO9001 2015 Quality Manual template
ISO9001 2015 Quality Manual templateISO9001 2015 Quality Manual template
ISO9001 2015 Quality Manual template
 
Technical report writing
Technical report writingTechnical report writing
Technical report writing
 
A Research / Report Writing
A Research / Report WritingA Research / Report Writing
A Research / Report Writing
 
Basics of Good Documentation & Document Control System
Basics of Good Documentation & Document Control SystemBasics of Good Documentation & Document Control System
Basics of Good Documentation & Document Control System
 
Presentation for good documentary practices revised shravan
Presentation for good documentary practices revised shravanPresentation for good documentary practices revised shravan
Presentation for good documentary practices revised shravan
 
Gap analysis for IATF 16949 2016
Gap analysis for IATF 16949 2016Gap analysis for IATF 16949 2016
Gap analysis for IATF 16949 2016
 
Glimpses of ISO 9001:2015
Glimpses of ISO 9001:2015Glimpses of ISO 9001:2015
Glimpses of ISO 9001:2015
 
5 whys
5 whys5 whys
5 whys
 
Technical and scientific Writing
Technical and scientific  WritingTechnical and scientific  Writing
Technical and scientific Writing
 
Data Integrity & Culture of Quality Integration
Data Integrity & Culture of Quality IntegrationData Integrity & Culture of Quality Integration
Data Integrity & Culture of Quality Integration
 
Iso 9001 2015 process audit checklist
Iso 9001 2015 process audit checklistIso 9001 2015 process audit checklist
Iso 9001 2015 process audit checklist
 
Report writing
Report writingReport writing
Report writing
 
Guidelines for quality management system documentation
Guidelines for quality management system documentationGuidelines for quality management system documentation
Guidelines for quality management system documentation
 
Quality Management Presentation
Quality Management PresentationQuality Management Presentation
Quality Management Presentation
 
Overview of ISO 19011:2018 Guidelines for Auditing Management Systems
Overview of ISO 19011:2018 Guidelines for Auditing Management SystemsOverview of ISO 19011:2018 Guidelines for Auditing Management Systems
Overview of ISO 19011:2018 Guidelines for Auditing Management Systems
 
Pharmaceutical Data integrity training
Pharmaceutical Data integrity trainingPharmaceutical Data integrity training
Pharmaceutical Data integrity training
 
11. technical reports
11. technical reports11. technical reports
11. technical reports
 
Document Control
Document ControlDocument Control
Document Control
 
7QC Tools
7QC Tools7QC Tools
7QC Tools
 
Data integrity challenges and solutions
Data integrity challenges and solutionsData integrity challenges and solutions
Data integrity challenges and solutions
 

Andere mochten auch

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
 

Andere mochten auch (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
 

Ähnlich wie 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
 

Ähnlich wie 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
 

Kürzlich hochgeladen

Architecting Cloud Native Applications
Architecting Cloud Native ApplicationsArchitecting Cloud Native Applications
Architecting Cloud Native Applications
WSO2
 

Kürzlich hochgeladen (20)

Architecting Cloud Native Applications
Architecting Cloud Native ApplicationsArchitecting Cloud Native Applications
Architecting Cloud Native Applications
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...
 
Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...
Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...
Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...
 
MS Copilot expands with MS Graph connectors
MS Copilot expands with MS Graph connectorsMS Copilot expands with MS Graph connectors
MS Copilot expands with MS Graph connectors
 
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemkeProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
 
Apidays Singapore 2024 - Scalable LLM APIs for AI and Generative AI Applicati...
Apidays Singapore 2024 - Scalable LLM APIs for AI and Generative AI Applicati...Apidays Singapore 2024 - Scalable LLM APIs for AI and Generative AI Applicati...
Apidays Singapore 2024 - Scalable LLM APIs for AI and Generative AI Applicati...
 
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...
 
TrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
TrustArc Webinar - Stay Ahead of US State Data Privacy Law DevelopmentsTrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
TrustArc Webinar - Stay Ahead of US State Data Privacy Law Developments
 
Corporate and higher education May webinar.pptx
Corporate and higher education May webinar.pptxCorporate and higher education May webinar.pptx
Corporate and higher education May webinar.pptx
 
MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024
 
"I see eyes in my soup": How Delivery Hero implemented the safety system for ...
"I see eyes in my soup": How Delivery Hero implemented the safety system for ..."I see eyes in my soup": How Delivery Hero implemented the safety system for ...
"I see eyes in my soup": How Delivery Hero implemented the safety system for ...
 
Connector Corner: Accelerate revenue generation using UiPath API-centric busi...
Connector Corner: Accelerate revenue generation using UiPath API-centric busi...Connector Corner: Accelerate revenue generation using UiPath API-centric busi...
Connector Corner: Accelerate revenue generation using UiPath API-centric busi...
 
Apidays New York 2024 - Accelerating FinTech Innovation by Vasa Krishnan, Fin...
Apidays New York 2024 - Accelerating FinTech Innovation by Vasa Krishnan, Fin...Apidays New York 2024 - Accelerating FinTech Innovation by Vasa Krishnan, Fin...
Apidays New York 2024 - Accelerating FinTech Innovation by Vasa Krishnan, Fin...
 
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
 
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...
 
Ransomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdfRansomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].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
 
Polkadot JAM Slides - Token2049 - By Dr. Gavin Wood
Polkadot JAM Slides - Token2049 - By Dr. Gavin WoodPolkadot JAM Slides - Token2049 - By Dr. Gavin Wood
Polkadot JAM Slides - Token2049 - By Dr. Gavin Wood
 
presentation ICT roal in 21st century education
presentation ICT roal in 21st century educationpresentation ICT roal in 21st century education
presentation ICT roal in 21st century education
 
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...
 

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