Sunday, December 1, 2013

Documentation

Documentation is divided into two forms:



  1. Technical documentation
  2. User documentation


Technical documentation is produced specifically for the system analyst and the programmers. whether User documentation is provided to help the user with the new system.

Developing elements of technical documentation

Technical documentation consists of:

1. System documentation
It provides a detailed overview of the whole system

2. Program documentation
It is produced for those pieces of program code that have been written

Designing and developing elements of user documentation

User documentation is produced for several reasons, for example the user may not be familiar with the system so it will help him with various parts of the system until he becomes familiar. It is like tutorials.
It will include:
  • Screenshots and descriptions on how he will use the software
  • The purpose of the system
  • The input and output format
  • What to do when errors occurs
  • A troubleshooting guide



Open this link please:

No comments:

Post a Comment