Code Documentation

Use this skill to produce technical documentation that helps the next engineer understand and change the code safely.

Workflow

1. Define the documentation target.

• Identify the artifact: repository doc, feature note, module doc, API contract, inline comment set, runbook, or migration note.
• Identify the primary reader: maintainer, teammate, reviewer, operator, or new contributor.
• Prefer the smallest documentation artifact that resolves the user's need.

2. Read the source of truth before writing.

• Inspect code, tests, config, commands, and existing docs before drafting.
• Treat implementation as authoritative over stale prose.
• Mark anything unverified as an assumption or TODO instead of presenting it as fact.