Learning Objectives Today we will Learn: The different methods of implementation The differences between user and technical documentation
Learning Objectives Today we will Learn: The different types of Documentation Different methods of evaluation
User Documentation Provides help to users to operate the system. It includes: Screenshots of how to use the system The purpose of the system Input and output formats Hardware/software requirements Troubleshooting guide FAQs
Technical Documentation Produced specifically for programmers and systems analysts. It helps when the system needs upgrading and find how to fix errors. There are two types: Systems documentation Program Documentation
Systems Documentation Provides a detailed overview of the entire system. Includes: Test plans and test results - these can be used to test errors that occur again Documents from the analysis stage such as DFDs What is expected of the system Overall design decisions - choice of hardware/software etc
Program documentation Provides details of the program code: A description and purpose of the software explaining the features and what it does The input/output formats Program flowcharts produced at the design stage Copy of the code Notes that will help future developers