What is an Architecture Decision Record (ADR)?

An ADR is a short text file that captures a significant architectural decision, the context in which it was made, and the consequences it has for the project.

When should I use the docs-adr skill?

Use it whenever you make a significant technical choice, such as selecting a database, adopting a new design pattern, or implementing a major refactor.

Can I link ADRs together?

Yes, the skill encourages linking related records, especially when a new decision supersedes or deprecates a previous one.

Does this skill help with ADR organization?

Yes, it provides a numbering convention and a master index format to keep all architectural decisions organized and easily accessible.

How does the skill validate ADRs?

It includes specific shell commands and a validation checklist to verify that required sections, metadata, and status fields are present in your documents.

ADR Writing Assistant

Name: ADR Writing Assistant
Author: Genuineh

byGenuineh

0•

Learning & Documentation

Guides the creation and maintenance of Architecture Decision Records (ADRs) to document significant technical choices and their rationale.

The docs-adr skill empowers developers and architects to capture critical technical decisions using a standardized Architecture Decision Record format. It provides a structured workflow that guides users through documenting the context, decision rationale, positive and negative consequences, and alternative considerations for any major technical change. By facilitating a permanent and searchable record of the 'why' behind technology choices, this skill helps teams maintain alignment, simplifies onboarding for new members, and ensures the long-term maintainability of complex software systems.

Key Features

01Built-in validation scripts and checklists to ensure documentation quality

020 GitHub stars

03Standardized ADR templates with required metadata and YAML frontmatter

04Automated master index maintenance for centralized architecture tracking

05Lifecycle management with status tracking (proposed, accepted, superseded)

06Comprehensive decision framework including pros, cons, and alternatives

Use Cases

01Recording the rationale behind architectural pattern shifts like moving to microservices

02Documenting the adoption of new technologies like frameworks or databases

03Justifying API design choices and infrastructure selection for future reference

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add genuineh/fus docs-adr

For use in Claude.ai and ChatGPT