Documentation is produced for internal use in the creation of the system as well as the users of the system, so they know how it works and how they can utilise the system.
- Needs to happen in parallel with software development to ensure that it is completed at the same time
- Needs to be planned, designed and tested - usually two rounds of commenting before final versions are ready
Two types of documentation
1. User documentation
<aside>
🙎♂️ Documentation for the users of the system
</aside>
- Most simplistic form of documentation
- Often for users who start to use the system sometime after its initial launch
- Needs to be understandable for the "average user"
It requires:
- Step-by-step 'getting-started guide'
- Instillation guide
- User guide focusing on user tasks
- Reference manual
- Online help
- Error messages and trouble-shooting guide
- FAQs
- Glossary
2. Technical/maintenance documentation
<aside>
🚧 Created by developers to help technicians use the system
</aside>
There needs to be at least one person in the company who can ensure that the system runs smoothly once implemented which is why they need some form of documentation. They also need access to the design documents and code so that they can get a deeper understanding of the system.
It requires:
- Any form of diagrams used in analysis and design
- The data structure - which ones have been used, database table designs and any other info about what data needs to be stored
- Algorithm designs - normally presented as pseudocode or in flowchart form
- Annotated code listings - must abide by the coding standards set out by the dev company