documentation-standards

SKILL.md

Universal principles for effective documentation. Language-agnostic—focus on what and when to document, not syntax.

Prefer clear names and simple structure over comments. Write comments for reasoning, not restating.

Rule: If you need a comment to explain what code does, refactor first.

Apply documentation standards: comment why not what, minimal comments (prefer clear code), maintain README with quick start, update docs with breaking changes. Use when writing comments, creating docs, reviewing documentation, or discussing what to document. Source: phrazzld/claude-config.

View raw