Architecture Decision Record Generator

documentation
Markdown
scaffolding
corporate_pm
Remix

Create a comprehensive ADR documenting an architectural decision with context, alternatives, and consequences.

12/8/2025

Prompt

Write an Architecture Decision Record (ADR) for the following architectural decision:

Decision Details

  • Decision Title: [Specify the decision, e.g., "Use PostgreSQL for Main Database", "Adopt Microservices Architecture", "Implement GraphQL API"]
  • ADR Number: [e.g., ADR-001, ADR-015]
  • Status: [Proposed / Accepted / Rejected / Superseded / Deprecated]
  • Date: [Current date]
  • Decision Maker(s): [Names/roles of people involved in the decision]

Context & Problem Statement

Describe the technical, business, or architectural context that necessitates this decision:

  • What problem are you trying to solve?
  • What constraints exist (technical, business, timeline)?
  • What requirements must be met?
  • What scale/performance considerations exist?

Example: "We need to choose a database that supports complex queries, ACID transactions, JSON data, and can scale to handle 10M+ users."

Decision

State the decision clearly and concisely:

  • What specific approach/technology/pattern have you chosen?
  • Why this specific choice over others?

Example: "We will use PostgreSQL as our primary relational database for all transactional data."

Consequences

Positive Consequences

List the benefits and advantages of this decision:

  • What problems does it solve?
  • What capabilities does it enable?
  • What improvements does it bring?

Negative Consequences

List the drawbacks and challenges:

  • What new problems might it create?
  • What limitations does it introduce?
  • What is the learning curve or migration cost?

Neutral Consequences

List neutral impacts that are neither clearly positive nor negative:

  • What operational changes are required?
  • What monitoring/maintenance is needed?
  • What team adjustments are necessary?

Alternatives Considered

For each alternative option that was evaluated, document:

Alternative 1: [Name]

  • Description: Brief overview
  • Pros: Key advantages
  • Cons: Key disadvantages
  • Why rejected: Specific reason this wasn't chosen

Alternative 2: [Name]

  • Description: Brief overview
  • Pros: Key advantages
  • Cons: Key disadvantages
  • Why rejected: Specific reason this wasn't chosen

[Repeat for additional alternatives]

Implementation Notes (Optional)

  • Migration strategy if replacing existing solution
  • Rollout plan or timeline
  • Team training requirements
  • Proof of concept results

References & Resources

  • Documentation links
  • Related ADRs (e.g., "Supersedes ADR-003")
  • Benchmark data or research
  • External articles or case studies

Follow-up Actions

  • Action item 1
  • Action item 2
  • Schedule review date

Generate a complete, well-structured ADR document in Markdown format following this structure. The ADR should be concise but thorough, typically 1-3 pages, and provide enough context for future team members to understand why this decision was made.

Tags

adr
architecture
documentation
decision-making

Tested Models

gpt-4
claude-3-sonnet

Comments (0)

Sign in to leave a comment

Sign In