adr-writing
adr-writing creates and formats architectural decision records using the MADR structure, applying E.C.A.D.R. quality criteria to ensure completeness. It sequences numbering, explores related decisions and code context, fills template sections, and marks gaps for investigation where data is unavailable.
adr-writing generates and formats architectural decision records using the MADR template with completeness verification.
AI-generated summary based on this skill's SKILL.md
Install
existential-birds/beagle/adr-writing · repository language: TypeScript
git clone https://github.com/existential-birds/beagle
cp -r beagle/plugins/beagle-analysis/skills/adr-writing ~/.claude/skills/adr-writingnpx skillfed install existential-birds/beagle/adr-writingFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I write an ADR document using adr-writing?
adr-writing guides you through creating architectural decision records in MADR format. Start by providing the core decision details—title, context, and options being considered. The tool structures your input into the complete MADR template, applies E.C.A.D.R. quality criteria to verify completeness, and flags any gaps where information is missing so you can address them systematically.
What is the MADR template and how does adr-writing format it?
MADR (Markdown Architectural Decision Records) is a standardized format for documenting architectural decisions. adr-writing formats your decisions as MADR by organizing them into sections like title, status, context, decision, consequences, and related decisions. It sequences numbering automatically, explores related ADRs and code context, and ensures each section follows the template structure for consistency.
How can I check ADR quality and completeness with adr-writing?
adr-writing verifies ADR completeness against Definition of Done criteria using the E.C.A.D.R. quality checklist. It systematically checks that all required sections are filled, evaluates the depth and clarity of each part, and marks gaps where data is unavailable. This ensures your architectural decisions meet quality standards before finalization.
Can adr-writing convert meeting notes into formal ADR format?
Yes. adr-writing transforms meeting notes and discussions into formal ADR documents by extracting decision points and structuring them into MADR sections. It identifies the decision, context, and consequences from your notes, fills the template sections systematically, and marks any gaps that need follow-up investigation before the ADR is complete.
What happens when adr-writing finds missing information in an ADR?
adr-writing marks and tracks gaps in ADR sections for follow-up investigation. When required information is unavailable—such as incomplete consequences or missing stakeholder input—the tool flags these sections so you know exactly what needs investigation. This prevents incomplete decisions from being finalized and ensures thorough documentation.
Does adr-writing generate ADR documents from decision data automatically?
adr-writing generates ADR documents from extracted decisions with systematic checks built in. Provide your decision data, and the tool fills the MADR template sections, sequences numbering, explores related decisions and code context, applies quality criteria, and generates the complete document while verifying it meets Definition of Done standards.
SKILL.md
rendered from the published skill — quoted content, verbatim
ADR Writing
Overview
Generate Architectural Decision Records (ADRs) following the MADR template with systematic completeness checking.
Quick Reference
``` ┌─────────────┐ ┌──────────────┐ ┌─────────────┐ │ SEQUENCE │ ──▶ │ EXPLORE │ ──▶ │ FILL │ │ (get next │ │ (context, │ │ (template │ │ number) │ │ ADRs) │ │ sections) │ └─────────────┘ └──────────────┘ └─────────────┘ │ │ │ ▼ │ ┌─────────────┐ │ │ VERIFY │ │
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 4 files
plugins/beagle-analysis/skills/adr-writing/SKILL.md
plugins/beagle-analysis/skills/adr-writing/references/definition-of-done.md
plugins/beagle-analysis/skills/adr-writing/references/madr-template.md
plugins/beagle-analysis/skills/adr-writing/scripts/next_adr_number.py