Writing Good Documentation for Developers
summary
Developer docs are your UI, marketing, and product definition: an Anvil case shows Python in the browser and server, a drag‑and‑drop IDE, and hosting, and led to a concrete change—restructure the table of contents so questions like "does it store data" appear first rather than plugin folders. Distinguish reference vs API docs (story vs code objects), avoid javadoc disease, and surface community Q&A in Discourse or Stack Overflow so search fixes become documented patches.
AI-written summary · about
chapters (14)
- 0:00Intro
- 0:14Writing Good Developer Docs
- 0:36Why do we care?
- 2:13Docs are content marketing.
- 3:03Docs define your product.
- 5:14Docs are your user interface.
- 6:25Types of Documentation
- 8:41API docs are not reference docs.
- 9:16Reference docs tell a story.
- 14:41Your user is on a journey.
- 17:52Talk to your users
- 19:04Questions are bug reports.
- 19:16Answers are patches.
- 20:14Explanation
related talks
01h 24mWriting Documentation - Practices and Theory
44mUseful and Beautiful Developer Docs and How to Create Them
39mDevelopers Documentation: your hidden strength
48mUseful and Beautiful Developer Docs and How to Create Them
28mImproving Your Documentation: A talk for developers who want to write stuff good
40mDocumentation as User Experience
51mWriting the Darn Docs
23mWriting for Developers: Take your Project Docs to the Next Level