Computer Science › Section H · Software engineering › Topic H.7
Documentation
Software is of little use if people cannot learn to use it, and of little lasting value if nobody can safely change it. Documentation is the written knowledge that makes both possible, and good teams treat it as part of the product, not an afterthought.
In this topic
- Why documentation matters
- Three kinds of documentation
- User documentation
- System documentation and the code
- Worked example: documenting a function
- Documentation that tools can use
- Technical documentation
- Worked example: sorting documents by kind
- Keeping documentation current
- Common mistakes to avoid
- Key takeaways
This topic is part of Wuanberri Pro. Checking your access…