adr-draft

Drafts Architecture Decision Records documenting context, alternatives, and consequences.

Updated Sep 10, 2026
One-click install
npx skills add https://github.com/serpro-workshop-fortaleza/sifap-modernization-paula --skill adr-draft-serpro-workshop-fortaleza
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-draft
Source: https://github.com/serpro-workshop-fortaleza/sifap-modernization-paula/tree/main/.github/skills/adr-draft
Command: npx skills add https://github.com/serpro-workshop-fortaleza/sifap-modernization-paula --skill adr-draft-serpro-workshop-fortaleza

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams often make significant technical decisions without documenting the reasoning, alternatives, and trade-offs, leaving future maintainers guessing why a technology or pattern was chosen. This Skill guides the creation of well-structured Architecture Decision Records (ADRs) that capture the full decision context. ## Core Features & Use Cases - Structured ADR Template: Produces ADRs with Context, Decision, Alternatives Considered, and Consequences sections, saved as docs/adr/NNNN-<slug>.md. - Decision Quality Guidance: Enforces best practices such as documenting at least two rejected alternatives, setting an explicit status, and writing in present tense. - Antipattern Detection: Warns against retroactive justification ADRs, bundled unrelated decisions, and records stuck in "proposed" status. - Use Case: When your team chooses PostgreSQL over MongoDB for a new service, use this Skill to draft ADR-0012 capturing the constraints, the rejected options with their trade-offs, and the follow-up actions linked to affected requirements. ## Quick Start Ask the assistant to draft an ADR for a specific architectural decision, for example choosing an event-driven architecture over synchronous REST calls.

Frequently Asked Questions about adr-draft

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

FAQPage Schema
How do I write an Architecture Decision Record?

An ADR documents a decision using sections for Context, Decision, Alternatives Considered, and Consequences. Write in present tense, include at least two rejected alternatives with their trade-offs, and save the file as docs/adr/NNNN-slug.md with an explicit status.

When should I write an ADR?

Write an ADR when a decision is hard or expensive to reverse, affects more than one team, constrains future technology choices, or is likely to be questioned months later. Skip ADRs for local refactorings or reversible configuration changes.

What status values can an ADR have?

An ADR status can be proposed, accepted, superseded by another ADR, or deprecated. The status should never be left blank, and records should not remain in proposed status for months without resolution.

Should I delete or update an outdated ADR?

Never delete an ADR; supersede it instead by creating a new ADR that references the old one. Historical records preserve the reasoning behind past decisions and provide value when revisiting the architecture.

What are common ADR antipatterns to avoid?

Common antipatterns include writing ADRs after the fact to justify decisions already made, bundling multiple unrelated decisions into one record, omitting the alternatives section, and leaving the status as proposed indefinitely.