Skip to content
Skillv1.0.0

adr-writing

Generates an Architecture Decision Record (ADR) capturing context, chosen option, alternatives, and consequences. Do NOT use for feature planning, bug reports, or general design documents.

by vheins(0) 0 installs
Free
Sign in to install

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Imported from vheins/Notulensi (.agents/skills-src/documentation/adr-writing/SKILL.md). Install upstream with npx skills add vheins/Notulensi --skill adr-writing. Copyright stays with the author (Proprietary — Personal Use Only).

Agent Optimized: ADR Writing

Directives

  • Format: Use MADR/Nygard standard.
  • Sections:
    • Header: # {{decision_title}}, ISO date, Status (Proposed|Accepted|Deprecated|Superseded).
    • Context: Problem statement, constraints (cost/scale), and assumptions.
    • Decision: Chosen option, rationale, and accepted trade-offs.
    • Consequences: Categorized lists (Positive, Negative, Neutral).
    • Alternatives: Table or list of rejected options with specific reasons.
  • Traceability: If superseding, reference the prior ADR ID in Context.
  • Precision: Do not invent context or rejection rationale. Ask for missing details.

Logic Flow

flowchart TD
    A([Start]) --> B{Inputs Valid?}
    B -- No --> C[Request missing data]
    C --> B
    B -- Yes --> D[Set Status & Header]
    D --> E[Draft Context & Constraints]
    E --> F[Draft Decision & Rationale]
    F --> G[Draft Consequences: +/-]
    G --> H[Process Alternatives Table]
    H --> I{Superseding?}
    I -- Yes --> J[Reference prior ADR]
    I -- No --> K[Finalize]
    J --> K
    K --> L([Final ADR Markdown])

Constraints

Rule Description
Title Short, imperative, prefixed with "ADR-XXX:" if applicable.
Consequences Surface tension/conflicts in "Negative Consequences".
Status Default to "Proposed" unless explicit confirmation of acceptance.
Scope Technical architecture decisions only.

Review Criteria

  • Rationale for rejection of alternatives is clear.
  • All primary constraints are addressed in context.
  • Trade-offs are explicitly acknowledged.
  • Output is prose for context/decision and bullets for consequences.

Metadata

  • Output Path: .agents/documents/decisions/
  • Changelog: 1.1.0 (MADR alignment, added metadata); 1.0.0 (Initial).

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml
targets:
  - https://api.opensmartroute.ai/api/v1/registry/vheins-notulensi-adr-writing/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

vheins-notulensi-adr-writing.ocm.jsonjson
{
  "ocm": "1",
  "id": "vheins-notulensi-adr-writing",
  "kind": "skill",
  "name": "adr-writing",
  "description": "Generates an Architecture Decision Record (ADR) capturing context, chosen option, alternatives, and consequences. Do NOT use for feature planning, bug reports, or general design documents.",
  "publisher": "vheins",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "adr",
      "architecture",
      "decision-record",
      "documentation",
      "madr",
      "nygard",
      "github"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Generates an Architecture Decision Record (ADR) capturing context, chosen option, alternatives, and consequences. Do NOT use for feature planning, bug reports, or general design documents."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github",
      "repository": "https://github.com/vheins/Notulensi",
      "path": ".agents/skills-src/documentation/adr-writing/SKILL.md",
      "ref": "0b539b80001414a063759b6a4b16abdda68947ab",
      "url": "https://github.com/vheins/Notulensi/blob/0b539b80001414a063759b6a4b16abdda68947ab/.agents/skills-src/documentation/adr-writing/SKILL.md",
      "key": "vheins/Notulensi/.agents/skills-src/documentation/adr-writing/SKILL.md"
    },
    "license": "Proprietary — Personal Use Only"
  },
  "instructions": "# Agent Optimized: ADR Writing\n\n## Directives\n- **Format**: Use MADR/Nygard standard.\n- **Sections**:\n    - **Header**: `# {{decision_title}}`, ISO date, Status (Proposed|Accepted|Deprecated|Superseded).\n    - **Context**: Problem statement, constraints (cost/scale), and assumptions.\n    - **Decision**: Chosen option, rationale, and accepted trade-offs.\n    - **Consequences**: Categorized lists (Positive, Negative, Neutral).\n    - **Alternatives**: Table or list of rejected options with specific reasons.\n- **Traceability**: If superseding, reference the prior ADR ID in Context.\n- **Precision**",
  "cost": {
    "context_tokens": 466
  }
}

Fetch it by URL: GET /api/v1/registry/vheins-notulensi-adr-writing/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.