Writing documentations that don't suck!
summary
Argues for empath-driven-documentation that targets user motivations and pain points, and shows concrete fixes: use JAMstack/SSG (Gatsby, Next.js) and CDN deploys plus image/video optimization to make docs fast; run documentation work in parallel with PRDs or insert it between staging and QA as doc-driven development so examples stay runnable; add per‑page thumbs up/down and inline edits for feedback; experiment with a docs‑trained AI like an ask me anything agent (Netlify / Supabase examples).
AI-written summary · about
chapters (12)
- 0:00Introduction and setup
- 1:53Ground rules for the talk
- 3:39About me and my work
- 4:21Problems with bad docs
- 5:23What makes docs good
- 6:06Make documentation fast
- 7:34Clarity and conciseness
- 9:43Keeping docs evergreen
- 12:32Completeness and accuracy
- 15:23Feedback and collaboration
- 17:32AI integration in docs
- 19:15Key takeaways and conclusion
