Documentation : System Documentation

In addition to a user guide, new systems are usually supplied with system documentation. System documentation describes the results of the analysis and design of the system, the test plan, and shows how the system has been implemented.

Examples of items that might be included in system documentation are :

• The results of the feasibility study.
• A system flowchart for the whole system.
• Flowcharts to show how individual algorithms work.
• Plans for record structures in a database or the formulae to use in a spreadsheet.
• The test plan that was used for testing.
• Copies of test results that showed that the system worked.
• Listings of programs or macros.

System documentation is not intended to be read by the user. It is produced so that later on somebody else can understand how the system works so that they can modify it. This may need to be done to remove a bug that was not noticed during testing or to add extra features that were not originally required. System documentation is also known as technical or maintenance documentation.

GCSE ICT Companion 04 - (C) P Meakin 2004