skills.rest
ranma2913
ranma2913COMMUNITY
Explore all skills by this author →
GitHub

create-architectural-decision-record

Generate structured Architectural Decision Records with front matter under /docs/adr.

Updated Dec 13, 2023
Search Tags:#automation#architecture#templates#documentation#adr#governance
One-click install
npx skills add https://github.com/ranma2913/echo-api --skill create-architectural-decision-record
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-architectural-decision-record
Source: https://github.com/ranma2913/echo-api/tree/main/.github/skills/create-architectural-decision-record
Command: npx skills add https://github.com/ranma2913/echo-api --skill create-architectural-decision-record

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architectural decision making often relies on scattered notes; this ADR generator provides a structured, repeatable method to create fully formatted Architectural Decision Records.

Core Features & Use Cases

  • Structured front matter: includes title, status, date, authors, and tags to enable machine parsing and human readability.
  • Template-driven content: produces the standard ADR sections (Context, Decision, Consequences, Alternatives, Implementation Notes) for consistent documentation.
  • Repository integration: places ADRs under /docs/adr/ with a predictable naming convention adr-NNNN-[title-slug].md and auto-increment support.

Quick Start

Create an ADR for a new caching strategy using the ADR template and front matter conventions.

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 generate an Architectural Decision Record automatically?▼

To generate an Architectural Decision Record automatically, use a template-driven generator that creates structured ADR files with standard front matter, sections like Context and Decision, and saves them under /docs/adr/.

What is included in a standard ADR template?▼

A standard ADR template includes structured front matter for machine parsing, such as title, status, date, authors, and tags, followed by content sections for Context, Decision, Consequences, Alternatives, and Implementation Notes.

How do I enforce a consistent ADR naming convention in my repository?▼

Enforce a consistent ADR naming convention by using an automation tool that auto-increments sequential numbering and places files under /docs/adr/ with a predictable format like adr-NNNN-[title-slug].md.

Can I use automated ADR generation for AI-driven project governance?▼

Yes, automated ADR generation is designed for AI-driven projects and governance bodies, providing structured front matter that enables machine parsing and consistent architectural documentation across engineering teams.

Do I need to manually create the /docs/adr directory before generating an ADR?▼

The ADR generator enforces the repository layout under /docs/adr, automatically applying its predictable naming convention and sequential auto-increment support to place the files correctly without manual directory setup.

Related Skills

Explore More Software Engineering Skills→
simonheimlichersimonheimlicher
1

architecting-typescript

Create Architecture Decision Records for TypeScript architecture decisions.

Community
Advanced
tamago0224tamago0224

create-architectural-decision-record

Generate standardized Architectural Decision Records in Markdown with front matter and structured sections.

Community
Advanced
Tobbe3108Tobbe3108
3

github-pages-deployment

Automate static site deployment to GitHub Pages via gh-pages and CI/CD workflows.

Community
Intermediate
vanman2024vanman2024
3

Decision Tracking

Create AngularJS, create and manage ADRs with automated numbering and templates.

Community
Basic