Taking Stock of Your Documentation
summary
Recommend a concrete checklist: adopt the four-document model (tutorials, how-tos, explainers, reference), add special cases like hairball examples, case studies, troubleshooting entries and executable playground sessions. Run an assessment: inventory every doc and informal artifact, categorize by type and coverage, note owners, and list missing pieces. Validate by full read‑through for small projects, onboarding tests for newcomers, and backlog/tag review. Prioritize fixes as seconds/hours tasks; hire a writer only if audience, scope, and budget require it.
AI-written summary · about
chapters (5)
- 0:00Start
- 4:59HOWTO: NON-TECH EXAMPLE
- 6:42UNDERSTANDING: NON-TECH EXAMPLE
- 7:47UNDERSTANDING: TECH EXAMPLE
- 9:20REFERENCE: NON-TECH EXAMPLE
related talks
37mTaking a step back: Analysing your documentation
01h 24mWriting Documentation - Practices and Theory
33mWhat The Doc?!?! How to Write and Read Documentation That Allows You To Get Sh*t Done!
33mDocumentation: The Missing Pieces
28mImproving Your Documentation: A talk for developers who want to write stuff good
34mDocumentation Thinking Beyond the Docs: Lessons from Decision-Facing Technical Writing
46mSave a Dev, Write Documentation!
36mTo document, or not document that is the question