agentleFS
Sign inStart free
nishant-tamilselvannishant-tamilselvan/AEGIS/.github/skills/adr-management/SKILL.md

adr-management

Skill1 starsChanged 48 days agoMITView on GitHub

Create, index and validate Architecture Decision Records (ADRs) in each application''s docs/artifacts/<app-name>/architecture-decisions/ folder. Use when recording a significant architecture or implementation-discovered material choice, superseding an earlier decision, or validating the ADR index.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    After any change, validate and resolve all errors before ending the phase.

    line 30
  2. Distinctive:

    Every record has a row in the index, and ids are unique.

    line 79

≈ “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

ADR Management

Authoritative procedure for recording architectural decisions. Only the adr-author agent should run these commands; specialists propose the decision and its alternatives.

When to use

  • A specialist chose between real alternatives for a hard-to-reverse concern.
  • An earlier decision is being replaced (supersede it — never edit it in place).
  • Validating the ADR folder and index before closing the architecture phase.
  • Implementation discovers a hard-to-reverse, cross-component, security/risk, contract or scope choice that cannot remain a tactical IDEC-* record.

Ground rules

  1. One decision per record. Records are immutable except status transitions and back-links. Never renumber or delete.
  2. IDs are ADR-NNNN (zero-padded four digits) and match the file number. ADR-0001 is the seed "record architecture decisions" template. Numbering is per application.
  3. ADRs live in the active application's folder: docs/artifacts/<app-name>/architecture-decisions/. The <app-name> is provided by the orchestrator. Never target the bare docs/artifacts root.
  4. Frontmatter follows ../artifact-management/references/artifact-schema.md.
  5. After any change, validate and resolve all errors before ending the phase.

Procedure

1. Initialise (first time only)

Replace <app> with the active application folder (e.g. customer-portal).

python -m artifact_tools adr init docs/artifacts/<app>/architecture-decisions

Creates the folder, the README.md index, and the seed 0001-adr-template.md. adr new also initialises the folder automatically if it is missing.

2. Record a decision

python -m artifact_tools adr new "Event-driven topology" docs/artifacts/<app>/architecture-decisions \
  --status accepted --component "Core Topology"

The tool auto-numbers the record, fills the Nygard/MADR template, and appends the row to the index. Then edit the record to complete Context, Decision Drivers, Considered Alternatives, Decision and Consequences, referencing the driving FR-* / NFR-* / BP-*.

3. Supersede an earlier decision

python -m artifact_tools adr new "Migrate catalogue to PostgreSQL" docs/artifacts/<app>/architecture-decisions --supersedes ADR-0003

This creates the new record, flips ADR-0003 to superseded, sets its superseded_by back-link, and updates the index status.

4. Validate (always)

python -m artifact_tools validate docs/artifacts/<app>

ADR validation runs as part of the artifact validation.

What validation checks

  • Each record's frontmatter is present and its id matches the filename number.
  • status is one of proposed, accepted, rejected, deprecated, superseded.
  • superseded records name a superseded_by id, and supersedes / superseded_by point to real ADRs.
  • Every record has a row in the index, and ids are unique.

Resources

  • Templates: ../artifact-management/assets/templates/adr.template.md, ../artifact-management/assets/templates/architecture-decisions-index.template.md
  • Schema: ../artifact-management/references/artifact-schema.md
  • ID conventions: ../artifact-management/references/id-conventions.md

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.

Check your setup, free