Testing Panel
summary
Writing the README first and using readme driven development plus inline TomDoc comments yields concrete results: tiny, smarter methods, explicit argument and return contracts, examples that map to tests, and fewer surprises during refactors. GitHub treats docs as living artifacts next to code, uses READMEs in subdirectories, and maintains them across a roughly 40 people codebase, which speeds onboarding and makes bug hunts and test writing noticeably easier.
AI-written summary · about
chapters (6)
- 0:00Start
- 1:16Humans Are Not Ruby Interpreters
- 5:22Readme Driven Development
- 8:07Work in Sub Directories
- 13:16Examples
- 23:43What's the Most Important Thing To To Help Your Developers Improve Documentation for the Team
related talks
44mTesting Documentation: Why So Technical?
08mExample-driven development: bridging tests and documentation
38mDocs as Tests: A Strategy for Resilient Docs
49mUnit Test the Docs: Why You Should Test Your Code Examples
37mKeeping trust: Testing documentation as part of a continuous integration process
37mDelicious Controversy: Docs & Tests
05mWhy Living Documentation is Cool
24mTested & Correct: How to Make Sure Your Documentation Keeps Working