MR
Mayur Rathi
@mayurrathi
⭐ 40.7k GitHub stars

Architecture Decision Records

Architecture Decision Records is an learning AI skill with a core value of Write and maintain Architecture Decision Records (ADRs) following best practices for technical decision documentation. It helps developers solve real-world problems in the learning domain, boosting efficiency, automating repetitive tasks, and optimizing workflows.

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

Last verified on: 2026-07-07

Quick Facts

Category learning
Works With Claude
Source sickn33/antigravity-awesome-skills
Stars ⭐ 40.7k
Last Verified 2026-07-07
Risk Level Low
mkdir -p ./skills/architecture-decision-records && curl -sfL https://raw.githubusercontent.com/sickn33/antigravity-awesome-skills/main/skills/architecture-decision-records/SKILL.md -o ./skills/architecture-decision-records/SKILL.md

Run in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).

Skill Content

# Architecture Decision Records


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


Use this skill when


- Making significant architectural decisions

- Documenting technology choices

- Recording design trade-offs

- Onboarding new team members

- Reviewing historical decisions

- Establishing decision-making processes


Do not use this skill when


- You only need to document small implementation details

- The change is a minor patch or routine maintenance

- There is no architectural decision to capture


Instructions


1. Capture the decision context, constraints, and drivers.

2. Document considered options with tradeoffs.

3. Record the decision, rationale, and consequences.

4. Link related ADRs and update status over time.


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


text
Proposed → Accepted → Deprecated → Superseded
              ↓
           Rejected

Templates


Template 1: Standard ADR (MADR Format)


markdown
# ADR-0001: Use PostgreSQL as Primary Database

## Status

Accepted

## Context

We need to select a primary database for our new e-commerce platform. The system
will handle:
- ~10,000 concurrent users
- Complex product catalog with hierarchical categories
- Transaction processing for orders and payments
- Full-text search for products
- Geospatial queries for store locator

The team has experience with MySQL, PostgreSQL, and MongoDB. We need ACID
compliance for financial transactions.

## Decision Drivers

* **Must have ACID compliance** for payment processing
* **Must support complex queries** for reporting
* **Should support full-text search** to reduce infrastructure complexity
* **Should have good JSON support** for flexible product attributes
* **Team familiarity** reduces onboarding time

## Considered Options

### Option 1: PostgreSQL
- **Pros**: ACID compliant, excellent JSON support (JSONB), built-in full-text
  search, PostGIS for geospatial, team has experience
- **Cons**: Slightly more complex replication setup than MySQL

### Option 2: MySQL
- **Pros**: Very familiar to team, simple replication, large community
- **Cons**: Weaker JSON support, no built-in full-text search (need
  Elasticsearch), no geospatial without extensions

### Option 3: MongoDB
- **Pros**: Flexible schema, native JSON, horizontal scaling
- **Cons**: No ACID for multi-document transactions (at decision time),
  team has limited experience, requires schema design discipline

## Decision

We will use **PostgreSQL 15** as our primary database.

## Rationale

PostgreSQL provides the best balance of:
1. **ACID compliance** essential for e-commerce transactions
2. **Built-in capabilities** (full-text search, JSONB, PostGIS) reduce
   infrastructure complexity
3. **Team familiarity** with SQL databases reduces learning curve
4. **Mature ecosystem** with excellent tooling and community support

The slight complexity in replication is outweighed by the reduction in
additional services (no separate Elasticsearch needed).

## Consequences

### Positive
- Single database handles transactions, search, and geospatial queries
- Reduced operational complexity (fewer services to manage)
- Strong consistency guarantees for financial data
- Team can leverage existing SQL expertise

### Negative
- Need to learn PostgreSQL-specific features (JSONB, full-text search syntax)
- Vertical scaling limits may require r

🎯 Best For

  • Engineering teams doing code reviews
  • Open source maintainers
  • Technical writers
  • API documentation teams
  • Claude users

💡 Use Cases

  • Reviewing pull requests for security vulnerabilities
  • Checking code style consistency
  • Generating JSDoc/TSDoc comments
  • Writing README files for new projects

📖 How to Use This Skill

  1. 1

    Install the Skill

    Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.

  2. 2

    Load into Your AI Assistant

    Open Claude and reference the skill. Paste the SKILL.md content or use the system prompt tab.

  3. 3

    Apply Architecture Decision Records to Your Work

    Provide context for your task — paste source material, describe your audience, or share existing work to guide the AI.

  4. 4

    Review and Refine

    Edit the AI output for accuracy, tone, and completeness. Add human insight where the AI lacks context.

❓ Frequently Asked Questions

Does this skill check for OWASP Top 10?

Security-focused review skills often include OWASP checks. Check the skill content for specific vulnerability categories covered.

Does it follow my documentation style?

Most documentation skills respect existing style. Provide a style guide or example in your prompt.

How do I install Architecture Decision Records?

Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/architecture-decision-records/SKILL.md, ready to use.

Can I customize this skill for my team?

Absolutely. Edit the SKILL.md file to add team-specific instructions, examples, or workflows.

⚠️ Common Mistakes to Avoid

Blindly accepting AI suggestions

Always verify AI-generated review comments. Some suggestions may not apply to your specific codebase conventions.

Auto-generating without reviewing

AI documentation can contain inaccuracies. Always verify technical accuracy.

Not reading the full skill

Skills contain important context and edge cases beyond the quick start.

🔗 Related Skills