Manuals / Writing Better Documentation / Ch 3

SteadyBeginner20 min read

3. Keep docs alive

Writing Better Documentation · 12 pages source format

Owner, last-reviewed date, and a link from the thing it documents.

What you'll learn

  • Ownership
  • Review

Stale docs are lies

Add “Last reviewed” and an owner. Delete pages nobody owns.

Do this now

Add last-reviewed + owner to one doc today.

Pro tip. Link docs from error messages and UI empty states.

Clear?

Checklist