Documentation Templates Skill

Create clear, maintainable documentation for projects and code.

Resources

For full templates, see:

• references/readme-template.md - Complete README template
• references/api-docs-template.md - API documentation template

Core Principles

1. Explain Why, Not What - Code shows what; docs explain why
2. Keep it Updated - Outdated docs are worse than no docs
3. Write for Humans - Clear, concise, jargon-free
4. Progressive Disclosure - Start simple, provide details on demand
5. Examples are King - Show, don't just tell

README Quick Structure