"How to Find the Write Rhythm for your Software Composition"
summary
Argues that adopting the diátaxis model as a shared decoding mechanism and running an internal Documentation Festival (eight four-hour workshops, 3–6 people each) reduces friction around code understanding. Teams build concrete artifacts: a reference guide for APIs that made PR reviews readable and faster, and updated onboarding materials that let new hires open PRs in their first week. The measurable claim is that a short, repeated workshop program plus patterned docs improves team communication and review velocity.
AI-written summary · about
chapters (7)
- 0:00Introduction
- 4:28Documentation challenges at vouch.io
- 10:50Hofstadter’s context levels
- 16:18Diataxis for documentation
- 19:06Documentation Festival solution
- 24:51Code and docs maturity
- 30:36Call to action
related talks
55mThe Emperor Has No Docs
38mThe Stuff You Don't Want to Write... Documentation
25mRethinking measurement for high-performing teams
38mWhat Poetry Workshops Teach Us about Code Review
35mFrom Code to Clarity: Collaboration with Devels when Writing Product Documentation
01h 24mWriting Documentation - Practices and Theory
39mDeveloper’s Torment: The Documentation
43mMeasuring Developer Productivity: The Good, the Bad and the Data