# Documentation

> Documentation writing standards

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

---


# Documentation Standards

Clear, maintainable documentation.

## README Structure

1. Project name and description
2. Quick start / installation
3. Usage examples
4. Configuration options
5. API reference (if library)
6. Contributing guide

## Code Comments

- WHY not WHAT
- Explain non-obvious decisions
- Document constraints
- No redundant comments

## API Documentation

- All parameters with types
- Return values and errors
- Examples for common cases
- Version compatibility

## Anti-Patterns

- No commented-out code
- No TODO without issue link
- No outdated examples
- No missing version info