Home  Back Topics CD Orders  INDEX 
Documentation

Documentation of a system will include :

1 Technical Manual systems specifications
- description of systems
- system flow charts (or similar)

program specifications
- program flowcharts (or pseudocode)
- program listing
- lists of variables used
(most programs are self-documenting; comments are added to the listing explaining the steps used in the program. Meaningful variable names are also used.)

2 User Manual
(Operating Instructions)		 - software installation procedures
- details for starting the program.
- details for setting security (passwords etc)
- details of discs/tapes required.
- clerical procedures
- data preparation (batching / hash totals etc)
- how to enter data (which fields; codes used; how to enter dates etc)
- details and samples of reports which may be printed.
- backup procedures to be followed.
- recovery procedures in the event of hardware failure.