Building Docs like Code: Continuous Integration for Documentation
summary
Argues that documentation sits next to code in the repo, is built and versioned on every commit, and is reviewed and tested like code, using a cookiecutter template plus MkDocs + Sphinx for content, Travis CI → GitHub Pages for automated build/publish, and doctest/link checks to catch broken examples and links. Presents a working pipeline that stops support tickets (zero for one team) and yields some of the most up-to-date docs in a ~2,000‑engineer company.
AI-written summary · about
chapters (25)
- 0:00Introduction
- 0:34Who is this talk for
- 1:56Long release cycles
- 2:37More layers of separation
- 3:07Why do developers not like documenting
- 3:21The real issue
- 4:09What if
- 4:43Version Docs
- 5:39Benefits
- 7:41Case Study
- 8:30How does this change the workflow
- 8:53Act a Hero Emerges
- 9:03What is CI
- 9:52Documentation types
- 10:20Documentation tools
- 10:57Special space in the presentation
- 11:33MakeDocs
- 12:03UML Diagrams
- 12:50Sphinx
- 14:25the final battle
- 14:51my solution
- 15:16Demo
- 20:58Can you try this yourself
- 22:00Source
- 22:54Final Thoughts
related talks
36mBuilding Docs like Code: Continuous Integration for Documentation
23mTreating Documentation like Code: a Practical Account
44mPushing documentation (so it doesn't hurt anymore)
35mThe practical implementation of Documentation as Code
47mEngineering Documentation
50mContinuous and Automated Documentation Docs As Code in Practice
45mDocs as Code Fix a poor documentation culture in your organization
18mContinuous Documentation Manifesto