create-architectural-decision-record

Generate structured Architectural Decision Record documents with standardized front matter and coded sections.

Updated Aug 28, 2026
One-click install
npx skills add https://github.com/miyake-san/sogo-agent-platform --skill create-architectural-decision-record-miyake-san
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-architectural-decision-record
Source: https://github.com/miyake-san/sogo-agent-platform/tree/main/skills/core/create-architectural-decision-record
Command: npx skills add https://github.com/miyake-san/sogo-agent-platform --skill create-architectural-decision-record-miyake-san

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams often lose track of why architectural choices were made, leading to repeated debates and inconsistent documentation. This Skill produces a consistently formatted ADR that captures context, decision, consequences, and rejected alternatives in a machine-parseable Markdown file. ## Core Features & Use Cases - Standardized ADR Template: Generates a complete ADR with YAML front matter (title, status, date, authors, supersedes fields) and required sections for context, decision, consequences, alternatives, implementation notes, and references. - Coded Bullet Structure: Uses 3-4 letter codes with 3-digit numbers (POS-001, NEG-001, ALT-001, IMP-001, REF-001) so items can be referenced and parsed programmatically. - Sequential File Naming: Saves output to /docs/adr/ using the adr-NNNN-[title-slug].md convention with the next sequential 4-digit number. - Use Case: After deciding to adopt PostgreSQL over MongoDB, ask the assistant to record the decision; it produces adr-0001-database-selection.md documenting rationale, trade-offs, and rejected alternatives. ## Quick Start Create an ADR documenting our decision to use event-driven architecture for the order processing service, including the alternatives we rejected.

Frequently Asked Questions about create-architectural-decision-record

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

FAQPage Schema
How do I create an Architectural Decision Record?

Provide the decision title, context, chosen decision, alternatives considered, and stakeholders. The Skill generates a complete ADR Markdown file with front matter, status, consequences, and rejection rationale, saved to /docs/adr/ with a sequential number.

What format should an ADR document follow?

An ADR should include YAML front matter (title, status, date, authors, supersedes fields), plus sections for context, decision, positive and negative consequences, alternatives with rejection reasons, implementation notes, and references.

Where are ADR files saved and how are they named?

ADR files are saved in the /docs/adr/ directory using the naming convention adr-NNNN-[title-slug].md, where NNNN is the next sequential 4-digit number, for example adr-0001-database-selection.md.

What happens if required ADR inputs are missing?

The Skill validates inputs before generating the document. If context, decision, alternatives, or stakeholders cannot be determined from the conversation, it asks you to provide the missing information first.

When should I not use a formal ADR?

Skip ADRs for trivial, easily reversible choices like variable naming or minor library updates. ADRs are best for significant, hard-to-reverse architectural decisions with multiple viable alternatives and lasting consequences.