What problem does it solve?
Teams lose critical context and rationale for architecture choices, making future maintenance, onboarding, and audits difficult; ADR Writer captures the decision, alternatives, and consequences in a reproducible, discoverable format to prevent that knowledge gap. It ensures decisions are numbered, status-tracked, and recorded with metadata so reviewers can understand why a choice was made months or years later.
Core Features & Use Cases
- Structured ADR generation: Produces ADR documents with clear Context, Decision, Alternatives, and Consequences sections to make the rationale explicit.
- Lifecycle and numbering: Recommends sequential ADR numbering (ADR-001 …) and status lifecycle (Proposed, Accepted, Deprecated, Superseded) with guidance for supersession and immutability.
- Guided elicitation & analysis: Provides prompt templates and questions to capture constraints, stakeholders, triggers, and concrete rejection reasons; includes alternatives analysis and scoring guidance for complex trade-offs.
- Reference-backed best practices: Includes templates, status lifecycle rules, context-capture techniques, and alternatives-analysis frameworks for rigorous documentation and review.
- Use Case: Documenting a decision to adopt PostgreSQL over MongoDB for an order service with explicit criteria, migration considerations, and consequences.
Quick Start
Use the adr-writer to create an ADR that documents the decision to adopt PostgreSQL for the user service, including context, alternatives considered, the chosen decision with rationale, and projected consequences.