Search First-Writing for non-writers
summary
Argues for search-first documentation that fixes the 80% common problems first using analytics to find pain points and a growing tag cloud for discoverability, keeps docs lightweight and editable (a GitHub wiki works), avoids firewalls, provides modular pages with prerequisites and breadcrumb trails, and ends each task with a simple success test so users and maintainers know it worked; also says sometimes the right fix is code not docs and recommends stealing good community answers back into the trunk.
AI-written summary · about
chapters (6)
- 0:00Start
- 9:13You don't have to be an expert
- 13:37Descriptive docs
- 15:45Task-based docs
- 19:45Search-first documentation
- 22:15I'm gonna pop some (meta) tags
related talks
22mWrite Prose, Not just programs
35mEngage or Die: Four Techniques for Writing Indispensible Docs
38mWelcome to the World of Technical Writing: A Guide for Newcomers
25mWork On The Wrong Things First
31m7 Essential Tips for the Enlightened Tech Writer
36mThe Invisible Work: What It Takes to Be the First (and Only) Tech Writer on the Team
06mBe a Salmon
17mHow to Boost Your Community Awareness by Writing