Where does this skill store the ADR files?

The skill follows a standard convention of storing generated ADRs in the docs/adr/ directory of your repository for easy access and version control.

How do I create a new ADR using this skill?

You can trigger the process by providing a decision title, and the skill will use the internal script to generate a numbered markdown file with all necessary sections.

Can I track the lifecycle of a decision?

Yes, the generated ADRs include a status field that can be updated from Proposed to Accepted, Deprecated, or Superseded as the project evolves.

What is an Architecture Decision Record (ADR)?

An ADR is a short text file that captures an important architectural decision, providing context on why the decision was made and what the consequences are for the project.

ADR Generator

Name: ADR Generator
Author: mvillmow

bymvillmow

•

Learning & Documentation

Generates standardized Architecture Decision Records (ADRs) to document significant technical choices and their underlying rationale.

The doc-generate-adr skill streamlines the process of documenting architectural choices within a software project by creating structured ADR files. It helps engineering teams maintain a clear historical record of why specific technologies, patterns, or tools were chosen, capturing the context, consequences, and alternatives considered. This practice ensures team alignment and prevents 'architectural drift' by providing a searchable 'paper trail' for future maintainers and stakeholders.

Key Features

01Structured sections for context, rationale, consequences, and alternatives

02Standardized ADR markdown template generation

03Lifecycle status tracking including Proposed, Accepted, Deprecated, and Superseded

0412 GitHub stars

05Automated file naming and sequential numbering (ADR-XXX format)

06Integration with project-specific documentation storage at docs/adr/

Use Cases

01Documenting the selection of a new programming language or framework for a project

02Onboarding new developers by providing a historical log of past architectural decisions

03Recording trade-offs made during major system refactors or infrastructure changes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add mvillmow/projectodyssey doc-generate-adr

For use in Claude.ai and ChatGPT

Download Skill