Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Documentation Types


Published on

This presentation discusses various types of documents that are prepared during the life-cycle of a software project

Documentation Types

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