Documentation Without Frustration (DWF)
DWF is a collection of documentations, presentations and examples to introduce an easy way of writing and maintaining documentation inside small to mid-size software projects.
Key audience for this kind of information are software engineers, who need to create, present and maintain documentations from the first requirement to final deployment report.
Our complete DWF presentation can be found on: https://dwf.readthedocs.io
The presented approach is very code centric and handles the documentation topic only.
There are a lot of specialised tools, e.g. for architecture design, which are more suitable for the design process itself. But they may fail if it comes to the point of integration with other documents or supporting version control systems.
Introduced tools and libraries
Documentation generation with sphinx
Requirements, Test case, ... management with sphinx-needs
Architecture integration with sphinx-plantuml
Program output documentation with sphinx-programoutput
Presentation layout with sphinx-revealjs
Code Documentation with sphinx-autodoc
Code editor IntelliJ / pyCharm
DB Schema documentation with sphinx-sadisplay
Documentation hosting with readthedocs.org