skills.rest
chiubaka
chiubakaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

create-adr

Create Actionable Decision Records with org-template consistency across scopes.

1|Updated Jul 7, 2022
Search Tags:#template#decision record#organization#ADR#scope
One-click install
npx skills add https://github.com/chiubaka/circleci-orb --skill create-adr-chiubaka
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-adr
Source: https://github.com/chiubaka/circleci-orb/tree/main/org/agents/skills/create-adr
Command: npx skills add https://github.com/chiubaka/circleci-orb --skill create-adr-chiubaka

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill addresses the challenge of creating Actionable Decision Records (ADRs) at the correct scope (org, repo, or package), ensuring consistency and portability across the organization.

Core Features & Use Cases

  • Scope Selection: Guides users to choose the optimal ADR scope (org, repo, or package) for their decision.
  • Template-Based Creation: Utilizes an org-level ADR template to maintain uniformity and ease the creation process.
  • Portability Rule Enforcement: Ensures org-level ADRs are self-contained and portable to maintain consistency across repositories.

Quick Start

Use the create-adr skill to generate a new org-level ADR for cross-repo conventions by running 'create-adr --scope org'.

Frequently Asked Questions about create-adr

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

FAQPage Schema
How do I create an ADR that stays consistent across multiple repositories?▼

To create an ADR consistent across multiple repositories, you need an org-level template that enforces portability rules and standardization. This approach ensures decision records remain self-contained and uniform throughout your organization.

What's the best way to choose the right scope for an architecture decision record?▼

Choosing the right scope for an architecture decision record means matching the decision's impact to the appropriate level: org, repo, or package. Scope-driven guidance ensures decisions are correctly targeted for their intended audience.

How do I define conventions and workflows using decision records?▼

You can define conventions and workflows using decision records by applying an org-level ADR template to document architecture choices. This standardizes how technical rules are captured and communicated across your codebase.

Do I need a predefined template to generate an actionable decision record?▼

Yes, you need a predefined org-template to generate an actionable decision record because it serves as the source of standardization. Relying on this template enforces consistency and eases the creation process.

When should I not use an org-level scope for my ADR?▼

You should not use an org-level scope for your ADR when the decision only impacts a single repository or package. Portability rules require org-level records to be self-contained, which is unnecessary for localized, package-specific decisions.

Related Skills

Explore More Software Engineering Skills→
rvdbreemenrvdbreemen
4

migrate

Convert legacy ADR Markdown files into the canonical seven-section template.

Community
Intermediate
VladlenFilimonovVladlenFilimonov

documentation

Standardize repository markdown documentation conventions and lifecycle management.

Community
Intermediate
rahlplxrahlplx

System Evolution Expert

Monitor lessons, enforce portability rules, and apply metacognitive updates across the .agent ecosystem.

Community
Advanced
HermeticOrmusHermeticOrmus

ADR Templates

Generate Markdown-based ADRs using MADR and Y-Statement templates.

Community
Basic