Documentation Writing Guide

Philosophy

Documentation is the user interface for your code. Good docs make the difference between adoption and abandonment.

Core Principles

1. Write for your reader - Not yourself, not your ego
2. Show, don't tell - Examples beat explanations
3. Keep it current - Outdated docs are worse than none
4. Make it findable - Structure matters as much as content

"Documentation is a love letter that you write to your future self." — Damian Conway

{% if doc_type == "readme" or doc_type == "all" %}

README Structure