adr-writing

Generate MADR-format Architectural Decision Records with automated numbering and completeness checks.

Updated Feb 17, 2026
One-click install
npx skills add https://github.com/javierhbr/random-poc --skill adr-writing-javierhbr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-writing
Source: https://github.com/javierhbr/random-poc/tree/main/custom-skills/beagle-main/plugins/beagle-analysis/skills/adr-writing
Command: npx skills add https://github.com/javierhbr/random-poc --skill adr-writing-javierhbr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the process of creating formal Architectural Decision Records (ADRs) by providing a structured template, ensuring completeness, and automating the assignment of unique identifiers.

Core Features & Use Cases

  • MADR Template Adherence: Generates ADRs following the standard MADR format.
  • Completeness Checking: Applies a Definition of Done (DoD) checklist to ensure all critical aspects are covered.
  • Automated Numbering: Assigns sequential, zero-padded numbers to ADRs for consistent organization.
  • Use Case: When a significant architectural choice is made during a project meeting, use this Skill to immediately draft a formal ADR, capturing the context, decision drivers, options considered, and consequences.

Quick Start

Use the adr-writing skill to generate a new ADR for the decision to use PostgreSQL for user data storage.

Frequently Asked Questions about adr-writing

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

FAQPage Schema
How do I document architectural decisions using the MADR template?

To document architectural decisions using the MADR template, this Skill captures context, decision drivers, options considered, and consequences while automatically generating proper YAML frontmatter and applying a Definition of Done checklist for systematic completeness.

What is the best way to ensure ADR completeness and consistent file naming?

The best way to ensure ADR completeness and consistent file naming is to apply a Definition of Done checklist that identifies gaps and automates the assignment of sequential, zero-padded numbers to ADR files.

How does automated ADR numbering work for architecture documentation?

Automated ADR numbering works by retrieving the next sequential, zero-padded number for each new Architectural Decision Record, ensuring consistent organization and proper file naming conventions across your documentation repository.

Can I capture architectural choices made during project meetings immediately?

Yes, you can capture architectural choices made during project meetings immediately by drafting a formal ADR on the spot, systematically recording the context, decision drivers, options considered, and consequences.

What is an Architectural Decision Record and when do I need one?

An Architectural Decision Record (ADR) is a formal document that captures significant architectural choices, including context and consequences. You need an ADR whenever a significant architectural choice is made during a project to ensure systematic documentation.

Are there limitations to generating ADRs with a Definition of Done checklist?

Generating ADRs with a Definition of Done checklist is limited to the standard MADR format structure, meaning it enforces specific YAML frontmatter and file naming conventions rather than supporting fully custom or unstructured architectural documentation formats.