Docs for Everyone!
summary
Five concrete prescriptions for one docs site that serves newcomers and power users including adopting the Diátaxis framework to expose documentation architecture, rewriting the official Gatsby tutorial and embedding diagrams and videos, using mdx collapsible box and announcement components to opt readers into extra detail, adding learning objectives and end‑of‑part self‑assessment, and storing ratings and comments in a database surfaced by a Gatsby site via a feedback widget to spot issues like a missing Continue button and validate fixes.
AI-written summary · about
chapters (7)
- 0:00Introduction to docs
- 1:49Expose documentation architecture
- 4:35Set the stage for content
- 7:03Let readers choose format
- 10:56Check for understanding
- 11:59Get user feedback
- 13:24Summary and recap
related talks
46mSave a Dev, Write Documentation!
21mWriting documentations that don't suck!
43mThe Docs Are Fine, Don't Worry
45mDocs or it didn't happen!
47mDocumentation Is Fine, Don't Worry
48mBeyond Words: Crafting User-Friendly Documentation
43mUseful and Beautiful Developer Docs and How to Create Them
39mDevelopers Documentation: your hidden strength