Preparation of System Documentation and Need for Documentation

Preparation of System Documentation

There are Six major types of Documentation.(By Fitzgerald)

1. System Documentation:

- Overall System Design.

- System Flowchart.

- Input / Output Formats.

- File Description.

- Report Specification.

2. Programming Documentation:(Use by Technical Personnel)

- Programming Specification.

- Description of Program Logic.

3. Operation Documentation: (Developed for Users)

- Operating Instruction for normal operations.

- Directions for handling Problems and Breakdowns.

4. Training Documentation: (Developed for Trainees/Users)

- Training Manuals and Materials.

5. Implementation Documentation: (Developed for Customer/Management)

- Implementation Plans and Result of implementation.

6. Appendix:

- contains all other documentation.

For Example :

- Feasibility Study Report.

- Problem Definition Report.

- Study Plan.

- Normalization Documentations.

Need for Documentation:

• Without proper documentation, effective communication of WHO,WHAT,WHY,
• WHEN,WHERE and HOW of the system is difficult.
• Audit ability and Control are difficult to achieve without documentation.
• Difficult to make changes without documentation.
• Difficult to convert one system to another system.