authoring-adrs

Write and manage Architecture Decision Records with structured templates and lifecycle rules.

1|Updated Mar 20, 2025
One-click install
npx skills add https://github.com/asanexample/platform --skill authoring-adrs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: authoring-adrs
Source: https://github.com/asanexample/platform/tree/main/.claude/skills/authoring-adrs
Command: npx skills add https://github.com/asanexample/platform --skill authoring-adrs

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill assists in the creation, editing, and management of Architecture Decision Records (ADRs) within a repository, ensuring a uniform and structured approach to documenting architectural decisions.

Core Features & Use Cases

  • Structured Documentation: Guides the user through the process of writing ADRs with required section structures.
  • Lifecycle Management: Defines the status lifecycle from 'Proposed' to 'Superseded', along with guidance on maintaining a consistent record.
  • File Naming and Indexing: Provides rules for proper file naming, numbering, and index management for easy navigation.
  • Amend-In-Place vs. New ADR: Helps determine when to refine an existing ADR or create a new one based on its application scope.

Quick Start

Open the SKILL.md file and begin creating a new ADR by following the template structure provided, then submit a pull request for review.

Frequently Asked Questions about authoring-adrs

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

FAQPage Schema
What is an Architecture Decision Record and when do I need to write one?

To write an Architecture Decision Record, follow a provided template structure that enforces specific formatting and required sections. This process ensures uniform documentation and facilitates easy navigation through proper file naming, numbering, and index management.

How do I manage the lifecycle of an Architecture Decision Record from proposed to superseded?

Managing an Architecture Decision Record lifecycle involves updating its status from 'Proposed' to 'Accepted' and eventually 'Superseded'. This lifecycle management maintains a consistent record, ensuring traceability when architectural decisions evolve over time.

When should I amend an existing Architecture Decision Record in place versus creating a new one?

You should amend an existing Architecture Decision Record in place for minor refinements, but create a new ADR when the application scope changes significantly. This distinction helps maintain accurate and structured documentation of architectural decisions.

What are the best practices for naming and indexing Architecture Decision Records in a repository?

Best practices for Architecture Decision Records include following strict rules for file naming, numbering, and index management. This ensures easy navigation and a uniform, structured approach to documenting architectural decisions within your repository.

How do I enforce consistent formatting and design standards for Architecture Decision Records?

To enforce consistent formatting and design standards for Architecture Decision Records, use a Skill that provides strict guidance on templates and processes. This enforces adherence to specific structures, improving consistency and traceability across your software development team.