Architecture Decision Record (ADR)

What it does

This skill helps generate Architecture Decision Records (ADRs). ADRs are short, plain text documents that capture important decisions made during software development, including the context, options considered, and reasons for choosing a particular approach. The skill can create new ADRs from scratch or update existing ones with additional information about implementation details or outcomes. It aims to improve transparency and maintainability by documenting architectural choices.

When to use it

• When deciding on a specific technology stack for a project (e.g., "Which database should we use?").
• To document the rationale behind choosing a particular design pattern.
• During discussions about scaling strategies or performance optimization.
• To record decisions related to security and compliance requirements.

Key capabilities

• Generates new ADR documents with standard sections (Context, Decision, Consequences).
• Updates existing ADRs with implementation details and outcomes.
• Supports various formatting options for clarity and readability.
• Facilitates collaboration by providing a centralized record of architectural decisions.

Example prompts

• "Create an ADR about our choice to use React for the frontend."
• "Update the 'Database Selection' ADR with details on how we implemented caching."
• "Generate a new ADR outlining the decision to migrate to serverless functions."

Tips & gotchas

This skill is most effective when used proactively during architectural discussions. Ensure all stakeholders are involved in the decision-making process and that the resulting ADR accurately reflects the agreed-upon approach.