Stop writing docs; start helping!
summary
Argues that documentation exists to help people, not to be pretty, and recommends concrete steps: audit every statement for truth and delete clutter, label content by reader goal with a dixis-style structure, prioritize a single accurate README over partial pages, and stop using we and should in instructions. Measures success by support tickets and docs-linked PRs, routes support answers to docs updates, and treats docs as minimum viable help that sends users back to building.
AI-written summary · about
chapters (7)
- 0:00Better documentation intro
- 3:11Why docs must help
- 6:08Clear docs rules
- 9:44Navigable discoverable docs
- 13:38Minimum viable docs antipatterns
- 18:59Focus on helping
- 20:25Conclusion next steps
related talks
20mStop writing docs; Start helping
29mHumanizing Your Documentation
29mHumanizing Your Documentation
33mWhat The Doc?!?! How to Write and Read Documentation That Allows You To Get Sh*t Done!
34mHumanizing Your Documentation
28mHumanizing Your Documentation
01h 24mWriting Documentation - Practices and Theory
06mHumanizing Your Documentation