Files
MokoCLI/templates/github/ISSUE_TEMPLATE/adr.md
T

2.0 KiB

name, about, title, labels, assignees
name about title labels assignees
Architecture Decision Record (ADR) Propose or document an architectural decision [ADR] architecture, decision

ADR Number

ADR-XXXX

Status

  • Proposed
  • Accepted
  • Deprecated
  • Superseded by ADR-XXXX

Context

Describe the issue or problem that motivates this decision.

Decision

State the architecture decision and provide rationale.

Consequences

Positive

  • List positive consequences

Negative

  • List negative consequences or trade-offs

Neutral

  • List neutral aspects

Alternatives Considered

Alternative 1

  • Description
  • Pros
  • Cons
  • Why not chosen

Alternative 2

  • Description
  • Pros
  • Cons
  • Why not chosen

Implementation Plan

  1. Step 1
  2. Step 2
  3. Step 3

Stakeholders

  • Decision Makers: @user1, @user2
  • Consulted: @user3, @user4
  • Informed: team-name

Technical Details

Architecture Diagram

[Add diagram or link]

Dependencies

  • Dependency 1
  • Dependency 2

Impact Analysis

  • Performance: [Impact description]
  • Security: [Impact description]
  • Scalability: [Impact description]
  • Maintainability: [Impact description]

Testing Strategy

  • Unit tests
  • Integration tests
  • Performance tests
  • Security tests

Documentation

  • Architecture documentation updated
  • API documentation updated
  • Developer guide updated
  • Runbook created

Migration Path

Describe how to migrate from current state to new architecture.

Rollback Plan

Describe how to rollback if issues occur.

Timeline

  • Proposal Date:
  • Decision Date:
  • Implementation Start:
  • Expected Completion:

References

  • Related ADRs:
  • External resources:
  • RFCs:

Review Checklist

  • Aligns with enterprise architecture principles
  • Security implications reviewed
  • Performance implications reviewed
  • Cost implications reviewed
  • Compliance requirements met
  • Team consensus achieved