Manuals / Writing Better Documentation / Ch 1

StartBeginner25 min read

1. Docs serve a job

Writing Better Documentation · 12 pages source format

“Install X”, “Debug Y”, “Understand Z” — pick one job per page.

What you'll learn

  • Audience
  • Job

One page, one job

Tutorials teach. How-tos accomplish. References look up. Explanations deepen. Don’t mash them.

Do this now

Label your last doc as tutorial / how-to / reference / explanation.

Clear?

Checklist