Documentation Types -Gautam Soman bytespace.blogspot.com
Introduction Project Documentation Team Documentation Test Documentation System Documentation User Documentation bytespace.blogspot.com
Project Documentation Describes the process of creating product Submitted to product owner and approval obtained Long life-span, relevant throughout the project life cycle Common formats:  .doc  and  .pdf bytespace.blogspot.com
Project Documentation Project Proposal Document Software Requirement Specifications Requirements Understanding Document High Level Design Low Level Design Project Plan Release Notes bytespace.blogspot.com
Team Documentation Refers to communication between team Short relevancy and life-span Usually useful for quick changes E-mail is the most frequently used medium Common formats:  .doc, .xls bytespace.blogspot.com
Team Documentation Plans and Schedules Review Reports Status Reports Minutes of Meetings Checklists bytespace.blogspot.com
Test Documentation Refers to documents used in testing and quality assurance processes Usually created by QA/QE Usually not shared with end-user, unless specifically required Common formats:  .doc, .xls, .pdf bytespace.blogspot.com
Test Documentation Test Plan Test Cases Issue Logs/ Bug Reports Test Reports Factory Acceptance Test Document Site Acceptance Test Document bytespace.blogspot.com
System Documentation Highly technical in nature Usually created by programmers Tools like Sandcastle help in automation Useful in maintenance, bug fixes and future enhancements of the product Long life-span, often beyond that of the project Common formats:  .doc, .chm, webhelp bytespace.blogspot.com
System Documentation Source Code Documentation Database Documentation API Documentation bytespace.blogspot.com
User Documentation Most ‘visible’ part of documentation Should be easy-to-understand, yet precise Needs to be revised and kept up-to-the date to avoid being obsolete Formats vary greatly:  .doc, .pdf, .chm, webhelp Audio-visual documentation is catching up bytespace.blogspot.com
User Documentation Read Me Installation Guide Configuration Guide Quick Start Guide Training Manual User Manual/Online Help Troubleshooting Guide Administrator’s Guide bytespace.blogspot.com
Thank You! Find more presentations related to documentation on  my SlideShare page . Read my blog on technical writing at  ByteSpace Gautam Soman, http://www.gautamsoman.com bytespace.blogspot.com

Documentation Types

  • 1.
    Documentation Types -GautamSoman bytespace.blogspot.com
  • 2.
    Introduction Project DocumentationTeam Documentation Test Documentation System Documentation User Documentation bytespace.blogspot.com
  • 3.
    Project Documentation Describesthe process of creating product Submitted to product owner and approval obtained Long life-span, relevant throughout the project life cycle Common formats: .doc and .pdf bytespace.blogspot.com
  • 4.
    Project Documentation ProjectProposal Document Software Requirement Specifications Requirements Understanding Document High Level Design Low Level Design Project Plan Release Notes bytespace.blogspot.com
  • 5.
    Team Documentation Refersto communication between team Short relevancy and life-span Usually useful for quick changes E-mail is the most frequently used medium Common formats: .doc, .xls bytespace.blogspot.com
  • 6.
    Team Documentation Plansand Schedules Review Reports Status Reports Minutes of Meetings Checklists bytespace.blogspot.com
  • 7.
    Test Documentation Refersto documents used in testing and quality assurance processes Usually created by QA/QE Usually not shared with end-user, unless specifically required Common formats: .doc, .xls, .pdf bytespace.blogspot.com
  • 8.
    Test Documentation TestPlan Test Cases Issue Logs/ Bug Reports Test Reports Factory Acceptance Test Document Site Acceptance Test Document bytespace.blogspot.com
  • 9.
    System Documentation Highlytechnical in nature Usually created by programmers Tools like Sandcastle help in automation Useful in maintenance, bug fixes and future enhancements of the product Long life-span, often beyond that of the project Common formats: .doc, .chm, webhelp bytespace.blogspot.com
  • 10.
    System Documentation SourceCode Documentation Database Documentation API Documentation bytespace.blogspot.com
  • 11.
    User Documentation Most‘visible’ part of documentation Should be easy-to-understand, yet precise Needs to be revised and kept up-to-the date to avoid being obsolete Formats vary greatly: .doc, .pdf, .chm, webhelp Audio-visual documentation is catching up bytespace.blogspot.com
  • 12.
    User Documentation ReadMe Installation Guide Configuration Guide Quick Start Guide Training Manual User Manual/Online Help Troubleshooting Guide Administrator’s Guide bytespace.blogspot.com
  • 13.
    Thank You! Findmore presentations related to documentation on my SlideShare page . Read my blog on technical writing at ByteSpace Gautam Soman, http://www.gautamsoman.com bytespace.blogspot.com