Posts tagged “documentation”

Writing short docs well

Tom Bedor wrote how to write good short docs. Most of it lands. Key takeaways, with some riffing:

Optimize for short attention spans. Think in tiers: the 5-second glance (title and first line), the 5-minute skim (summary and headings). This means: clear titles — the most important line in any doc. A concise summary at the top covering what's in scope and what's not. Strong headings. Collapsible/tabbed sections where the format allows.

Read more →