Save a Dev, Write a Doc!
summary
Explains how writing good documentation helps developers be more effective and reduces onboarding friction by covering practical documentation practices and tools. Gives concrete advice on what to document, how to structure guides and examples, and which formats and tooling (README, Markdown, static site generators, version-controlled docs) make documentation maintainable and useful.
AI-written summary · about
chapters (24)
- 0:00Introduction
- 2:04Myth of self-documenting code
- 4:24Installation
- 7:05The context
- 8:57Architecting the documentation
- 15:11Diversity of the audience
- 17:59The right hunter
- 18:28Not an end in itself
- 19:12A small team?
- 23:48Writing a documentation page
- 25:00Fear of the blank page?
- 26:09Images in the documentation
- 27:04Diagrams in the documentation
- 29:30Highlighting the content
- 29:49Including code in the documentation
- 30:34Keeping examples up to date!
- 32:19Glossaries
- 32:59Spell checker
- 34:22Documentation style guide
- 35:02Documentation expectations
- 35:45Legacy product documentation
- 36:02Up-to-date documentation
- 36:52Searching the documentation
- 37:54Documentation as a communication tool
related talks
46mSave a Dev, Write Documentation!
33mWhat The Doc?!?! How to Write and Read Documentation That Allows You To Get Sh*t Done!
01h 24mWriting Documentation - Practices and Theory
28mImproving Your Documentation: A talk for developers who want to write stuff good
17mDevelopers Documentation: your secret weapon
39mDevelopers Documentation: your hidden strength
29mMove Fast and Document Things: Writing internal docs at fast-moving organizations
52mTechnically Speaking: improve your code with documentation