Stop writing docs; Start helping
summary
Focuses on concrete edits: verify every statement for accuracy, delete incorrect statements and outdated pages, and prefer clarity over completeness so readers get back to building. Organize by reader intent using a content-type framework, add a table of contents or search widget, or simply use one README until IA is stable. Avoid rhetorical words like "we" and "should", state mandatory steps directly, and treat contribution feedback as a roadmap for priorities.
AI-written summary · about
chapters (8)
- 0:00Introduction
- 1:47Purpose of docs
- 4:15Are your docs helpful?
- 6:06Clear and correct docs
- 9:15Navigable documentation
- 12:44Writing vs helping
- 17:41Promises in docs
- 18:24Conclusion
related talks
28mStop writing docs; start helping!
37mTaking a step back: Analysing your documentation
10mWriting effective documentation
29mHumanizing Your Documentation
28mHumanizing Your Documentation
28mImproving Your Documentation: A talk for developers who want to write stuff good
06mHumanizing Your Documentation
29mHumanizing Your Documentation