adr-writing

Document architectural decisions with structured ADR templates including Context, Decision, and Options.

8|Updated Dec 16, 2008
One-click install
npx skills add https://github.com/sebnow/configs --skill adr-writing-sebnow
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr-writing
Source: https://github.com/sebnow/configs/tree/main/home-manager/agentic/skills/adr-writing
Command: npx skills add https://github.com/sebnow/configs --skill adr-writing-sebnow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architectural decisions are often poorly documented, making rationale, context, and alternatives hard to understand later.

Core Features & Use Cases

  • Structured ADR templates: provide sections like Context, Decision, and Options to capture rationale.
  • Justification-focused prose: emphasizes why a choice was made over alternatives.
  • Consistency and traceability: standardizes scope, constraints, and trade-offs across decisions.
  • Use Case: When evaluating technology, deployment, or cross-cutting decisions for complex systems.

Quick Start

Draft an ADR document with a clear Context, Decision, and set of Options to capture the rationale behind a key architectural choice.

Frequently Asked Questions about adr-writing

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 one?▼

An Architecture Decision Record (ADR) documents the rationale behind a significant architectural choice. You need an ADR when a decision affects multiple components, cross-cutting concerns like authentication, or deployment strategies, ensuring future audits can trace the context and trade-offs.

How do I document architectural trade-offs and rationale for a technology choice?▼

You document architectural trade-offs by drafting an ADR with structured sections for Context, Decision, and Options. This format requires explicit justification for why a specific technology was chosen over alternatives, capturing the constraints and narrative for future reference.

What's the best way to structure an ADR for a cross-cutting system decision?▼

The best way to structure an ADR is using a narrative format with Context, Decision, and Options sections. This standardizes scope and constraints, explicitly detailing the justification and trade-offs of cross-cutting architectural decisions to maintain consistency and traceability.

Does an ADR template work for deployment strategy and data persistence decisions?▼

Yes, an ADR template works for deployment strategy and data persistence decisions. It applies to any significant architectural choice by enforcing a structured narrative that captures the context, options, and explicit rationale needed for governance and future audits.

Why does poor architectural documentation cause issues during future system audits?▼

Poor architectural documentation causes audit issues because the original rationale, context, and evaluated alternatives become impossible to understand later. ADRs solve this by standardizing trade-off analysis and requiring explicit justification for every significant architectural decision made.