agentleFS
yu-iskwyu-iskw/coding-agent-fabric/.claude/skills/manage-adr/SKILL.md

manage-adr

Skill1 starsChanged 9 months agoApache-2.0View on GitHub

Manage Architecture Decision Records (ADRs). Use this to initialize, create, list, and link ADRs to document architectural evolution. Requires 'adr-tools' to be installed.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. About 0 are common, 9 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When making a significant architectural change.

    line 12
  2. Distinctive:

    When choosing between multiple technical approaches.

    line 13
  3. Distinctive:

    When standardizing a pattern across the codebase.

    line 14
  4. Very specific:

    When you want to understand previous design decisions (use list).

    line 15
  5. Distinctive:

    If ADRs are not yet initialized in the project, run:

    line 21
  6. Distinctive:

    After creation, the script will output the filename.

    line 37
  7. Very specific:

    If a new decision replaces an old one, use the -s flag:

    line 41
  8. Very specific:

    Read a specific ADR: read_file docs/adr/NNNN-title.md

    line 58
  9. Distinctive:

    Keep ADRs focused on a single decision.

    line 67
  10. Distinctive:

    Write for future maintainers who lack current context.

    line 68
  11. Distinctive:

    Update the status and links when decisions change.

    line 69
  12. Very specific:

    Use the template in assets/template.md as a guide.

    line 71
  13. Distinctive:

    If needed, draw a system diagram, sequence diagram(s) and other diagrams with Mermaid.

    line 73

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Manage Architecture Decision Records (ADRs)

Architecture Decision Records (ADRs) are a lightweight way to document the "why" behind significant technical choices.

When to Use

  • When making a significant architectural change.
  • When choosing between multiple technical approaches.
  • When standardizing a pattern across the codebase.
  • When you want to understand previous design decisions (use list).

Instructions

1. Initialization

If ADRs are not yet initialized in the project, run:

adr init docs/adr

This ensures records are created in docs/adr.

2. Creating a New ADR

To create a new ADR, use the provided script to ensure non-interactive creation:

.claude/skills/manage-adr/scripts/create-adr.sh "Title of the ADR"

After creation, the script will output the filename. You MUST then edit the file to fill in the Context, Decision, and Consequences.

3. Superseding an ADR

If a new decision replaces an old one, use the -s flag:

.claude/skills/manage-adr/scripts/create-adr.sh -s <old-adr-number> "New Decision Title"

4. Linking ADRs

To link two existing ADRs (e.g., ADR 12 amends ADR 10):

adr link 12 Amends 10 "Amended by"

5. Listing and Viewing

  • List all ADRs: adr list
  • Read a specific ADR: read_file docs/adr/NNNN-title.md

6. Generating Reports

  • Generate a Table of Contents: adr generate toc
  • Generate a dependency graph (requires Graphviz): adr generate graph | dot -Tpng -o adr-graph.png

Best Practices

  • Keep ADRs focused on a single decision.
  • Write for future maintainers who lack current context.
  • Update the status and links when decisions change.
  • Refer to references/adr-concepts.md for more details on the ADR philosophy.
  • Use the template in assets/template.md as a guide.
  • Draw a diagram with Mermaid to visualize the decision.
  • If needed, draw a system diagram, sequence diagram(s) and other diagrams with Mermaid.

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.