agentleFS
brpazbrpaz/agent-skills/skills/adr-writer/SKILL.md

adr-writer

Skill1 starsChanged 6 months agoMITView on GitHub

Capture major technical decisions in an architecture decision record (ADR)

We split this skill into the rules it gives an agent

10 rules. 0 are common, 9 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 10 edited versions we read keep these.

  • 9

    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:

    Use this skill when the project needs a durable record of a major technical decision.

    line 10
  2. Distinctive:

    Use an ADR for decisions that are broader than one code change and likely to matter again later.

    line 23
  3. Very specific:

    Write ADRs to adr_directory.

    line 44
  4. Distinctive:

    If ADRs already exist, continue the numbering.

    line 52
  5. Distinctive:

    keep it concise and durable

    line 85
  6. Distinctive:

    prefer one ADR per major decision

    line 89
  7. Distinctive:

    update status if a proposed decision later becomes accepted, superseded, or rejected

    line 90
  8. Distinctive:

    read the related canonical PRD artifact, design doc, issue, plan, and any existing ADRs first

    line 94
  9. Distinctive:

    avoid duplicating an existing ADR

    line 95
  10. Distinctive:

    if a prior ADR is being changed, create a new ADR that supersedes it unless a minor edit is enough

    line 96

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

ADR Writer

Use this skill when the project needs a durable record of a major technical decision.

When to Use

  • A significant architectural or technology choice is being made
  • A decision spans multiple code changes or will matter to future contributors
  • You need to document rejected alternatives and their tradeoffs
  • An existing ADR needs to be superseded with a new decision

Purpose

Capture important technical decisions in adr_directory so future implementation work can understand the context, tradeoffs, and consequences.

Use an ADR for decisions that are broader than one code change and likely to matter again later.

Good ADR Candidates

  • architecture or subsystem boundaries
  • database or persistence strategy
  • authentication or authorization approach
  • external integration strategy
  • deployment or infrastructure pattern
  • major shared abstractions
  • consequential performance or reliability tradeoffs

Avoid

  • routine implementation details
  • temporary coding tactics
  • decisions that only affect one tiny local change
  • rewriting history to make a decision look cleaner than it was

Output Location

Write ADRs to adr_directory.

File name format:

<adr_directory>/0001-short-kebab-title.md

If ADRs already exist, continue the numbering.

ADR Template

# ADR 0001: Short Title

## Status
Proposed

## Context
What problem or pressure led to this decision?

## Decision
What are we deciding?

## Alternatives Considered
- Option A
- Option B

## Consequences
- Positive consequence
- Negative consequence
- Follow-up consequence

## Related Artifacts
- canonical PRD artifact
- related design doc, if any
- GitHub issue or PR

Writing Rules

  • keep it concise and durable
  • explain why, not just what
  • name the rejected alternatives when they matter
  • record tradeoffs honestly
  • prefer one ADR per major decision
  • update status if a proposed decision later becomes accepted, superseded, or rejected

Workflow Guidance

  • read the related canonical PRD artifact, design doc, issue, plan, and any existing ADRs first
  • avoid duplicating an existing ADR
  • if a prior ADR is being changed, create a new ADR that supersedes it unless a minor edit is enough
  • reference the ADR from the relevant issue or plan when appropriate

Inputs

  • adr_directory – target directory path for ADR files. If not provided, defaults to docs/adr.
  • Description of the decision to record, including context, alternatives considered, and consequences

Outputs

  • A new numbered Markdown ADR file in adr_directory following the template format (e.g. 0001-short-kebab-title.md)

Examples

# Decision: use PostgreSQL instead of SQLite
adr_directory: docs/adr

Produces docs/adr/0001-use-postgresql.md with Status, Context, Decision, Alternatives, and Consequences sections.

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.