kb:bestpractices:documentation
This is an old revision of the document!
Documentation
For a successful project, the documentation is as important as testing the code. The intention of this section is to provide basic guidelines and tips to write good documentation, for HSE (in this DocuWiki) and for our customers.
These better practices are mainly inspired by The Hitchhiker's Guide to Documentation!. For a more comprehensive guide about documenting software projects, take a look at it.
kb/bestpractices/documentation.1691832853.txt.gz · Last modified: 2023/08/12 09:34 by manuel.sebald