Claude Cursor Skill

architecture-decision-records

Write and maintain Architecture Decision Records (ADRs) following best practices for technical decision documentation. Use when documenting significant technical decisions, reviewing past architectural choices, or establishing decision processes.

LLM Mart · 0 points · 11 views 0 listing impressions 0 install-command copies
Download wshobson-agents-plugins_documentation-generation_skills_architecture-decision-records-0874a27.zip · 6 KB

Install

skills CLI npx skills add https://github.com/wshobson/agents/tree/main/plugins/documentation-generation/skills/architecture-decision-records
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install wshobson-agents@llmmart
Git git clone https://github.com/wshobson/agents.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole wshobson/agents collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

Architecture Decision Records

Comprehensive patterns for creating, maintaining, and managing Architecture Decision Records (ADRs) that capture the context and rationale behind significant technical decisions.

When to Use This Skill

  • Making significant architectural decisions
  • Documenting technology choices
  • Recording design trade-offs
  • Onboarding new team members
  • Reviewing historical decisions
  • Establishing decision-making processes

Core Concepts

1. What is an ADR?

An Architecture Decision Record captures:

  • Context: Why we needed to make a decision
  • Decision: What we decided
  • Consequences: What happens as a result

2. When to Write an ADR

Write ADR Skip ADR
New framework adoption Minor version upgrades
Database technology choice Bug fixes
API design patterns Implementation details
Security architecture Routine maintenance
Integration patterns Configuration changes

3. ADR Lifecycle

Proposed → Accepted → Deprecated → Superseded
              ↓
           Rejected

Before drafting a standard, lightweight, or Y-statement ADR, read decision templates.

Before drafting a deprecation ADR or RFC, read deprecation and RFC templates.

ADR Management

Directory Structure

docs/
├── adr/
│   ├── README.md           # Index and guidelines
│   ├── template.md         # Team's ADR template
│   ├── 0001-use-postgresql.md
│   ├── 0002-caching-strategy.md
│   ├── 0003-mongodb-user-profiles.md  # [DEPRECATED]
│   └── 0020-deprecate-mongodb.md      # Supersedes 0003

ADR Index (README.md)

# Architecture Decision Records

This directory contains Architecture Decision Records (ADRs) for [Project Name].

## Index

| ADR                                   | Title                              | Status     | Date       |
| ------------------------------------- | ---------------------------------- | ---------- | ---------- |
| [0001](0001-use-postgresql.md)        | Use PostgreSQL as Primary Database | Accepted   | 2024-01-10 |
| [0002](0002-caching-strategy.md)      | Caching Strategy with Redis        | Accepted   | 2024-01-12 |
| [0003](0003-mongodb-user-profiles.md) | MongoDB for User Profiles          | Deprecated | 2023-06-15 |
| [0020](0020-deprecate-mongodb.md)     | Deprecate MongoDB                  | Accepted   | 2024-01-15 |

## Creating a New ADR

1. Copy `template.md` to `NNNN-title-with-dashes.md`
2. Fill in the template
3. Submit PR for review
4. Update this index after approval

## ADR Status

- **Proposed**: Under discussion
- **Accepted**: Decision made, implementing
- **Deprecated**: No longer relevant
- **Superseded**: Replaced by another ADR
- **Rejected**: Considered but not adopted

Automation (adr-tools)

# Install adr-tools
brew install adr-tools

# Initialize ADR directory
adr init docs/adr

# Create new ADR
adr new "Use PostgreSQL as Primary Database"

# Supersede an ADR
adr new -s 3 "Deprecate MongoDB in Favor of PostgreSQL"

# Generate table of contents (to a separate file, so the hand-written
# index and guidelines in README.md are not overwritten)
adr generate toc > docs/adr/toc.md

# Link related ADRs
adr link 2 "Complements" 1 "Is complemented by"

Review Process

## ADR Review Checklist

### Before Submission

- [ ] Context clearly explains the problem
- [ ] All viable options considered
- [ ] Pros/cons balanced and honest
- [ ] Consequences (positive and negative) documented
- [ ] Related ADRs linked

### During Review

- [ ] At least 2 senior engineers reviewed
- [ ] Affected teams consulted
- [ ] Security implications considered
- [ ] Cost implications documented
- [ ] Reversibility assessed

### After Acceptance

- [ ] ADR index updated
- [ ] Team notified
- [ ] Implementation tickets created
- [ ] Related documentation updated

Best Practices

Do's

  • Write ADRs early - Before implementation starts
  • Keep them short - 1-2 pages maximum
  • Be honest about trade-offs - Include real cons
  • Link related decisions - Build decision graph
  • Update status - Deprecate when superseded

Don'ts

  • Don't change accepted ADRs - Write new ones to supersede
  • Don't skip context - Future readers need background
  • Don't hide failures - Rejected decisions are valuable
  • Don't be vague - Specific decisions, specific consequences
  • Don't forget implementation - ADR without action is waste
Files (agents)
  • references
    • decision-templates.md 5 KB
      Loading…
    • deprecation-rfc-templates.md 3.4 KB
      Loading…
  • SKILL.md 4.9 KB
    ---
    name: architecture-decision-records
    description: Write and maintain Architecture Decision Records (ADRs) following best practices for technical decision documentation. Use when documenting significant technical decisions, reviewing past architectural choices, or establishing decision processes.
    ---
    
    # Architecture Decision Records
    
    Comprehensive patterns for creating, maintaining, and managing Architecture Decision Records (ADRs) that capture the context and rationale behind significant technical decisions.
    
    ## When to Use This Skill
    
    - Making significant architectural decisions
    - Documenting technology choices
    - Recording design trade-offs
    - Onboarding new team members
    - Reviewing historical decisions
    - Establishing decision-making processes
    
    ## Core Concepts
    
    ### 1. What is an ADR?
    
    An Architecture Decision Record captures:
    
    - **Context**: Why we needed to make a decision
    - **Decision**: What we decided
    - **Consequences**: What happens as a result
    
    ### 2. When to Write an ADR
    
    | Write ADR                  | Skip ADR               |
    | -------------------------- | ---------------------- |
    | New framework adoption     | Minor version upgrades |
    | Database technology choice | Bug fixes              |
    | API design patterns        | Implementation details |
    | Security architecture      | Routine maintenance    |
    | Integration patterns       | Configuration changes  |
    
    ### 3. ADR Lifecycle
    
    ```
    Proposed → Accepted → Deprecated → Superseded
                  ↓
               Rejected
    ```
    
    Before drafting a standard, lightweight, or Y-statement ADR, read [decision templates](references/decision-templates.md).
    
    Before drafting a deprecation ADR or RFC, read [deprecation and RFC templates](references/deprecation-rfc-templates.md).
    
    ## ADR Management
    
    ### Directory Structure
    
    ```
    docs/
    ├── adr/
    │   ├── README.md           # Index and guidelines
    │   ├── template.md         # Team's ADR template
    │   ├── 0001-use-postgresql.md
    │   ├── 0002-caching-strategy.md
    │   ├── 0003-mongodb-user-profiles.md  # [DEPRECATED]
    │   └── 0020-deprecate-mongodb.md      # Supersedes 0003
    ```
    
    ### ADR Index (README.md)
    
    ```markdown
    # Architecture Decision Records
    
    This directory contains Architecture Decision Records (ADRs) for [Project Name].
    
    ## Index
    
    | ADR                                   | Title                              | Status     | Date       |
    | ------------------------------------- | ---------------------------------- | ---------- | ---------- |
    | [0001](0001-use-postgresql.md)        | Use PostgreSQL as Primary Database | Accepted   | 2024-01-10 |
    | [0002](0002-caching-strategy.md)      | Caching Strategy with Redis        | Accepted   | 2024-01-12 |
    | [0003](0003-mongodb-user-profiles.md) | MongoDB for User Profiles          | Deprecated | 2023-06-15 |
    | [0020](0020-deprecate-mongodb.md)     | Deprecate MongoDB                  | Accepted   | 2024-01-15 |
    
    ## Creating a New ADR
    
    1. Copy `template.md` to `NNNN-title-with-dashes.md`
    2. Fill in the template
    3. Submit PR for review
    4. Update this index after approval
    
    ## ADR Status
    
    - **Proposed**: Under discussion
    - **Accepted**: Decision made, implementing
    - **Deprecated**: No longer relevant
    - **Superseded**: Replaced by another ADR
    - **Rejected**: Considered but not adopted
    ```
    
    ### Automation (adr-tools)
    
    ```bash
    # Install adr-tools
    brew install adr-tools
    
    # Initialize ADR directory
    adr init docs/adr
    
    # Create new ADR
    adr new "Use PostgreSQL as Primary Database"
    
    # Supersede an ADR
    adr new -s 3 "Deprecate MongoDB in Favor of PostgreSQL"
    
    # Generate table of contents (to a separate file, so the hand-written
    # index and guidelines in README.md are not overwritten)
    adr generate toc > docs/adr/toc.md
    
    # Link related ADRs
    adr link 2 "Complements" 1 "Is complemented by"
    ```
    
    ## Review Process
    
    ```markdown
    ## ADR Review Checklist
    
    ### Before Submission
    
    - [ ] Context clearly explains the problem
    - [ ] All viable options considered
    - [ ] Pros/cons balanced and honest
    - [ ] Consequences (positive and negative) documented
    - [ ] Related ADRs linked
    
    ### During Review
    
    - [ ] At least 2 senior engineers reviewed
    - [ ] Affected teams consulted
    - [ ] Security implications considered
    - [ ] Cost implications documented
    - [ ] Reversibility assessed
    
    ### After Acceptance
    
    - [ ] ADR index updated
    - [ ] Team notified
    - [ ] Implementation tickets created
    - [ ] Related documentation updated
    ```
    
    ## Best Practices
    
    ### Do's
    
    - **Write ADRs early** - Before implementation starts
    - **Keep them short** - 1-2 pages maximum
    - **Be honest about trade-offs** - Include real cons
    - **Link related decisions** - Build decision graph
    - **Update status** - Deprecate when superseded
    
    ### Don'ts
    
    - **Don't change accepted ADRs** - Write new ones to supersede
    - **Don't skip context** - Future readers need background
    - **Don't hide failures** - Rejected decisions are valuable
    - **Don't be vague** - Specific decisions, specific consequences
    - **Don't forget implementation** - ADR without action is waste
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.