In dieser Serie diskutieren wir interessante Themen aus Software-Entwicklung und -Architektur – immer mit dem Fokus auf Praxistauglichkeit.
https://www.innoq.com/podcast
episode 109: Dokumentation technisch umsetzen
Das Tooling macht‘s aus
„Selbst eine Word-Doku ist besser als gar keine Doku“ – Dokumentation von Software ist oft ein leidiges Thema mit noch leidigeren Werkzeugen. Lucas und Lars schauen sich in dieser Folge mal die vorhandenen Tools und Formate zur technischen Umsetzung einer guten Softwaredokumentation an. Damit am Ende niemand mehr sagen kann: „es gibt keine Doku, weil die Tools nerven“. Leider gab es in dieser Folge Probleme mit Lucas Audiospur. Beim nächsten Mal kehren wir zur gewohnten Qualität zurück.
- Blog Post Injecting environment variables into static websites using NGINX
- Blog Post Customer-specific documentation with Jekyll
- Blog Post Rich code documentation with Jekyll
- arc42
- Pandoc
- BibTeX
- C4 model
- Software Architecture for Developers
- SoftwareArchitekTOUR-Podcast: arc42 – ein pragmatischer Ansatz zur Dokumentation
- Hillel Wayne: On Metafiles
- Confluence Publisher
- PrinceXML
- GraphViz