Always complete, never finished
summary
Argues that documentation should be always complete but never finished by growing in tiny iterative steps rather than big plans. Shows a concrete project: a Python camera model turned into Sphinx docs on readthedocs that attract 120 stars on GitHub, and a large refactor of pytest docs done by many small commits and fast merges. Claims the method reduces wasted rework, produces useful publishable material at every step, and succeeds where monolithic restructuring fails.
AI-written summary · about
chapters (20)
- 0:00Introduction
- 0:58Documentation authoring framework
- 1:50The bookcase
- 6:19Planning
- 9:50Documentation
- 10:46Trap
- 11:11Always complete never finished
- 11:31Wellformed growth
- 14:59Lessons for documentation
- 15:57Workflow of iterative evolution
- 18:28New documentation
- 23:15Out of hand
- 24:09Back to documentation
- 25:05PiTest
- 31:07Getting out of planning process
- 32:19Fake plans
- 33:27Good Docs
- 35:26Framework
- 37:27Scale
- 38:52Conclusion
related talks
36mTo document, or not document that is the question
18mContinuous Documentation Manifesto
34mHumanizing Your Documentation
28mStop writing docs; start helping!
29mHumanizing Your Documentation
45mEnsuring that Documentation is a First-class Citizen in OS Projects
51mWriting the Darn Docs
38mThe Stuff You Don't Want to Write... Documentation