Taking a step back: Analysing your documentation
summary
A practical workflow for a doc spring clean: gather everything (repo, release notes, code comments, blogs, support threads, marketing), interview contributors and run surveys (uses SurveyMonkey), then run a user‑task analysis matrix and score 3/2/1 to prioritize critical paths. Split content into concepts tasks reference and never mix them. Plan work realistically—use the 20/50/20/10 time split—and a five‑month/100‑working‑day example (4w planning, 10w drafting, 4w review, 2w production). Links to the Good Docs IA guide and DITA for tooling are referenced.
AI-written summary · about
chapters (10)
- 0:00Introduction
- 3:59Gather the goods
- 8:01Think about your readers
- 15:12User task analysis
- 18:39Finding the gaps
- 24:31Dream match reality
- 26:57Set a deadline
- 28:23Be flexible
- 29:13Start writing
- 29:51Questions
related talks
29mTaking Stock of Your Documentation
27mThe art and practice of documentation triage
40mDocs Tools for OSS Maintainers
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
23mMain Takeaways After One Year in Documentation
45mDocs or it didn't happen!
20mStop writing docs; Start helping
39mA Strategic Documentation Template for Startups