Documentation and ADRs

Overview

Document architectural decisions, API contracts, and system behavior. Focus on the "why" rather than the "what" because code already tells you what happens. Documentation should explain why it was designed that way.

When to Use

• Making architectural or design decisions
• Changing public APIs or interfaces
• Shipping features that affect other teams
• Recording tradeoffs and their rationale

Documentation Types

Architecture Decision Records (ADRs)