C · InfluenceAdvanced35 min read
8. Documentation people actually read
Communication · 36 pages source format
Good docs: short, scannable, task-oriented. Start with what reader needs to DO, not background history.
What you'll learn
- Task-oriented docs
- Scannable structure
- Docs as product
Rewrite a README
Lead with quickstart. Move architecture to bottom. Add troubleshooting.
Do this now
Rewrite a README following Google tech writing principles.
Clear?
Diataxis check
Tutorials (learning), how-to (tasks), reference (lookup), explanation (understanding). Pick the right type.
Do this now
Classify 4 docs in your project by Diataxis type.
Clear?