Program (Programmer's and User's) Documentation


The program documentation is the process of collecting information about the program. The documentation process starts from the problem analysis phase to debugging and testing. Documentation consists two types of documentation, they are:

  1. Programmer's Documentation
  2. User's Documentation

Programmer's Documentation

Programmer’s documentation contains all the technical details. Without proper documentation it is very difficult even for the original programmer to update and maintain the program. A programmer’s documentation contains the necessary information that a programmer requires to update and maintain the program. These information includes:

  1. Program analysis document, with a concise statement of program’s objectives, outputs and processing procedures.
  2. Program design documents with appropriate flowcharts and diagrams.
  3. Program verification documents for outlining, checking, testing and correction procedures along with the list of sample data and results.
  4. Log used to document future program revision and maintenance activity.

User's Documentation

User documentation is required for the end user who installs and uses the program. It consists instructions for installation of the program and user manual.