Claude Skill

adr-authoring

Write, review, and maintain architecture decision records with clear context, alternatives, consequences, confirmation links, and lifecycle governance. Use when a consequential technical decision or its enforceable architectural constraint must remain understandable. Do not use f

LLM Mart · 0 points · 15 views 76 listing impressions 0 install-command copies
Download magnus919-agent-skills-adr-authoring-addad86.zip · 31 KB

Install

skills CLI npx skills add https://github.com/magnus919/agent-skills/tree/main/adr-authoring
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install magnus919-agent-skills@llmmart
Git git clone https://github.com/magnus919/agent-skills.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole magnus919/agent-skills collection as a plugin from our marketplace. Git is the plain clone.

README

Adr Authoring

Preserve the reasoning behind consequential architecture choices so later contributors can understand, revisit, or supersede them responsibly.

Why Install This Skill

Architecture decisions are hard to revisit when records hide the rejected alternatives or confuse approval with delivery. This skill captures the reasoning, costs, and scope so future contributors can understand what was actually decided.

It follows your repository's existing template, folder layout, and amendment policy. Proposals, approved experiments, production decisions, and implementation evidence remain distinct, with links to the checks that support each claim.

What You Get

Path What it provides
SKILL.md Repository conventions, decision scope, lifecycle, and evidence rules.
evals/ Cases covering local conventions, experiment approval, lifecycle, and evidence quality.
references/ Reference material for ADR formats, lifecycle, sustainability, fitness-function design, and provenance.
templates/fitness-function-record.md Fillable record connecting an ADR decision to a check and observed evidence.

Quick Start

Ask: “Draft an ADR for this decision using our repository conventions. Separate the approved scope from implementation evidence.” The result follows your existing decision log and identifies any unresolved approval or validation gaps.

Triggers

  • Write, review, and maintain architecture decision records with clear context, alternatives, consequences, confirmation links, and lifecycle governance. Use when a consequential technical decision or its enforceable architectural constraint must remain understandable.
  • Define or review a fitness function's scope, cadence, evidence, threshold, ownership, exception handling, gaming resistance, review, or retirement.
  • Do not use for system-wide evolutionary architecture design, general observability, or operating a named test or CI tool.
  • Requests involving the method, deliverables, or review process described in SKILL.md.
  • Work where a reusable template or reference from this skill would reduce avoidable mistakes.

Requirements

No runtime dependency.

Source and maintenance

This skill was extracted from magnus919/hermes-profiles at commit 867a555. The portable methodology was retained; Hermes-specific profile, orchestration, and memory assumptions were removed.

Skill manifest

ADR Authoring

Architecture Decision Records for capturing design rationale. ADRs supply the temporal dimension — decisions over time — that structure-only views (C4) miss.

Start with Repository Conventions

  1. Read the repository's agent instructions, contributing guide, ADR index, template, and a few recent records before drafting. Reuse the established location, numbering, headings, status vocabulary, approval process, and amendment policy.
  2. Treat this skill's layouts and templates as fallbacks only. Do not move, renumber, rename, or rewrite existing ADRs to fit the skill. If local conventions conflict, preserve the existing records and identify the specific conflict before changing the convention.
  3. If no convention exists, use a flat docs/adr/ directory, stable sequential identifiers, a small index, and a lightweight Nygard template (MADR when option analysis needs more structure). Read references/project-setup-guide.md only when establishing a new decision log.
  4. Read references/adr-to-pyramid-mapping.md only if the project already uses artifact pyramids or the user requests that organization. Index links can provide layered navigation without relocating canonical records.

Decision, Approval, and Evidence

Keep these three facts distinct, using the repository's existing fields or linked records:

  • Proposal: What is recommended, why, alternatives, consequences, and unresolved questions. A draft or recommendation is not an accepted decision.
  • Decision authority and scope: Who approved what, when, and for which environment or stage. Approval to experiment permits the bounded experiment; it does not establish production adoption. An accepted ADR may authorize only an experiment if that scope is explicit. Do not invent a decider, date, or broader approval.
  • Implementation evidence: Links to changes, checks, observed results, and remaining gaps. Acceptance does not prove implementation; passing a prototype check does not prove production readiness. Label a validation plan as planned until results exist.

For example, “approved an isolated database trial” supports a trial-scoped decision. A successful restore rehearsal is evidence for the tested recovery scenario; neither fact alone means “database adopted in production.”

ADR Lifecycle

Use the local lifecycle and amendment rules. When absent, use proposed → accepted | rejected, with accepted decisions later deprecated or superseded by a linked successor.

Preserve accepted rationale. By default, a changed decision gets a new ADR; update the old record's status and successor link while retaining its identifier and location. If the repository uses living documents, make dated, attributable amendments under its policy. Do not impose mutability on an immutable log or replace a living-document process with an immutable one.

Record rejection and supersession reasons, maintain the index, and preserve links. Review format and meeting length follow the team's process; acceptance requires evidence of the relevant decision authority, not a mandatory ceremony.

Template Selection

Use the repository template first. This table applies only when no template is established.

When Template Sections
Quick decision, single rationale Nygard Status, Context, Decision, Consequences
Multi-option trade-off analysis MADR Decision Drivers, Considered Options, Pros/Cons, Links
High-stakes, regulatory, compliance Tyree & Akerman 12 sections: Issue, Positions, Argument, Implications, etc.
Vendor/procurement decision Business Case Evaluation criteria, Cost/SWOT, Recommendations
QA/contract-driven environment Planguage Tag, Gist, Priority, Stakeholders, Risks

Full catalog with section-by-section guidance in references/adr-format.md.

File Naming Conventions

Follow local naming first. For a new log, use present tense imperative verb phrases, lowercase-dashes, .md extension:

001-choose-database.md
002-format-timestamps.md
003-manage-secrets.md

Status lives in the document header, not the filename — status changes shouldn't require renames.

Teamwork & Governance

  • Who can create: Any team member who has read the ADR process docs
  • What justifies: Decisions affecting future "why", cross-team coordination, long-term maintainability, external interfaces
  • What usually does NOT: Routine changes already covered by standards. Record a bounded experiment when its authorization, constraints, or consequences need durable rationale.
  • Roles per ADR: Primary contact, secondary contact, accountable team
  • Amendments: Follow repository policy; preserve decision history and distinguish new evidence from a changed decision.

See references/adr-format.md for the full governance model and teamwork questions.

Fitness-Function Confirmation

Applicability: Use when an ADR makes a claim that can be checked through code, configuration, runtime telemetry, a scheduled audit, or a bounded human review.

Read references/fitness-functions.md to select the function's scope, cadence, evidence, threshold, owner, exception path, and retirement rule. Use templates/fitness-function-record.md for the operational record. Keep the ADR as the owner of the durable decision and its link to confirmation; keep implementation and execution in the project's test, CI, telemetry, or governance systems.

Completion and Boundaries

Complete when the requested ADR or review follows local conventions, identifies decision scope and authority without invention, preserves history, and distinguishes observed evidence from planned checks. If acceptance is unresolved, deliver a proposed record and name the missing decision rather than claiming acceptance.

When not to use

Route system-wide architecture and change sequencing to software-architecture, and named-tool implementation to the relevant operational skill. This skill owns decision rationale and confirmation links, not execution of the implementation or a general observability program.

Contents

  • references/adr-format.md — template catalog (11 formats: Nygard, MADR, Tyree & Akerman, Business Case, Planguage, Alexandrian, ITD, arc42, EdgeX, Gareth Morgan, NHS Wales), template selection decision tree, lifecycle stages, file naming, team governance, examples reference
  • references/adr-to-pyramid-mapping.md — active→L2, superseded→L3, consumer routing
  • references/fitness-functions.md — method for selecting, operating, interpreting, reviewing, and retiring checks that connect ADR claims to durable evidence
  • references/decision-sustainability.md — 5 sustainability criteria + 8 guidelines for evaluating ADR quality before acceptance
  • references/project-setup-guide.md — bootstrapping ADRs in a new project: directory setup, README index, CONTRIBUTING.md/AGENTS.md docs, issue-first PR workflow with worked example
  • templates/fitness-function-record.md — reusable record for selecting, operating, reviewing, and retiring a fitness function
  • references/source-index.md — provenance and synthesis boundary for this skill

Canonical Reference

Portability

This skill is intentionally host-neutral. Use your agent's normal mechanisms to load the references, templates, and scripts listed here. Do not assume a particular profile system, task orchestrator, memory service, or response-handoff format.

Files (agent-skills)
  • evals
    • evals.json 14.6 KB
      Loading…
  • references
    • adr-format.md 21.7 KB
      Loading…
    • adr-to-pyramid-mapping.md 1.4 KB
      Loading…
    • decision-sustainability.md 7.5 KB
      Loading…
    • fitness-functions.md 9.6 KB
      Loading…
    • project-setup-guide.md 4.8 KB
      Loading…
    • source-index.md 1.2 KB
      Loading…
  • templates
    • fitness-function-record.md 3 KB
      Loading…
  • README.md 2.5 KB
    # Adr Authoring
    
    Preserve the reasoning behind consequential architecture choices so later contributors can understand, revisit, or supersede them responsibly.
    
    ## Why Install This Skill
    
    Architecture decisions are hard to revisit when records hide the rejected alternatives or confuse approval with delivery. This skill captures the reasoning, costs, and scope so future contributors can understand what was actually decided.
    
    It follows your repository's existing template, folder layout, and amendment policy. Proposals, approved experiments, production decisions, and implementation evidence remain distinct, with links to the checks that support each claim.
    
    ## What You Get
    
    | Path | What it provides |
    |---|---|
    | `SKILL.md` | Repository conventions, decision scope, lifecycle, and evidence rules. |
    | `evals/` | Cases covering local conventions, experiment approval, lifecycle, and evidence quality. |
    | `references/` | Reference material for ADR formats, lifecycle, sustainability, fitness-function design, and provenance. |
    | `templates/fitness-function-record.md` | Fillable record connecting an ADR decision to a check and observed evidence. |
    
    ## Quick Start
    
    Ask: “Draft an ADR for this decision using our repository conventions. Separate the approved scope from implementation evidence.” The result follows your existing decision log and identifies any unresolved approval or validation gaps.
    
    ## Triggers
    
    - Write, review, and maintain architecture decision records with clear context, alternatives, consequences, confirmation links, and lifecycle governance. Use when a consequential technical decision or its enforceable architectural constraint must remain understandable.
    - Define or review a fitness function's scope, cadence, evidence, threshold, ownership, exception handling, gaming resistance, review, or retirement.
    - Do not use for system-wide evolutionary architecture design, general observability, or operating a named test or CI tool.
    - Requests involving the method, deliverables, or review process described in `SKILL.md`.
    - Work where a reusable template or reference from this skill would reduce avoidable mistakes.
    
    ## Requirements
    
    No runtime dependency.
    
    ## Source and maintenance
    
    This skill was extracted from [`magnus919/hermes-profiles`](https://github.com/magnus919/hermes-profiles) at commit [`867a555`](https://github.com/magnus919/hermes-profiles/commit/867a555). The portable methodology was retained; Hermes-specific profile, orchestration, and memory assumptions were removed.
    
  • SKILL.md 8.2 KB
    ---
    name: adr-authoring
    description: Write, review, and maintain architecture decision records with clear context, alternatives, consequences, confirmation links, and lifecycle governance. Use when a consequential technical decision or its enforceable architectural constraint must remain understandable. Do not use for system-wide evolutionary architecture design, general observability, or operating a named test or CI tool.
    license: MIT
    compatibility: No runtime dependency.
    metadata:
      source_repo: https://github.com/magnus919/hermes-profiles
      source_commit: 867a555
    ---
    
    
    # ADR Authoring
    
    Architecture Decision Records for capturing design rationale. ADRs supply the temporal dimension — decisions over time — that structure-only views (C4) miss.
    
    ## Start with Repository Conventions
    
    1. Read the repository's agent instructions, contributing guide, ADR index, template, and a few recent records before drafting. Reuse the established location, numbering, headings, status vocabulary, approval process, and amendment policy.
    2. Treat this skill's layouts and templates as fallbacks only. Do not move, renumber, rename, or rewrite existing ADRs to fit the skill. If local conventions conflict, preserve the existing records and identify the specific conflict before changing the convention.
    3. If no convention exists, use a flat `docs/adr/` directory, stable sequential identifiers, a small index, and a lightweight Nygard template (MADR when option analysis needs more structure). Read `references/project-setup-guide.md` only when establishing a new decision log.
    4. Read `references/adr-to-pyramid-mapping.md` only if the project already uses artifact pyramids or the user requests that organization. Index links can provide layered navigation without relocating canonical records.
    
    ## Decision, Approval, and Evidence
    
    Keep these three facts distinct, using the repository's existing fields or linked records:
    
    - **Proposal:** What is recommended, why, alternatives, consequences, and unresolved questions. A draft or recommendation is not an accepted decision.
    - **Decision authority and scope:** Who approved what, when, and for which environment or stage. Approval to experiment permits the bounded experiment; it does not establish production adoption. An accepted ADR may authorize only an experiment if that scope is explicit. Do not invent a decider, date, or broader approval.
    - **Implementation evidence:** Links to changes, checks, observed results, and remaining gaps. Acceptance does not prove implementation; passing a prototype check does not prove production readiness. Label a validation plan as planned until results exist.
    
    For example, “approved an isolated database trial” supports a trial-scoped decision. A successful restore rehearsal is evidence for the tested recovery scenario; neither fact alone means “database adopted in production.”
    
    ## ADR Lifecycle
    
    Use the local lifecycle and amendment rules. When absent, use `proposed → accepted | rejected`, with accepted decisions later `deprecated` or `superseded` by a linked successor.
    
    Preserve accepted rationale. By default, a changed decision gets a new ADR; update the old record's status and successor link while retaining its identifier and location. If the repository uses living documents, make dated, attributable amendments under its policy. Do not impose mutability on an immutable log or replace a living-document process with an immutable one.
    
    Record rejection and supersession reasons, maintain the index, and preserve links. Review format and meeting length follow the team's process; acceptance requires evidence of the relevant decision authority, not a mandatory ceremony.
    
    ## Template Selection
    
    Use the repository template first. This table applies only when no template is established.
    
    | When | Template | Sections |
    |------|----------|----------|
    | Quick decision, single rationale | **Nygard** | Status, Context, Decision, Consequences |
    | Multi-option trade-off analysis | **MADR** | Decision Drivers, Considered Options, Pros/Cons, Links |
    | High-stakes, regulatory, compliance | **Tyree & Akerman** | 12 sections: Issue, Positions, Argument, Implications, etc. |
    | Vendor/procurement decision | **Business Case** | Evaluation criteria, Cost/SWOT, Recommendations |
    | QA/contract-driven environment | **Planguage** | Tag, Gist, Priority, Stakeholders, Risks |
    
    Full catalog with section-by-section guidance in `references/adr-format.md`.
    
    ## File Naming Conventions
    
    Follow local naming first. For a new log, use present tense imperative verb phrases, lowercase-dashes, `.md` extension:
    
    ```
    001-choose-database.md
    002-format-timestamps.md
    003-manage-secrets.md
    ```
    
    Status lives in the document header, not the filename — status changes shouldn't require renames.
    
    ## Teamwork & Governance
    
    - **Who can create:** Any team member who has read the ADR process docs
    - **What justifies:** Decisions affecting future "why", cross-team coordination, long-term maintainability, external interfaces
    - **What usually does NOT:** Routine changes already covered by standards. Record a bounded experiment when its authorization, constraints, or consequences need durable rationale.
    - **Roles per ADR:** Primary contact, secondary contact, accountable team
    - **Amendments:** Follow repository policy; preserve decision history and distinguish new evidence from a changed decision.
    
    See `references/adr-format.md` for the full governance model and teamwork questions.
    
    ## Fitness-Function Confirmation
    
    **Applicability:** Use when an ADR makes a claim that can be checked through code, configuration, runtime telemetry, a scheduled audit, or a bounded human review.
    
    Read `references/fitness-functions.md` to select the function's scope, cadence, evidence, threshold, owner, exception path, and retirement rule. Use `templates/fitness-function-record.md` for the operational record. Keep the ADR as the owner of the durable decision and its link to confirmation; keep implementation and execution in the project's test, CI, telemetry, or governance systems.
    
    ## Completion and Boundaries
    
    Complete when the requested ADR or review follows local conventions, identifies decision scope and authority without invention, preserves history, and distinguishes observed evidence from planned checks. If acceptance is unresolved, deliver a proposed record and name the missing decision rather than claiming acceptance.
    
    ## When not to use
    
    Route system-wide architecture and change sequencing to `software-architecture`, and named-tool implementation to the relevant operational skill. This skill owns decision rationale and confirmation links, not execution of the implementation or a general observability program.
    
    ## Contents
    
    - `references/adr-format.md` — template catalog (11 formats: Nygard, MADR, Tyree & Akerman, Business Case, Planguage, Alexandrian, ITD, arc42, EdgeX, Gareth Morgan, NHS Wales), template selection decision tree, lifecycle stages, file naming, team governance, examples reference
    - `references/adr-to-pyramid-mapping.md` — active→L2, superseded→L3, consumer routing
    - `references/fitness-functions.md` — method for selecting, operating, interpreting, reviewing, and retiring checks that connect ADR claims to durable evidence
    - `references/decision-sustainability.md` — 5 sustainability criteria + 8 guidelines for evaluating ADR quality before acceptance
    - `references/project-setup-guide.md` — bootstrapping ADRs in a new project: directory setup, README index, CONTRIBUTING.md/AGENTS.md docs, issue-first PR workflow with worked example
    - `templates/fitness-function-record.md` — reusable record for selecting, operating, reviewing, and retiring a fitness function
    - `references/source-index.md` — provenance and synthesis boundary for this skill
    
    ## Canonical Reference
    
    - Architecture Decision Record community repo — https://github.com/architecture-decision-record/architecture-decision-record
    - Michael Nygard, "Documenting Architecture Decisions" — https://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
    
    ## Portability
    
    This skill is intentionally host-neutral. Use your agent's normal mechanisms to load the references, templates, and scripts listed here. Do not assume a particular profile system, task orchestrator, memory service, or response-handoff format.
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.