Body Sections
4. Body Sections
Section titled “4. Body Sections”4.1 Title
Section titled “4.1 Title”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 frontmattertitlefield
4.2 Status Section
Section titled “4.2 Status Section”The status section MUST be an H2 heading containing the current status.
## Status
AcceptedIf the ADR supersedes another, this SHOULD be noted:
## Status
Accepted
Supersedes ADR-00034.3 Context Section
Section titled “4.3 Context Section”The context section MUST be an H2 heading with the following subsections:
4.3.1 Background and Problem Statement
Section titled “4.3.1 Background and Problem Statement”An H3 subsection describing the situation requiring a decision.
## Context
### Background and Problem Statement
{Description of the context and the problem being solved}4.3.2 Current Limitations (Optional)
Section titled “4.3.2 Current Limitations (Optional)”An H3 subsection listing limitations of the current approach.
### Current Limitations
{Numbered or bulleted list of limitations}4.4 Decision Drivers Section
Section titled “4.4 Decision Drivers Section”The decision drivers section MUST be an H2 heading with hierarchical subsections:
4.4.1 Primary Decision Drivers
Section titled “4.4.1 Primary Decision Drivers”An H3 subsection listing the most important factors.
## Decision Drivers
### Primary Decision Drivers
1. **{Driver Name}**: {Explanation}2. **{Driver Name}**: {Explanation}4.4.2 Secondary Decision Drivers
Section titled “4.4.2 Secondary Decision Drivers”An H3 subsection listing influential but non-decisive factors.
### Secondary Decision Drivers
1. **{Driver Name}**: {Explanation}4.5 Considered Options Section
Section titled “4.5 Considered Options Section”The options section MUST be an H2 heading with an H3 subsection for each option.
4.5.1 Option Structure
Section titled “4.5.1 Option Structure”Each option MUST include:
- Description - Brief overview
- Technical Characteristics - Key technical attributes
- Advantages - Benefits of this option
- Disadvantages - Drawbacks of this option
Each option SHOULD include:
- Risk Assessment - Technical, schedule, and ecosystem risk ratings
Each option MAY include:
- 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}4.6 Decision Section
Section titled “4.6 Decision Section”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}4.7 Consequences Section
Section titled “4.7 Consequences Section”The consequences section MUST be an H2 heading with three subsections:
## Consequences
### Positive
1. **{Title}**: {Description}
### Negative
1. **{Title}**: {Description}
### Neutral
1. **{Title}**: {Description}4.8 Decision Outcome Section
Section titled “4.8 Decision Outcome Section”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}4.9 Related Decisions Section
Section titled “4.9 Related Decisions Section”The related decisions section MUST be an H2 heading linking to related ADRs.
## Related Decisions
- [ADR-{NUMBER}: {Title}]({filename}) - {Relationship description}4.10 Links Section
Section titled “4.10 Links Section”The links section MUST be an H2 heading with external resources.
## Links
- [{Resource Name}]({URL}) - {Description}4.11 More Information Section
Section titled “4.11 More Information Section”The more information section MUST be an H2 heading with metadata.
## More Information
- **Date:** {DATE}- **Source:** {Reference}- **Related ADRs:** {List}4.12 Audit Section
Section titled “4.12 Audit Section”The audit section MUST be an H2 heading and MUST be present in all Structured MADR documents.
4.12.1 Audit Entry Structure
Section titled “4.12.1 Audit Entry Structure”Each audit entry MUST be an H3 heading with the audit date and contain:
- Status - Audit result
- Findings - Table of specific findings
- Summary - Brief summary
- 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}4.12.2 Initial Audit Entry
Section titled “4.12.2 Initial Audit Entry”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