agentleFS
augments-labsaugments-labs/sdlc-skills/skills/design/architecture-decisions/SKILL.md

architecture-decisions

Skill1 starsChanged 3 months agoMITView on GitHub

Records a significant, hard-to-reverse technical decision and the options weighed. Use when a choice such as a datastore, sync versus async, a framework, a public contract, or an auth or security model is being weighed or has just been settled, when the user asks whether to use X or Y, when a choice is made in passing during discussion, or when an old decision is revisited. Skip easily reversible choices.

6 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Skip: when any of the three is missing.

    line 15
  2. Very specific:

    Read references/adr-example.md when the first draft is written and needs comparing against a filled example.

    line 21
  3. Very specific:

    If the choice is irreversible (Step 1.5's reversal row says undo is impossible or unaffordable, not merely costly) and a dispatch action …

    line 48
  4. Very specific:

    Ask this and end the turn.

    line 85

“Common” is measured: kept by at least 6 in 10 of the 4 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 Decisions

When to use

  • Record a decision only when all three hold: it is hard to reverse, it would be surprising without the reasons behind it, and there were genuine trade-offs between real options. A datastore, a sync/async boundary, a framework, a public contract, or a security model is such a decision.
  • Skip when any of the three is missing. A reversible, obvious, or inevitable choice is noise as an ADR.

Step 1: Draft the ADR

Open assets/adr-template.md before Step 1's actions; it owns the fields. Read references/adr-example.md when the first draft is written and needs comparing against a filled example.

  1. State the question, the artifact or system the decision covers, the forces bearing on it, and who decides: one accountable decision owner, or the approvers with a rule for settling a conflict.
  2. Weigh at least two real options. For each, record what it assumes, where it breaks, what would rule it out, what reversing it would cost, and the evidence. Wherever keeping things as they are, or deferring the decision, is viable, weigh that too; where it is not, record the evidence that says so.
  3. Give every assumption a stable ID and a way to be proved wrong.
  4. Record the proposed choice and each rejected alternative. Keep the rejections; never edit them away.
  5. Record the consequences and the reversal path: what the choice commits you to, what it means for data and migrations, how to undo it, and what it closes off.

Step 2: Persist, then challenge

  1. Append the ADR, with status proposed, to .sdlc-skills/designs/{{YYYY-MM-DD}}-{{topic}}.md or the user-set path, keeping what is already in the file. The ADR is immutable: never edit it after this. Compute its identity now, by the rule the template names (the artifact layout's section rule in using-sdlc-skills: the first 7 characters of git hash-object over the ADR's own section); the challenge binds to this path and this identity.
  2. If the choice is irreversible (Step 1.5's reversal row says undo is impossible or unaffordable, not merely costly) and a dispatch action exists, fill assets/adr-challenger.md with that path and identity before dispatching it. Dispatch it as dispatching-parallel-agents Step 2 says, to a reviewer other than the sole author. That reviewer challenges the options, the assumptions, the consequences, and the reversal under the template's challenge contract.

    Otherwise, write the strongest counter-case yourself, against that same contract, and label it self-challenge. When the dispatch action is not callable, write it only if the user chooses option 1 at the dispatching-parallel-agents Step 2 question. A self-challenge never issues the verdict clear, so the risk it leaves open goes to the decision owner in Step 3.

    Approval waits for clear on this ADR identity, or for the decision owner accepting a labelled self-challenge. Skip both the dispatched challenge and the self-challenge only when a current independent design review covers this exact ADR identity.

Step 3: Present and track

  1. Present:

    ADR {{identity (per template)}}: {{question}}
    Proposed: {{choice}} — {{rationale, one line}}
    Rejected: {{alternatives}}  Reversal cost: {{one line}}
    
    1. Accept
    2. Reject in favor of {{other option}}
    3. Request changes
    4. Cancel
    
    Recommendation: {{option the recorded trade-offs support}} — {{one sentence}}.

    Ask this and end the turn; clarifying-intent owns what closes it.

  2. Track the decision and its conformance (evidence that the accepted choice is implemented, as the ADR's conformance contract requires) as two separate things. Acceptance puts nothing in force; conformance does. Retirement needs an action by the owner and the absence of the surface the ADR governs. If there is a contradiction, reopen every affected owner.
  3. Return the recorded outcome to the skill that invoked this one.

Gotchas

  • An assumption's "way to be proved wrong" (Step 1) can succeed after the ADR is accepted. The ADR itself is immutable and append-only (Step 2), so a disproven assumption is never fixed by editing the original. It needs a new ADR that supersedes the old one, the same way a rejected alternative is kept rather than removed.
  • Step 2's reviewer-skip condition requires a current review of this exact ADR identity. A design review that covered an earlier draft, before an option was reweighed or an assumption added, no longer satisfies either word, even though it can feel like "we already reviewed this."

Common mistakes

  • Treating "the code now does this" as owner approval or conformance proof.

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.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

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.