"Living Documentation": When Our Product Definition, Our Automated Tests...
summary
Explains how to make product definitions, automated tests, and documentation the same artifact using living documentation practices. Describes tools and processes (BDD-style specifications, automated test suites integrated with docs) to keep documentation up to date and executable alongside code.
AI-written summary · about
chapters (16)
- 0:00Home
- 3:05Why is it useful?
- 9:03The problems with documentation
- 11:14The 4 principles of living documentation
- 13:15What will we document?
- 14:56The concept of Knowledge Authority
- 17:42The stakes involved
- 18:18The title
- 23:11Common code
- 24:57Tests
- 26:04Scenarios
- 34:31Diagrams
- 35:50Tools
- 37:29Architecture diagrams
- 41:19Concrete example
- 42:11Conclusion
related talks
05mWhy Living Documentation is Cool
47mDocumentation, it is alive!
43mWhat If Documenting Were Enough to Test?
18mContinuous Documentation Manifesto
01h 24mWriting Documentation - Practices and Theory
25mBuilding Docs like Code: Continuous Integration for Documentation
44mTesting Documentation: Why So Technical?
39mDevelopers Documentation: your hidden strength