The systems life cycle: Documentation and evaluation

Two types of documentations

• Technical documentation
• User documentation

Technical documentation

• Purpose and scope of the system/program
• Hardware and software requirements
• File structure and a list of variables
• Input and output formats
• Validation rules
• Programming language
• System flowcharts/algorithms and program listings
• Sample runs/test runs
• Known bugs/possible errors

User documentation

• FAQ (Frequently Asked Questions)
• How to load, install and run software
• Troubleshooting guide
• Tutorials

There are five basic symbols used in a systems flowchart

User documentation

• how to load software/install/run software
• tutorials
• error handling/FAQ
• Contact details/helpline

Overall for this topic