Panel discussion about documentation
summary
Panelists debate concrete tradeoffs not platitudes: a misleading design system in docs wastes real developer hours and is worse than none, Webpack’s docs evolve into a bestseller that fixed adoption, a tiny prototype turns README examples into runnable README demos that double as tests, and teams argue monorepo for docs eases PR-linked updates; tests and GraphQL schemas help but do not replace user-facing API and conceptual documentation.
AI-written summary · about
chapters (5)
- 0:00Start
- 0:28Panelists
- 1:11Is There Such Thing as Bad Documentation
- 11:43The Rust Programmer Manual
- 13:39Can Tests Take the Place of Good Documentation
related talks
21mWriting documentations that don't suck!
51mWriting the Darn Docs
29mHumanizing Your Documentation
40mDocumentation as User Experience
34mHumanizing Your Documentation
36mTo document, or not document that is the question
52mTechnically Speaking: improve your code with documentation
44mUseful and Beautiful Developer Docs and How to Create Them
