Documentation Types -Gautam Soman bytespace.blogspot.com
Introduction <ul><li>Project Documentation </li></ul><ul><li>Team Documentation </li></ul><ul><li>Test Documentation </li>...
Project Documentation <ul><li>Describes the process of creating product </li></ul><ul><li>Submitted to product owner and a...
Project Documentation <ul><li>Project Proposal Document </li></ul><ul><li>Software Requirement Specifications </li></ul><u...
Team Documentation <ul><li>Refers to communication between team </li></ul><ul><li>Short relevancy and life-span </li></ul>...
Team Documentation <ul><li>Plans and Schedules </li></ul><ul><li>Review Reports </li></ul><ul><li>Status Reports </li></ul...
Test Documentation <ul><li>Refers to documents used in testing and quality assurance processes </li></ul><ul><li>Usually c...
Test Documentation <ul><li>Test Plan </li></ul><ul><li>Test Cases </li></ul><ul><li>Issue Logs/ Bug Reports </li></ul><ul>...
System Documentation <ul><li>Highly technical in nature </li></ul><ul><li>Usually created by programmers </li></ul><ul><li...
System Documentation <ul><li>Source Code Documentation </li></ul><ul><li>Database Documentation </li></ul><ul><li>API Docu...
User Documentation <ul><li>Most ‘visible’ part of documentation </li></ul><ul><li>Should be easy-to-understand, yet precis...
User Documentation <ul><li>Read Me </li></ul><ul><li>Installation Guide </li></ul><ul><li>Configuration Guide </li></ul><u...
Thank You! <ul><li>Find more presentations related to documentation on  my SlideShare page . </li></ul><ul><li>Read my blo...
Upcoming SlideShare
Loading in...5
×

Documentation Types

18,199

Published on

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

3 Comments
9 Likes
Statistics
Notes
No Downloads
Views
Total Views
18,199
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
330
Comments
3
Likes
9
Embeds 0
No embeds

No notes for slide

Documentation Types

  1. 1. Documentation Types -Gautam Soman bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>bytespace.blogspot.com
  10. 10. System Documentation <ul><li>Source Code Documentation </li></ul><ul><li>Database Documentation </li></ul><ul><li>API Documentation </li></ul>bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>bytespace.blogspot.com
  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>http://www.gautamsoman.com </li></ul>bytespace.blogspot.com
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×