Documentation Writing

This skill covers best practices for creating effective documentation that developers actually want to read and maintain.

Core Philosophy

Great documentation is:

• Clear: Easy to understand on first reading
• Complete: Answers the questions users actually have
• Current: Kept in sync with code changes
• Concise: No unnecessary fluff
• Scannable: Easy to find what you need
• Practical: Focuses on how-to, not just what

Types of Documentation

1. README Files

The front door to your project: