agentleFS
Sign inStart free
witi-projectswiti-projects/Skills/architecture-decision-records/SKILL.md

architecture-decision-records

Skill2 starsChanged 6 months agoMITView on GitHub

Document technical decisions as Architecture Decision Records (ADRs) with context, options considered, and rationale. Use when the user says "/architecture-decision-records", "architecture decision records", or asks about architecture decision records.

We split this skill into the rules it gives an agent

5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 58 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Document significant technical decisions so future you (and your team) understands why choices were made.

    line 9
  2. Distinctive:

    Write one when you're making a decision that:

    line 13
  3. Very specific:

    Create files in docs/decisions/ (or adr/) with sequential numbering:

    line 23
  4. Distinctive:

    Keep ADRs short — 1-2 pages max

    line 91
  5. Distinctive:

    Write them in the present tense ("We choose X" not "We chose X")

    line 92

“Common” is measured: kept by at least 6 in 10 of the 58 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Architecture Decision Records

Document significant technical decisions so future you (and your team) understands why choices were made.

When to Write an ADR

Write one when you're making a decision that:

  • Is hard to reverse later
  • Affects multiple parts of the system
  • Involves tradeoffs between valid options
  • Will be questioned by someone in 6 months

Examples: choosing a database, adopting a framework, changing auth strategy, restructuring the API, adding a build tool.

Template

Create files in docs/decisions/ (or adr/) with sequential numbering:

# ADR-001: Use PostgreSQL for primary database

## Status

Accepted | Proposed | Deprecated | Superseded by ADR-XXX

## Date

2026-04-10

## Context

What is the problem or situation that requires a decision?
Include constraints, requirements, and forces at play.

## Options Considered

### Option A: PostgreSQL
- Pros: ACID compliance, JSON support, mature ecosystem, free
- Cons: Requires managing connections, vertical scaling limits

### Option B: MongoDB
- Pros: Flexible schema, horizontal scaling
- Cons: No transactions across collections, eventual consistency issues

### Option C: PlanetScale (MySQL)
- Pros: Serverless, branching, managed
- Cons: Vendor lock-in, no foreign keys in their branching model

## Decision

We chose **PostgreSQL** because:
1. Our data is relational — users, teams, projects with clear relationships
2. We need ACID transactions for billing operations
3. JSON columns give us schema flexibility where needed
4. Prisma/Drizzle have excellent Postgres support

## Consequences

- We need to manage connection pooling (use PgBouncer or Prisma's built-in pool)
- Migrations must be backwards-compatible for zero-downtime deploys
- We accept vertical scaling limits and will shard later if needed

Workflow

  1. Identify the decision being made
  2. Research the options (at least 2-3 alternatives)
  3. Write the ADR using the template
  4. Review with the team (PR or discussion)
  5. Merge as accepted
  6. Reference from code comments when relevant: // See ADR-001

File Naming

docs/decisions/
├── 001-use-postgresql.md
├── 002-adopt-trpc-over-rest.md
├── 003-switch-to-pnpm.md
└── template.md

Tips

  • Keep ADRs short — 1-2 pages max
  • Write them in the present tense ("We choose X" not "We chose X")
  • It's OK to write an ADR after the fact if you forgot to write one during the decision
  • Superseded ADRs should link to their replacement, not be deleted
  • ADRs are not design docs — they capture the decision, not the full design

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free