Keeping trust: Testing documentation as part of a continuous integration process
summary
Proposes two concrete paths: merge executable tests and docs so a failing test flags stale text, or embed machine-readable metadata (using RDFa) to generate conditional, versioned docs. Shows a working prototype that records UI flows as selenium tests turned into documentation, parameterizes domains, auto-updates screenshots, injects via a proxy, and exports to CI-friendly formats. Describes a community product at walker.net, a successful Indiegogo raise of 11,567 dollars, and notes gaps around credentials and a smoother browser plugin.
AI-written summary · about
chapters (7)
- 0:00Start
- 1:37agile world
- 3:41Multiple versions
- 5:10(QA) automation
- 12:15References Written in code, or extracted from code
- 13:14Tasks Document automated
- 17:09Building the ultimate user guide
related talks
38mDocs as Tests: A Strategy for Resilient Docs
23mTest and Docs: Hand in Hand
05mWhy Living Documentation is Cool
44mTesting Documentation: Why So Technical?
24mTested & Correct: How to Make Sure Your Documentation Keeps Working
08mExample-driven development: bridging tests and documentation
47mTelling Better Stories with Tests
43mWhat If Documenting Were Enough to Test?