What constitutes good documentation is important for software development teams to discuss and decide right at the start of a project. Important topics include current documentation practices, their tradeoffs and pitfalls, as well as automated documentation tools.
Good documentation plays an important role during the software development lifecycle, from planning through the development and maintenance phases. Having reliable documentation helps to convey where to and how to use the software, its range of validity, and its technical details. Good documentation records knowledge during different stages of the development cycle and eases the transfer of knowledge when team dynamics and personnel change over time.
The article Understanding Good Documentation provides guidelines for what constitutes good documentation for CSE software.
