X-Nico

3 unusual facts about Software documentation


Software documentation

Often, tools such as Doxygen, NDoc, javadoc, EiffelStudio, Sandcastle, ROBODoc, POD, TwinText, or Universal Report can be used to auto-generate the code documents—that is, they extract the comments and software contracts, where available, from the source code and create reference manuals in such forms as text or HTML files.

Synchronization model

Because these files can be documentation or source code, but can also be a collection of files, the term Configuration item (CI) will be used from now on.

System appreciation

Key deliverables from this phase include documentation that describes what the system does in terms of its functional features, and how it achieves those features in terms of its architecture and design.



see also