Documentation
Documentation
Documentation is designed to help people understand
how to use a software program.




The two most common forms of documentation are
the User Guide and the Technical Guide.
The User Guide
The user guide explains how to use the software.

The user guide can be produced in paper format, but
more commonly these days it is produced as an
electronic file or as online help.
The Technical Guide
This document explains to the user:
 How to install the software
 Memory and processor requirements
 Version number of the software
 Details of other files or programs which may need to
  be installed
Other Documentation
Other types of documentation may include:
 Quick start guide
 Shortcut guide
 Video tutorial
 FAQs

5. The Software Development Process - Documentation

  • 1.
  • 2.
    Documentation Documentation is designedto help people understand how to use a software program. The two most common forms of documentation are the User Guide and the Technical Guide.
  • 3.
    The User Guide Theuser guide explains how to use the software. The user guide can be produced in paper format, but more commonly these days it is produced as an electronic file or as online help.
  • 4.
    The Technical Guide Thisdocument explains to the user:  How to install the software  Memory and processor requirements  Version number of the software  Details of other files or programs which may need to be installed
  • 5.
    Other Documentation Other typesof documentation may include:  Quick start guide  Shortcut guide  Video tutorial  FAQs