SlideShare a Scribd company logo
1 of 27
Introduction to documentation 125/1, cross 15, main 5, block 2, r t nagar, bangalore, india 560032 e: training@openspace.org.in
The communication loop IDEA? [ABSTRACT] I D E A [ABSTRACT?] ARC OF DISTORTION FEED BACK
Experts? ,[object Object],[object Object],[object Object],[object Object],[object Object]
Why document ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Why document ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Why document ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Before you start ,[object Object],[object Object],[object Object],[object Object]
Before you start ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Before you start ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Before you start: How? ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
The ABCs ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
ABCDs of documentation Dignity Desired Behaviour Deadline D Chosen Charming Clear C Benefit Basic Brief B Authority Appropriate Accurate  A Best Better Basic
A brief KISS ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
‘Rules’ ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
The 3 R’s ,[object Object],[object Object],[object Object]
Be sensitive ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Credit and responsibility ,[object Object],[object Object],[object Object],[object Object]
Statistics ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Statistics If you did your own research ,[object Object],[object Object],[object Object],[object Object],[object Object]
Case study ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Case study ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Make documents attractive ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Text design ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Illustrations and photographs ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Costs involved ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Reducing costs ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
[object Object],[object Object],[object Object],[object Object]

More Related Content

What's hot

Review of Related Literature with references
Review of Related Literature with referencesReview of Related Literature with references
Review of Related Literature with references
Jimnaira Abanto
 
Informal Reports
Informal ReportsInformal Reports
Informal Reports
rosaejonasz
 
Catalogue Entry Format
Catalogue Entry FormatCatalogue Entry Format
Catalogue Entry Format
Sarika Sawant
 
Library Systems- SAA Library Policies
Library Systems- SAA Library  PoliciesLibrary Systems- SAA Library  Policies
Library Systems- SAA Library Policies
Cecilia Manago
 
Writing Chapters 1, 2, 3 of the Capstone Project Proposal Manuscript
Writing Chapters 1, 2, 3 of the Capstone Project Proposal ManuscriptWriting Chapters 1, 2, 3 of the Capstone Project Proposal Manuscript
Writing Chapters 1, 2, 3 of the Capstone Project Proposal Manuscript
Sheryl Satorre
 

What's hot (20)

Ddc
Ddc Ddc
Ddc
 
Travel brochure
Travel brochureTravel brochure
Travel brochure
 
PRACTICAL RESEARCH 1: Lesson 6: WRITING A RESEARCH TITLE.pptx
PRACTICAL RESEARCH 1: Lesson 6:  WRITING A RESEARCH TITLE.pptxPRACTICAL RESEARCH 1: Lesson 6:  WRITING A RESEARCH TITLE.pptx
PRACTICAL RESEARCH 1: Lesson 6: WRITING A RESEARCH TITLE.pptx
 
Review of Related Literature with references
Review of Related Literature with referencesReview of Related Literature with references
Review of Related Literature with references
 
Informal Reports
Informal ReportsInformal Reports
Informal Reports
 
Current and Future Trends in Media and Information
Current and Future Trends in Media and InformationCurrent and Future Trends in Media and Information
Current and Future Trends in Media and Information
 
THE IMPORTANCE OF QUALITATIVE RESEARCH ACROSS FIELDS OF.pptx
THE IMPORTANCE OF QUALITATIVE RESEARCH ACROSS FIELDS OF.pptxTHE IMPORTANCE OF QUALITATIVE RESEARCH ACROSS FIELDS OF.pptx
THE IMPORTANCE OF QUALITATIVE RESEARCH ACROSS FIELDS OF.pptx
 
Concept paper
Concept paperConcept paper
Concept paper
 
Catalogue Entry Format
Catalogue Entry FormatCatalogue Entry Format
Catalogue Entry Format
 
Technical Writing
Technical WritingTechnical Writing
Technical Writing
 
EAPP Quarter 2 – Module 4 Objectives and Structures of Various Kinds of Repor...
EAPP Quarter 2 – Module 4 Objectives and Structures of Various Kinds of Repor...EAPP Quarter 2 – Module 4 Objectives and Structures of Various Kinds of Repor...
EAPP Quarter 2 – Module 4 Objectives and Structures of Various Kinds of Repor...
 
Practical research 2 week 1.pptx
Practical research 2 week 1.pptxPractical research 2 week 1.pptx
Practical research 2 week 1.pptx
 
1 pr2 characteristics
1 pr2 characteristics1 pr2 characteristics
1 pr2 characteristics
 
Strategies on How to Infer & Explain Patterns and Themes from Data
Strategies on How to Infer & Explain Patterns and Themes from DataStrategies on How to Infer & Explain Patterns and Themes from Data
Strategies on How to Infer & Explain Patterns and Themes from Data
 
How to write a research paper
How to write a research paperHow to write a research paper
How to write a research paper
 
Media and Information Literacy (MIL) 2. The Evolution of Traditional to New M...
Media and Information Literacy (MIL) 2. The Evolution of Traditional to New M...Media and Information Literacy (MIL) 2. The Evolution of Traditional to New M...
Media and Information Literacy (MIL) 2. The Evolution of Traditional to New M...
 
Library Systems- SAA Library Policies
Library Systems- SAA Library  PoliciesLibrary Systems- SAA Library  Policies
Library Systems- SAA Library Policies
 
Project proposal
Project proposalProject proposal
Project proposal
 
Writing Chapters 1, 2, 3 of the Capstone Project Proposal Manuscript
Writing Chapters 1, 2, 3 of the Capstone Project Proposal ManuscriptWriting Chapters 1, 2, 3 of the Capstone Project Proposal Manuscript
Writing Chapters 1, 2, 3 of the Capstone Project Proposal Manuscript
 
Truth, fact and ethics in academic research
Truth, fact and ethics in academic researchTruth, fact and ethics in academic research
Truth, fact and ethics in academic research
 

Similar to Introduction To Documentation

How to Write a Great Presentation for Presentation Software
How to Write a Great Presentation for Presentation SoftwareHow to Write a Great Presentation for Presentation Software
How to Write a Great Presentation for Presentation Software
Carol Yelverton
 
Survey of English Literature ITwelfth Night Research Paper.docx
Survey of English Literature ITwelfth Night Research Paper.docxSurvey of English Literature ITwelfth Night Research Paper.docx
Survey of English Literature ITwelfth Night Research Paper.docx
ssuserf9c51d
 
COMM 111. MannSpeech Outline Format PRE-PLANNINGTopic .docx
COMM 111. MannSpeech Outline Format PRE-PLANNINGTopic  .docxCOMM 111. MannSpeech Outline Format PRE-PLANNINGTopic  .docx
COMM 111. MannSpeech Outline Format PRE-PLANNINGTopic .docx
monicafrancis71118
 
Effective Writing2
Effective Writing2Effective Writing2
Effective Writing2
guest349908
 
Writing Research Report
Writing Research ReportWriting Research Report
Writing Research Report
guest349908
 
Effective presentation toolkit
Effective presentation toolkitEffective presentation toolkit
Effective presentation toolkit
qyqing
 
Communication:process functions barriers.
Communication:process functions barriers.Communication:process functions barriers.
Communication:process functions barriers.
soniya302
 
MGMT501 Business Writing
MGMT501 Business WritingMGMT501 Business Writing
MGMT501 Business Writing
Rehab Wahsh
 

Similar to Introduction To Documentation (20)

Feature writing
Feature writingFeature writing
Feature writing
 
[Net2 Uganda] Training for NGOs on how to share compelling stories of their work
[Net2 Uganda] Training for NGOs on how to share compelling stories of their work[Net2 Uganda] Training for NGOs on how to share compelling stories of their work
[Net2 Uganda] Training for NGOs on how to share compelling stories of their work
 
How to Write a Great Presentation for Presentation Software
How to Write a Great Presentation for Presentation SoftwareHow to Write a Great Presentation for Presentation Software
How to Write a Great Presentation for Presentation Software
 
Informative Speech Objectives
Informative Speech ObjectivesInformative Speech Objectives
Informative Speech Objectives
 
Informative Speech Objectives
Informative  Speech  ObjectivesInformative  Speech  Objectives
Informative Speech Objectives
 
Lis523 report
Lis523 reportLis523 report
Lis523 report
 
Survey of English Literature ITwelfth Night Research Paper.docx
Survey of English Literature ITwelfth Night Research Paper.docxSurvey of English Literature ITwelfth Night Research Paper.docx
Survey of English Literature ITwelfth Night Research Paper.docx
 
TBW_ASG2.pptx
TBW_ASG2.pptxTBW_ASG2.pptx
TBW_ASG2.pptx
 
How to write a formal Report
How to write a formal ReportHow to write a formal Report
How to write a formal Report
 
COMM 111. MannSpeech Outline Format PRE-PLANNINGTopic .docx
COMM 111. MannSpeech Outline Format PRE-PLANNINGTopic  .docxCOMM 111. MannSpeech Outline Format PRE-PLANNINGTopic  .docx
COMM 111. MannSpeech Outline Format PRE-PLANNINGTopic .docx
 
Paper Writer Services. Online assignment writing service.
Paper Writer Services. Online assignment writing service.Paper Writer Services. Online assignment writing service.
Paper Writer Services. Online assignment writing service.
 
Effective Writing2
Effective Writing2Effective Writing2
Effective Writing2
 
Writing Research Report
Writing Research ReportWriting Research Report
Writing Research Report
 
Effective presentation toolkit
Effective presentation toolkitEffective presentation toolkit
Effective presentation toolkit
 
Campus Journalism Basics- SOCORRO DISTRICT
Campus Journalism Basics- SOCORRO DISTRICTCampus Journalism Basics- SOCORRO DISTRICT
Campus Journalism Basics- SOCORRO DISTRICT
 
Communication:process functions barriers.
Communication:process functions barriers.Communication:process functions barriers.
Communication:process functions barriers.
 
Pattern of d evelopment
Pattern of d evelopmentPattern of d evelopment
Pattern of d evelopment
 
Technical writing
Technical writingTechnical writing
Technical writing
 
technical_Writing__presentation_skills__Lecture4.pptx
technical_Writing__presentation_skills__Lecture4.pptxtechnical_Writing__presentation_skills__Lecture4.pptx
technical_Writing__presentation_skills__Lecture4.pptx
 
MGMT501 Business Writing
MGMT501 Business WritingMGMT501 Business Writing
MGMT501 Business Writing
 

More from OpenSpace

More from OpenSpace (20)

SC/ST (PoA) Act Monitoring at the state level
SC/ST (PoA) Act Monitoring at the state levelSC/ST (PoA) Act Monitoring at the state level
SC/ST (PoA) Act Monitoring at the state level
 
SC/ST (PoA) Case monitoring formats
SC/ST (PoA) Case monitoring formatsSC/ST (PoA) Case monitoring formats
SC/ST (PoA) Case monitoring formats
 
SC/ST POA Amendment 2013
SC/ST POA Amendment 2013SC/ST POA Amendment 2013
SC/ST POA Amendment 2013
 
POA 3a Relief Norms Notification 2014
POA 3a Relief Norms Notification 2014POA 3a Relief Norms Notification 2014
POA 3a Relief Norms Notification 2014
 
Swachch bharat
Swachch bharatSwachch bharat
Swachch bharat
 
POA 1b SCs and STs (Prevention of Atrocities) Amendment Ordinance 2014
POA 1b SCs and STs (Prevention of Atrocities) Amendment Ordinance 2014POA 1b SCs and STs (Prevention of Atrocities) Amendment Ordinance 2014
POA 1b SCs and STs (Prevention of Atrocities) Amendment Ordinance 2014
 
SCST (PoA) Implementation in Karnataka status report 2013
SCST (PoA) Implementation in Karnataka status report 2013SCST (PoA) Implementation in Karnataka status report 2013
SCST (PoA) Implementation in Karnataka status report 2013
 
SCST (PoA) Implementation in Karnataka status report 2013 (Kannada)
SCST (PoA) Implementation in Karnataka status report 2013 (Kannada) SCST (PoA) Implementation in Karnataka status report 2013 (Kannada)
SCST (PoA) Implementation in Karnataka status report 2013 (Kannada)
 
SCST (PoA) Implementation in Karnataka status report 2013 cover initial pages...
SCST (PoA) Implementation in Karnataka status report 2013 cover initial pages...SCST (PoA) Implementation in Karnataka status report 2013 cover initial pages...
SCST (PoA) Implementation in Karnataka status report 2013 cover initial pages...
 
SCST (PoA) Implementation in Karnataka status report 2013 cover
SCST (PoA) Implementation in Karnataka status report 2013 coverSCST (PoA) Implementation in Karnataka status report 2013 cover
SCST (PoA) Implementation in Karnataka status report 2013 cover
 
Violence against women garment workers, gender subordination in India
Violence against women garment workers, gender subordination in IndiaViolence against women garment workers, gender subordination in India
Violence against women garment workers, gender subordination in India
 
POA 9 Karnataka state police manual (DCRE)
POA 9 Karnataka state police manual (DCRE)POA 9 Karnataka state police manual (DCRE)
POA 9 Karnataka state police manual (DCRE)
 
POA 8 DVMC roles and responsibilities
POA 8 DVMC roles and responsibilitiesPOA 8 DVMC roles and responsibilities
POA 8 DVMC roles and responsibilities
 
POA 7 How to give evidence in court
POA 7 How to give evidence in courtPOA 7 How to give evidence in court
POA 7 How to give evidence in court
 
POA 6 POA and IPC sections
POA 6 POA and IPC sectionsPOA 6 POA and IPC sections
POA 6 POA and IPC sections
 
POA 5b Monitoring calendar (detailed)
POA 5b Monitoring calendar (detailed)POA 5b Monitoring calendar (detailed)
POA 5b Monitoring calendar (detailed)
 
POA 5a Monitoring calendar (Single Page)
POA 5a Monitoring calendar (Single Page)POA 5a Monitoring calendar (Single Page)
POA 5a Monitoring calendar (Single Page)
 
POA 3b Ambedkar foundation relief for heinous crimes
POA 3b Ambedkar foundation relief for heinous crimesPOA 3b Ambedkar foundation relief for heinous crimes
POA 3b Ambedkar foundation relief for heinous crimes
 
POA 3a Relief norms notification 2011
POA 3a Relief norms notification 2011POA 3a Relief norms notification 2011
POA 3a Relief norms notification 2011
 
POA 2 SCs and STs (PoA) Rules 1995
POA 2 SCs and STs (PoA) Rules 1995POA 2 SCs and STs (PoA) Rules 1995
POA 2 SCs and STs (PoA) Rules 1995
 

Recently uploaded

Artificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsArtificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and Myths
Joaquim Jorge
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slide
vu2urc
 

Recently uploaded (20)

Handwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed textsHandwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed texts
 
Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024
 
A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?
 
Real Time Object Detection Using Open CV
Real Time Object Detection Using Open CVReal Time Object Detection Using Open CV
Real Time Object Detection Using Open CV
 
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...
 
Developing An App To Navigate The Roads of Brazil
Developing An App To Navigate The Roads of BrazilDeveloping An App To Navigate The Roads of Brazil
Developing An App To Navigate The Roads of Brazil
 
Artificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsArtificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and Myths
 
HTML Injection Attacks: Impact and Mitigation Strategies
HTML Injection Attacks: Impact and Mitigation StrategiesHTML Injection Attacks: Impact and Mitigation Strategies
HTML Injection Attacks: Impact and Mitigation Strategies
 
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
 
TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
TrustArc Webinar - Unlock the Power of AI-Driven Data DiscoveryTrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
 
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, AdobeApidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
 
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
 
AWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of Terraform
 
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
 
Tata AIG General Insurance Company - Insurer Innovation Award 2024
Tata AIG General Insurance Company - Insurer Innovation Award 2024Tata AIG General Insurance Company - Insurer Innovation Award 2024
Tata AIG General Insurance Company - Insurer Innovation Award 2024
 
What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?
 
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...
 
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...
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slide
 

Introduction To Documentation

  • 1. Introduction to documentation 125/1, cross 15, main 5, block 2, r t nagar, bangalore, india 560032 e: training@openspace.org.in
  • 2. The communication loop IDEA? [ABSTRACT] I D E A [ABSTRACT?] ARC OF DISTORTION FEED BACK
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12. ABCDs of documentation Dignity Desired Behaviour Deadline D Chosen Charming Clear C Benefit Basic Brief B Authority Appropriate Accurate A Best Better Basic
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.