Documentation Standards

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

Core Principle

Good code documents itself. Comments explain what code cannot.

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

Comments vs Code

When to Comment