ADR Template
This file defines the canonical Architecture Decision Record (ADR) template.
Filename Convention
adr-XXX-short-title.md
Example: adr-001-use-docusaurus.md
Frontmatter
title: string
description: string
content_type: doc
type: doc
status: draft | review | active | deprecated | archived
lifecycle: draft | review | active | deprecated | archived
tags: [string]
owners: ["@github-username"]
created_at: YYYY-MM-DD
last_reviewed: YYYY-MM-DD
primary_domain: governance
category: decisions
Required Sections
Status
Current lifecycle status.
Context
What problem are we solving?
Decision
What was decided?
Consequences
What are the results, trade-offs, and impacts?
Optional Sections
Alternatives Considered
Other options evaluated.
Risks
Known risks associated with the decision.
Notes
Additional context or references.