https://github.com/useblocks/dwf

Documentation without Frustration
https://github.com/useblocks/dwf

Last synced: 3 months ago
JSON representation

Documentation without Frustration

• Host: GitHub
• URL: https://github.com/useblocks/dwf
• Owner: useblocks
• License: other
• Created: 2017-09-20T12:14:03.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-23T07:23:59.000Z (almost 2 years ago)
• Last Synced: 2026-01-02T11:15:09.490Z (6 months ago)
• Language: HTML
• Homepage: https://useblocks.com/dwf
• Size: 13.7 MB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
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://useblocks.com/dwf

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 `_