Pushing documentation (so it doesn't hurt anymore)
summary
Documentation is often postponed yet critical: teams last ~3 years while systems run ~13 years, leaving a ~10-year knowledge gap. The talk demonstrates a docs-as-code workflow using AsciiDoc, the docToolchain (Gradle/Maven) and the Arc42 template to keep docs in Git, include marked source snippets, render diagrams (Mermaid/draw.io), convert Excel sheets to AsciiDoc, and publish HTML/PDF/Confluence. The pipeline integrates with PRs and CI, is used on real projects, and successfully generates searchable, versioned docs.
AI-written summary · about
chapters (6)
- 0:00Start
- 2:48Why documentation?
- 6:47How and what?
- 21:55doc Toolchain
- 35:16Good documentation
- 38:29Whats next?
related talks
50mContinuous and Automated Documentation Docs As Code in Practice
35mThe practical implementation of Documentation as Code
41mStop making fool of yourself about documentation
47mDocumentation as code (explained to my dad)
35mBuilding Docs like Code: Continuous Integration for Documentation
25mBuilding Docs like Code: Continuous Integration for Documentation
46mBest Practices for Keeping Architecture Documentation Up to Date
47mDocumentation Is Fine, Don't Worry