ADR Formats
Choose from four ADR formats: Nygard for classic simplicity, Structurizr for architecture focus, MADR for options analysis, or Y-Statement for single-sentence decisions.
NeoArc supports four ADR formats, each suited to different documentation needs. Choose the format that best matches your team's workflow and the complexity of the decision being documented.
Format Overview
| Format | Best For | Complexity |
|---|---|---|
| Nygard | Most decisions. Simple, clear, widely understood. | Low |
| Structurizr | Using Structurizr tools. Similar to Nygard. | Low |
| MADR | Complex decisions requiring options analysis. | High |
| Y-Statement | Quick documentation or summaries. | Minimal |
Nygard Format
The classic ADR format created by Michael Nygard. Simple and concise, focusing on three essential sections.
Structurizr Format
Similar to Nygard, designed for architecture documentation within the Structurizr ecosystem. Contains the same three sections: Context, Decision, and Consequences.
MADR Format
Markdown Any Decision Record: an extended format for decisions requiring detailed options analysis.
MADR Options
Each considered option includes.
| Field | Description |
|---|---|
| Name | Short identifier for the option |
| Description | Detailed explanation of the approach |
| Pros | List of advantages (shown with green checkmarks) |
| Cons | List of disadvantages (shown with red crosses) |
Y-Statement Format
The most concise format: a single sentence capturing the entire decision.
Pattern
"In the context of [situation], facing [concern], we decided [decision] to achieve [goal], accepting [tradeoff]."
Changing Formats
You can change an ADR's format at any time.
Markdown Export
Each format has a specific markdown template.
| Format | Markdown Template |
|---|---|
| Nygard/Structurizr | Standard headings for Context, Decision, Consequences |
| MADR | Extended template with options tables showing pros/cons |
| Y-Statement | Minimal template with the statement prominently displayed |