Tested & Correct: How to Make Sure Your Documentation Keeps Working
summary
Argues that documentation must be treated like code: docs get unit-test-like checks that run automatically every few minutes, catching broken installs, 404s and a race condition that only shows up under fast automated runs. Describes tools and practices used at ClusterHQ and Flocker: link checking, running install commands on clean VMs, and automated screenshot generation from changed outputs, plus tying docs to the same repo as code so changes fail CI when docs break.
AI-written summary · about
chapters (6)
related talks
38mDocs as Tests: A Strategy for Resilient Docs
37mKeeping trust: Testing documentation as part of a continuous integration process
44mTesting Documentation: Why So Technical?
05mWhy Living Documentation is Cool
01h 15mTaking Control Of Your Test Environment
42mUse testing to Develop Better Software Faster
43mWhat If Documenting Were Enough to Test?
49mUnit Test the Docs: Why You Should Test Your Code Examples