{"id":35242175,"url":"https://github.com/useblocks/dwf","last_synced_at":"2026-04-07T04:31:53.864Z","repository":{"id":25514297,"uuid":"104211182","full_name":"useblocks/dwf","owner":"useblocks","description":"Documentation without Frustration","archived":false,"fork":false,"pushed_at":"2024-07-23T07:23:59.000Z","size":14373,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-01-02T11:15:09.490Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://useblocks.com/dwf","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/useblocks.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-20T12:14:03.000Z","updated_at":"2024-03-27T22:49:09.000Z","dependencies_parsed_at":"2022-07-26T09:45:05.636Z","dependency_job_id":null,"html_url":"https://github.com/useblocks/dwf","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/useblocks/dwf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fdwf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fdwf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fdwf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fdwf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/useblocks","download_url":"https://codeload.github.com/useblocks/dwf/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fdwf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31500397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-30T05:14:46.804Z","updated_at":"2026-04-07T04:31:53.858Z","avatar_url":"https://github.com/useblocks.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"Documentation Without Frustration (DWF)\n=======================================\nDWF is a collection of documentations, presentations and examples to introduce an\neasy way of writing and maintaining documentation inside small to mid-size software projects.\n\nKey audience for this kind of information are software engineers, who need to create, present and maintain\ndocumentations from the first requirement to final deployment report.\n\nPresentation\n------------\nOur complete DWF presentation can be found on: https://useblocks.com/dwf\n\nLimitations\n-----------\nThe presented approach is very code centric and handles the documentation topic only.\n\nThere are a lot of specialised tools, e.g. for architecture design, which are more suitable for the design process\nitself. But they may fail if it comes to the point of integration with other documents or supporting\nversion control systems.\n\nIntroduced tools and libraries\n------------------------------\n\nDocumentation\n*************\nDocumentation generation with `sphinx \u003chttp://www.sphinx-doc.org/en/stable/\u003e`_\n\nRequirements, Test case, ... management with `sphinx-needs \u003chttp://sphinxcontrib-needs.readthedocs.io/en/latest/\u003e`_\n\nArchitecture integration with `sphinx-plantuml \u003chttps://pypi.python.org/pypi/sphinxcontrib-plantuml\u003e`_\n\nProgram output documentation with `sphinx-programoutput \u003chttps://pythonhosted.org/sphinxcontrib-programoutput/\u003e`_\n\nPresentation layout with `sphinx-revealjs \u003chttps://pypi.python.org/pypi/sphinxjp.themes.revealjs/\u003e`_\n\nCode Documentation with `sphinx-autodoc \u003chttp://www.sphinx-doc.org/en/stable/ext/autodoc.html\u003e`_\n\nIDE\n***\n\nCode editor IntelliJ / `pyCharm \u003chttps://www.jetbrains.com/pycharm/\u003e`_\n\n`PlantUML integration \u003chttps://plugins.jetbrains.com/plugin/7017-plantuml-integration\u003e`_\n\nDiagram Painting\n****************\n`Plantuml \u003chttp://plantuml.com/\u003e`_\n\nDatabase\n********\nDB Schema documentation with `sphinx-sadisplay \u003chttps://pypi.python.org/pypi/sphinxcontrib-sadisplay\u003e`_\n\nCloud services\n**************\nDocumentation hosting with `readthedocs.org \u003chttps://readthedocs.org\u003e`_\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseblocks%2Fdwf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuseblocks%2Fdwf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseblocks%2Fdwf/lists"}