5- Documentation

 There are two types of documentation that should be produced when creating a new system:

• User documentation
• Technical documentation

Testing

Documentation

Implementation

User Documentation

The user documentation is intended to help the users of the system.

The users are usually non-technical people, who don't need to know how the system works. They just need to know how to use it.

User documentation usually includes:

• List of minimum hardware and software required to use the system
• How to install the system
• How to start / stop the system
• How to use the features of the system
• Screenshots showing the system in typical use
• Example inputs and outputs
• Explanations of any error messages that might be shown
• A troubleshooting guide

The technical documentation is intended to help the maintainers of the system (the people who need to keep the system running smoothly, fix problems, etc.)

The maintainers are usually technical people, who need to know exactlyhow the system works.

Technical documentation usually includes:

• Details of the hardware and software required for the system
• Details of data structures (data types, field names, etc.)
• Details of expected inputs
• Details of validation checks
• Details of how data is processed
• Diagrams showing how data moves through the system
• Flowcharts describing how the system works