ce-adr-author

Create and revise ADR entries with auto-numbering and template validation.

78|15|Updated May 1, 2023
One-click install
npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-adr-author
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ce-adr-author
Source: https://github.com/Moffran/calibrated_explanations/tree/main/.claude/skills/ce-adr-author
Command: npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-adr-author

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

Author or revise ADR files and governance entries to keep architecture decisions clear, traceable, and aligned with the roadmap.

Core Features & Use Cases

  • ADR Drafting: Create new ADRs, copy the canonical template, and assign the next ADR number.
  • ADR Revisions & Governance: Update existing ADRs, track status changes, and maintain alignment with RELEASE_PLAN_v1.
  • Templates & References: Use assets/adr_template.md as the canonical ADR format and reference the ADR directory at docs/improvement/adrs/.

Quick Start

Copy the adr_template.md from assets to docs/improvement/adrs/ADR-<NNN>-<kebab-slug>.md and populate all required sections.

Frequently Asked Questions about ce-adr-author

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

FAQPage Schema
How do I draft an Architecture Decision Record from a template?

To draft an Architecture Decision Record, copy the canonical ADR template from assets, assign the next sequential ADR number, and populate the required sections under docs/improvement/adrs/.

What is the best way to track architectural governance and ADR status changes?

Track architectural governance by updating existing ADR entries to reflect status changes and maintaining alignment with the release plan roadmap documented in RELEASE_PLAN_v1.

How do I auto-number new ADR files for architectural decisions?

Auto-number new ADR files by identifying the latest entry in the docs/improvement/adrs/ directory and assigning the next available number to the copied ADR template.

Can I use a standard template for architectural documentation in my project?

Yes, you can use the canonical ADR template located at assets/adr_template.md to standardize your architectural documentation and ensure all required sections are populated.

How do I validate links and references when revising existing ADRs?

Validate links when revising ADRs by checking that related references within the architectural documentation point to the correct entries in the docs/improvement/adrs/ directory.

When do I need to create an ADR entry for a software architecture decision?

Create an ADR entry when you need to document a significant architectural decision, ensuring the choice is traceable, clear, and aligned with the project's improvement roadmap.