Skip to content

Body Sections

The document title MUST be an H1 heading in the format:

# ADR-{NUMBER}: {TITLE}

Where:

  • {NUMBER} is a unique identifier (typically zero-padded, e.g., 0001)
  • {TITLE} matches the frontmatter title field

The status section MUST be an H2 heading containing the current status.

## Status
Accepted

If the ADR supersedes another, this SHOULD be noted:

## Status
Accepted
Supersedes ADR-0003

The context section MUST be an H2 heading with the following subsections:

An H3 subsection describing the situation requiring a decision.

## Context
### Background and Problem Statement
{Description of the context and the problem being solved}

An H3 subsection listing limitations of the current approach.

### Current Limitations
{Numbered or bulleted list of limitations}

The decision drivers section MUST be an H2 heading with hierarchical subsections:

An H3 subsection listing the most important factors.

## Decision Drivers
### Primary Decision Drivers
1. **{Driver Name}**: {Explanation}
2. **{Driver Name}**: {Explanation}

An H3 subsection listing influential but non-decisive factors.

### Secondary Decision Drivers
1. **{Driver Name}**: {Explanation}

The options section MUST be an H2 heading with an H3 subsection for each option.

Each option MUST include:

  1. Description - Brief overview
  2. Technical Characteristics - Key technical attributes
  3. Advantages - Benefits of this option
  4. Disadvantages - Drawbacks of this option

Each option SHOULD include:

  1. Risk Assessment - Technical, schedule, and ecosystem risk ratings

Each option MAY include:

  1. Disqualifying Factor - Reason for rejection (if applicable)
## Considered Options
### Option 1: {Title}
**Description**: {Brief description}
**Technical Characteristics**:
- {Characteristic 1}
- {Characteristic 2}
**Advantages**:
- {Advantage 1}
- {Advantage 2}
**Disadvantages**:
- {Disadvantage 1}
- {Disadvantage 2}
**Risk Assessment**:
- **Technical Risk**: {Low|Medium|High}. {Explanation}
- **Schedule Risk**: {Low|Medium|High}. {Explanation}
- **Ecosystem Risk**: {Low|Medium|High}. {Explanation}

The decision section MUST be an H2 heading stating the chosen option and implementation details.

## Decision
{Clear statement of the decision}
The implementation will use:
- **{Component}** for {purpose}
- **{Component}** for {purpose}

The consequences section MUST be an H2 heading with three subsections:

## Consequences
### Positive
1. **{Title}**: {Description}
### Negative
1. **{Title}**: {Description}
### Neutral
1. **{Title}**: {Description}

The outcome section MUST be an H2 heading summarizing results and mitigations.

## Decision Outcome
{Summary of how objectives are achieved}
Mitigations:
- {Mitigation for negative consequence}

The related decisions section MUST be an H2 heading linking to related ADRs.

## Related Decisions
- [ADR-{NUMBER}: {Title}]({filename}) - {Relationship description}

The links section MUST be an H2 heading with external resources.

## Links
- [{Resource Name}]({URL}) - {Description}

The more information section MUST be an H2 heading with metadata.

## More Information
- **Date:** {DATE}
- **Source:** {Reference}
- **Related ADRs:** {List}

The audit section MUST be an H2 heading and MUST be present in all Structured MADR documents.

Each audit entry MUST be an H3 heading with the audit date and contain:

  1. Status - Audit result
  2. Findings - Table of specific findings
  3. Summary - Brief summary
  4. Action Required - Required remediation
## Audit
### {YYYY-MM-DD}
**Status:** {Pending|Compliant|Non-Compliant|Partial}
**Findings:**
| Finding | Files | Lines | Assessment |
|---------|-------|-------|------------|
| {Description} | `{file}` | L{n}-L{m} | {compliant|non-compliant|partial} |
**Summary:** {Brief summary}
**Action Required:** {None|Description of required actions}

New ADRs SHOULD have an initial audit entry with status Pending:

## Audit
### {DATE}
**Status:** Pending
**Findings:**
| Finding | Files | Lines | Assessment |
|---------|-------|-------|------------|
| Awaiting implementation | - | - | pending |
**Summary:** ADR created, awaiting implementation.
**Action Required:** Implement decision and audit