adr-writing

Solid

Write and maintain Architecture Decision Records (ADRs) — when to write one, the standard format, status lifecycle, how to link related decisions, and how to surface ADRs in a codebase. Use when asked to "write an ADR", "document this decision", "architecture decision record", "why did we choose X over Y", or "we need a record of this choice". Do NOT use for: general documentation writing — ADRs are specifically for significant architecture decisions.

AI & Automation 2 stars 0 forks Updated yesterday Apache-2.0

Install

View on GitHub

Quality Score: 81/100

Stars 20%
16
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

## When to Use - Use when: a decision is hard to reverse (database choice, auth strategy, API protocol) - Use when: a decision will affect multiple teams or future developers - Use when: "why did we do it this way?" will be asked in 6 months - Use when: two legitimate approaches were evaluated and one was chosen - Do NOT write an ADR for: minor implementation choices that are easy to change **Rule of thumb:** If you'd be embarrassed to explain the decision with no written record, write an ADR. --- ## ADR Format (MADR) Save as `docs/adr/NNNN-short-title.md` where NNNN is a zero-padded sequence. ```markdown # NNNN. [Short title describing the decision] **Status:** [Proposed | Accepted | Deprecated | Superseded by ADR-NNNN] **Date:** YYYY-MM-DD **Deciders:** [names or team] ## Context and Problem Statement [Describe the problem or context that forced a decision. 2–4 sentences. Include constraints, deadlines, or requirements that shaped the decision space.] ## Decision Drivers * [Key factor 1 — e.g., team expertise in X] * [Key factor 2 — e.g., must support 10k concurrent users] * [Key factor 3 — e.g., licensing constraints] ## Considered Options * Option A — [one-line description] * Option B — [one-line description] * Option C — [one-line description] ## Decision Outcome Chosen option: **Option A**, because [brief reason tying back to decision drivers]. ### Positive Consequences * [Consequence 1] * [Consequence 2] ### Negative Consequences / Trade-offs * [Trad...

Details

Author
yanacuti1121
Repository
yanacuti1121/Yana-AI
Created
2 months ago
Last Updated
yesterday
Language
Python
License
Apache-2.0

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category