adr-writer

Document architectural decisions using the Design It! ADR methodology.

1|Updated May 20, 2025
One-click install
npx skills add https://github.com/timblaktu/nixcfg --skill adr-writer-timblaktu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-writer
Source: https://github.com/timblaktu/nixcfg/tree/main/home/modules/claude-code/skills/adr-writer
Command: npx skills add https://github.com/timblaktu/nixcfg --skill adr-writer-timblaktu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ADRs are essential but often inconsistently documented, leading to ambiguity and miscommunication about architectural decisions. This Skill provides a clear template and guidelines to ensure decisions are recorded clearly and consistently.

Core Features & Use Cases

  • Standard ADR Template: Provides the required sections (Status, Context, Decision, Consequences) to document decisions.
  • Guided Context & Consequences: Promotes thorough reasoning, tradeoffs, and future evolution.
  • Version-Control Friendly: Encourages placing ADRs in the repository for traceability and collaboration.

Quick Start

Create a new ADR file (e.g., docs/adr/0001-record-architecture-decisions.md) and populate it with the ADR template provided by this Skill.

Frequently Asked Questions about adr-writer

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

FAQPage Schema
How do I document architectural decisions consistently across software projects?

An Architecture Decision Record (ADR) documents architectural decisions by structuring context, tradeoffs, and rationale into Status, Context, Decision, and Consequences sections. This ensures clear communication and prevents ambiguity across project teams.

What is the best way to write an ADR for version control repositories?

The best way to write an ADR for version control is to place repository-friendly markdown files in a dedicated directory like docs/adr/. This enables traceability and team collaboration on architectural decisions directly within the codebase.

What sections should be included in an architecture design doc for tradeoffs?

An architecture design doc for tradeoffs should include Status, Context, Decision, and Consequences sections. This structure promotes thorough reasoning about architectural choices and documents future evolution impacts clearly.

How do I start recording software design decisions using the Design It methodology?

To start recording software design decisions using the Design It methodology, create a new markdown file in your repository and populate it with the provided ADR template to guide your documentation of context and consequences.

When do I need to create an ADR for my software architecture?

You need to create an ADR when making significant software architecture decisions that require documented context, tradeoffs, and rationale. Recording these decisions prevents miscommunication and provides traceability for future team members.