claude-buddy
Version:
Your friendly AI development companion for Claude Code - supercharge Claude Code with intelligent workflows and safety features
94 lines (72 loc) • 2.04 kB
Markdown
# ADR-XXX: [Title]
**Status**: [Proposed | Accepted | Deprecated | Superseded]
**Date**: [YYYY-MM-DD]
**Authors**: [Names]
**Reviewers**: [Names]
## Context
Describe the situation that led to this architectural decision. Include:
- The problem or challenge being addressed
- Current constraints or limitations
- Stakeholder concerns or requirements
- Timeline pressures or external factors
## Decision
State the architectural decision clearly and concisely. Include:
- What technology, pattern, or approach was chosen
- Key implementation details
- Scope and boundaries of the decision
## Options Considered
List and briefly describe the alternatives that were evaluated:
### Option 1: [Name]
- **Pros**:
- Benefit 1
- Benefit 2
- **Cons**:
- Drawback 1
- Drawback 2
### Option 2: [Name]
- **Pros**:
- Benefit 1
- Benefit 2
- **Cons**:
- Drawback 1
- Drawback 2
### Option 3: [Selected Option]
- **Pros**:
- Benefit 1
- Benefit 2
- **Cons**:
- Drawback 1
- Drawback 2
## Consequences
### Positive Outcomes
- Expected benefit 1
- Expected benefit 2
- Expected benefit 3
### Negative Outcomes
- Expected cost or limitation 1
- Expected cost or limitation 2
- Potential risks or trade-offs
### Neutral Impacts
- Changes that are neither positive nor negative
- Areas that remain unchanged
## Implementation
Describe how this decision was implemented:
- Key changes made to the codebase
- Configuration updates
- Dependencies added or removed
- Testing strategy
- Migration steps (if applicable)
## Monitoring and Success Criteria
How will we know if this decision is working:
- Key metrics to track
- Success indicators
- Warning signs or failure modes
- Review timeline
## Related ADRs
- [ADR-XXX](./ADR-XXX-title.md) - Related decision
- [ADR-XXX](./ADR-XXX-title.md) - Supersedes this decision
- [ADR-XXX](./ADR-XXX-title.md) - Superseded by this decision
## References
- [External documentation or resources]
- [Relevant RFCs or specifications]
- [Team discussions or meeting notes]