Home  Back Topics CD Orders  INDEX 
Documentation
All software packages include documentation. 

The User Manual is written for the user and may include...

  • instructions for installation
  • instructions for use
  • trouble-shooting guide (what to do if it goes wrong!)
 The User Manual is written to make sure the user can use the software and should be written in simple language.
The Technical Manual is written for other programmers or computer experts and may include....
  • data flow diagrams (or flowcharts) showing how the program works.
  • program listings

 

 The Technical manual is written for other programmers who may need to alter some of the software and may include technical computer terms.
Documentation should explain software (or a system) as simply as possible. This will be helped if long wordy explanations are replaced by...
  • graphs
  • tables
  • flowcharts
  • diagrams
  • photos
Exercise : Documentation
Some of the interactive tasks are only available on the CD version.
(Green indicates success)