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

Weitere ähnliche Inhalte

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

Ähnlich wie Introduction To Documentation (20)

[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
 
Technical writing
Technical writingTechnical writing
Technical writing
 

Mehr von OpenSpace

Mehr von 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
 

Kürzlich hochgeladen

Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Safe Software
 
Why Teams call analytics are critical to your entire business
Why Teams call analytics are critical to your entire businessWhy Teams call analytics are critical to your entire business
Why Teams call analytics are critical to your entire business
panagenda
 

Kürzlich hochgeladen (20)

MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024
 
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...
 
ICT role in 21st century education and its challenges
ICT role in 21st century education and its challengesICT role in 21st century education and its challenges
ICT role in 21st century education and its challenges
 
A Beginners Guide to Building a RAG App Using Open Source Milvus
A Beginners Guide to Building a RAG App Using Open Source MilvusA Beginners Guide to Building a RAG App Using Open Source Milvus
A Beginners Guide to Building a RAG App Using Open Source Milvus
 
Apidays Singapore 2024 - Modernizing Securities Finance by Madhu Subbu
Apidays Singapore 2024 - Modernizing Securities Finance by Madhu SubbuApidays Singapore 2024 - Modernizing Securities Finance by Madhu Subbu
Apidays Singapore 2024 - Modernizing Securities Finance by Madhu Subbu
 
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...
 
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...
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
 
Why Teams call analytics are critical to your entire business
Why Teams call analytics are critical to your entire businessWhy Teams call analytics are critical to your entire business
Why Teams call analytics are critical to your entire business
 
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...
 
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
 
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
 
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWEREMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER
 
GenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdfGenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdf
 
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 - 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...
 
Repurposing LNG terminals for Hydrogen Ammonia: Feasibility and Cost Saving
Repurposing LNG terminals for Hydrogen Ammonia: Feasibility and Cost SavingRepurposing LNG terminals for Hydrogen Ammonia: Feasibility and Cost Saving
Repurposing LNG terminals for Hydrogen Ammonia: Feasibility and Cost Saving
 
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemkeProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
 
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot Model
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot ModelNavi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot Model
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot Model
 
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
 

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.