Documentation Standards

Best practices for writing clear and maintainable code documentation.

When to Use

Use these standards when:

• Documenting React components and their props
• Writing JSDoc for complex functions or hooks
• Adding inline comments to explain non-obvious logic
• Creating README files for features or modules
• Documenting API interfaces and type definitions
• Explaining "why" decisions were made

Core Principles

Document the "Why", Not the "What"

Code should be self-documenting for what it does. Comments should explain why it exists or why it's implemented in a particular way.