# Documentation Standards

> How to write clear and useful documentation

- Skill: `willayam/documentation-standards` (Agent Skill)
- Install (CLI): `npx skillmds@latest add willayam/documentation-standards`
- Raw SKILL.md: https://api.skillmd.com/api/skills/willayam/documentation-standards/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: Willayam (https://skillmd.com/u/willayam)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/willayam/documentation-standards

---


# Documentation Standards

## README Requirements

Every project README should include:

1. **What** - Brief description of what the project does
2. **Why** - Problem it solves
3. **How** - Quick start guide
4. **Setup** - Installation and configuration
5. **Usage** - Common use cases with examples

## Code Comments

- Document "why" not "what"
- Keep comments up to date
- Use JSDoc/docstrings for public APIs

## API Documentation

- Document all endpoints
- Include request/response examples
- Note authentication requirements
- List error codes and meanings