adr-writer

Automate MADR-compliant Architectural Decision Records with structured sections and 4-digit numbering.

4|Updated Apr 25, 2024
One-click install
npx skills add https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted --skill adr-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr-writer
Source: https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted/tree/main/.opencode/skills/adr-writer
Command: npx skills add https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted --skill adr-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams consistently create MADR-compliant Architectural Decision Records to capture critical architectural decisions. It enforces structure, numbering, and references to related decisions, reducing ambiguity and drift over time.

Core Features & Use Cases

  • MADR-compliant ADR authoring with required sections (Status, Context, Decision, Rationale, Consequences, Alternatives, References, Notes)
  • 4-digit numbering and cross-linking of related ADRs for traceability
  • Guidance for implementation notes and references, improving documentation workflows

Quick Start

To create an ADR, generate the next ADR number under docs/ADR (for example, 0001-adr-writing.md), then fill in the Context, Decision, and Rationale sections and add References to related ADRs.

Frequently Asked Questions about adr-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write an Architectural Decision Record using the MADR format?▼

An Architectural Decision Record using the MADR format requires documenting architecture choices across structured sections including Status, Context, Decision, Rationale, Consequences, Alternatives, References, and Notes to ensure consistent software-design documentation.

What is the MADR structure for documenting software-design decisions?▼

The MADR structure for software-design decisions enforces specific sections: Status, Context, Decision, Rationale, Consequences, Alternatives, References, and Notes, which collectively reduce ambiguity and drift over time in modular software projects.

How should I number and cross-link related architectural decision records?▼

Architectural decision records should be numbered using a 4-digit scheme, such as 0001-adr-writing.md, and cross-linked by adding references to related ADRs within the document to maintain traceability.

When do I need to create an ADR for technology choices?▼

You need to create an ADR for technology choices when capturing critical architectural decisions, cross-cutting concerns, or technology selections in modular software projects to prevent documentation drift and ambiguity.

What's the best way to automate MADR-compliant ADR creation?▼

The best way to automate MADR-compliant ADR creation is to use a tool that enforces the 4-digit numbering, required sections, and cross-linking of related decisions, reducing manual formatting overhead.

Does this ADR writing approach work for modular software projects?▼

Yes, this ADR writing approach works for modular software projects by specifically covering decisions across architecture, technology choices, and cross-cutting concerns while enforcing consistent documentation references.