The practical implementation of Documentation as Code
summary
Argues for treating docs like code: store docs in Git for full traceability (Git blame/bisect), version and release docs alongside code with semantic commit/versioning, and structure docs as modular, domain-driven components that import dependency docs so updates travel with code. Recommends concrete tools — Pandoc, Hugo, Sphinx — plus Renovate and Commitizen for link and changelog automation, and diagram tools (Mermaid, D2, PlantUML). Notes CI pipelines render formats (PDF/HTML/Markdown) but do not fix poor content.
AI-written summary · about
chapters (9)
- 0:00Welcome to documentation as code
- 1:48Why documentation matters
- 10:15Documentation in critical infrastructure
- 14:01Types of documentation needed
- 17:12Documentation for different readers
- 20:24Choosing output formats
- 23:37Documentation as code practices
- 29:37Tools for documentation automation
- 33:50Key principles for documentation
related talks
50mContinuous and Automated Documentation Docs As Code in Practice
44mPushing documentation (so it doesn't hurt anymore)
47mDocumentation as code (explained to my dad)
46mBest Practices for Keeping Architecture Documentation Up to Date
41mStop making fool of yourself about documentation
25mBuilding Docs like Code: Continuous Integration for Documentation
45mDocs as Code Fix a poor documentation culture in your organization
16mcod == doc