Documentation Writing Skill

Core Principle

Write for the reader's context, not the author's understanding.

Documentation exists to transfer knowledge efficiently. Good documentation anticipates questions, provides context, and guides readers to success. The best documentation makes the next user (or future you) productive without requiring tribal knowledge or guesswork.

Effective documentation:

• Meets readers where they are (assumes appropriate background)
• Answers "why" not just "what" and "how"
• Provides working examples
• Stays current with code changes
• Guides readers to success, not just describes features

Documentation Types