create-adr

Create MADR-format Architectural Decision Records in the docs/adr/ directory.

3|Updated Feb 6, 2025
One-click install
npx skills add https://github.com/emaarco/easy-zeebe --skill create-adr-emaarco
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-adr
Source: https://github.com/emaarco/easy-zeebe/tree/main/.claude/skills/create-adr
Command: npx skills add https://github.com/emaarco/easy-zeebe --skill create-adr-emaarco

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps you systematically document important architectural decisions made during a project, ensuring clarity and maintainability.

Core Features & Use Cases

  • MADR Format Compliance: Generates Architectural Decision Records (ADRs) in the standard MADR format.
  • Automated Numbering & Naming: Automatically assigns the next sequential number and derives a descriptive filename slug from the decision title.
  • Interactive Content Gathering: Prompts the user for essential ADR sections like Context, Decision, and Consequences.
  • Draft Review: Presents a complete draft for user review and confirmation before writing.
  • Use Case: When your team decides to adopt a new library for handling asynchronous tasks, use this skill to create an ADR documenting the reasons, alternatives considered, and the implications of this decision.

Quick Start

Use the create-adr skill to document the decision to use bpmn-to-code for process constant generation.

Frequently Asked Questions about create-adr

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

FAQPage Schema
How do I document architectural decisions in the MADR format?▼

You can document architectural decisions in the MADR format by using a skill that interactively gathers context, decision, and consequences, then writes the completed record to your project's docs directory. It automatically numbers the file and generates a slug from your title.

What is the best way to generate ADR filenames and numbers automatically?▼

To generate ADR filenames and numbers automatically, this skill determines the next sequential number and derives a kebab-case filename slug directly from the decision title you provide, ensuring consistent naming conventions without manual tracking.

Does the create-adr skill require an existing template file to write records?▼

Yes, the skill validates the existence of the ADR directory and template file before drafting. It checks for the required project documentation structure in the docs/adr/ path to ensure proper formatting before writing.

Can I review the architectural decision record before it is saved to disk?▼

Yes, you can review the draft before it is saved. The skill interactively prompts you for the essential ADR sections and presents a complete draft for your confirmation and approval before writing the file to the directory.

When do I need to write an Architectural Decision Record?▼

You need to write an Architectural Decision Record when your team makes significant technical choices, such as adopting a new library for asynchronous tasks, to systematically document the context, alternatives considered, and consequences for future maintainability.