Technical documentation – how can I write them better and why should I care?
summary
Claims a practical, repeatable method: anyone can write useful tech docs and doing so cuts interruptions — one example drops ~7–8 daily questions to 1–2. Recommends markdown docs folder in the repo, CI checks and linters for docs (broken links, validations), plus tangible practices: table of contents, short simple English, separate concept vs task pages, PR review of docs, and sharing drafts for feedback so the document actually helps and is discoverable.
AI-written summary · about
chapters (8)
- 0:00Introduction
- 0:57Technical documentation
- 1:53Why write technical documentation
- 4:30How to write technical documentation
- 6:06General content guidelines
- 8:15Documentation
- 9:35Audience
- 11:38Outro
related talks
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
27mWrite Docs Devs Love: Ten Tips To Level Up Your Tech Writing
01h 24mWriting Documentation - Practices and Theory
43m"How To Write Tech Documentation That Will Save Your Career"
20mDo Docs Better: Practical Tips on Delivering...
28mImproving Your Documentation: A talk for developers who want to write stuff good
28mStop writing docs; start helping!
44mWriting Technical Documentation in a Lean Style