Documentation without Frustration
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
presentations
.gitignore
AUTHORS
LICENSE
README.rst
cloud.png
doc-requirements.txt

README.rst

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.

Presentation

Our complete DWF presentation can be found on: https://dwf.readthedocs.io

Limitations

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

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

IDE

Code editor IntelliJ / pyCharm

PlantUML integration

Diagram Painting

Plantuml

Database

DB Schema documentation with sphinx-sadisplay

Cloud services

Documentation hosting with readthedocs.org