writing-adrs

Write terse one-page Architecture Decision Records in Nygard format under docs/adr.

8|15|Updated Jan 17, 2025
One-click install
npx skills add https://github.com/Netcracker/qubership-envgene --skill writing-adrs-netcracker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-adrs
Source: https://github.com/Netcracker/qubership-envgene/tree/main/.claude/skills/writing-adrs
Command: npx skills add https://github.com/Netcracker/qubership-envgene --skill writing-adrs-netcracker

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Architecture decisions made in conversations or pull requests get lost, and future contributors re-litigate settled trade-offs. This Skill captures each decision as a durable, one-page ADR so the rationale survives. ## Core Features & Use Cases - Nygard-format ADRs: Produces the five standard sections (title, Status, Context, Decision, Consequences) with rejected alternatives listed as one-clause bullets. - Strict style enforcement: One decision per file, one page maximum, mandatory downside, no code references, no dates, no diagrams, and qualitative findings instead of exact counts. - Filing and lifecycle management: Files ADRs as docs/adr/NNNN-kebab-title.md with zero-padded numbering, and manages the Proposed to Accepted to Superseded status lifecycle. - Use Case: After a design discussion settles on adapting registry auth from e2e parameters, ask for an ADR and get a concise record with the rejected alternatives and the accepted cost, ready to commit. ## Quick Start Ask the assistant to write an ADR recording the design decision we just made about the chosen approach.

Frequently Asked Questions about writing-adrs

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

FAQPage Schema
How do I write an Architecture Decision Record?

Use the Nygard format with five sections: a short imperative title, a Status line, 2-3 sentences of Context, a present-tense Decision with rejected alternatives as one-clause bullets, and Consequences including the accepted cost. Keep it to one page and one decision per file.

What format should an ADR follow?

This Skill uses the Nygard format: title, Status (Proposed, Accepted, or Superseded), Context, Decision, and Consequences. For very small decisions, a single Y-statement can replace the prose sections.

Where should ADR files be stored in a repository?

ADRs are filed under docs/adr/ with zero-padded numbered filenames like 0001-kebab-title.md. The next number is the highest existing number plus one, starting at 0001 if the directory does not exist.

Can I edit an accepted ADR to change the decision?

No. An accepted ADR's decision is never edited to reverse it. Instead, write a new ADR that supersedes it and flip the old one's status to Superseded by ADR-XXXX, preserving the decision trail.

Why should an ADR avoid code references and exact numbers?

Code references and exact counts go stale as the implementation evolves, making the durable record misleading. ADRs state decisions in domain and behavior terms and findings qualitatively, linking out to design docs or PRs for details.