adr.templates 1.1.6

dotnet adr - Make Future You Thank Past You.

A cross platform .NET Global Tool for creating and managing Architectural Decision Records (ADR).

TLDR;

Architectural Decision Records (ADRs) are simple Markdown documents used to record technical choices for a project by summarizing the context, the decision, and the consequences. dotnet adr is a tool and a bundle of the most common ADR templates you can use to create and maintain ADRs in your solution.

ADR Templates and ADR Template Packages

Which ADR templates are available out of the box?

We have collected a number of popular ADR templates.

NOTE: the status of the Open Source License for some of the templates is unclear. See each template for more details.

Alexandrian Pattern

ADR using the Alexandrian Pattern Language Approach coined by Architect Christopher Alexander et. al in 1977, which distils the decision record into the following headings:

• Prologue (Summary)
• Discussion (Context)
• Solution (Decision)
• Consequences (Results)

Source Joel Parker Henderson, see this issue about licensing.

Set as the default template using adr templates set alexandrian

Business Case Pattern

Emphasizes creating a business case for a decision, including criteria, candidates, and costs, created by Joel Parker Henderson, which distils the decision record into the following headings:

• Title
• Status
• Evaluation criteria
• Candidates to consider
• Research and analysis of each candidate
  • Does/doesn't meet criteria and why
  • Cost analysis
  • SWOT analysis
  • Opinions and feedback
• Recommendation

Source Joel Parker Henderson, see this issue about licensing.

Set as the default template using adr templates set business-case

Markdown Architectural Decision Records (MADR)

Architectural Decisions using Markdown and Architectural Decision Records, by Oliver Kopp, which distils the decision record into the following headings:

• Title
• Context and Problem Statement
• Decision Drivers
• Considered Options
• Decision Outcome
  • Positive Consequences
  • Negative Consequences
• Pros and Cons of the Options
  • [option 1]
  • [option 2]
  • [option 3]
• Links

Available as dual-license under MIT and CC0. You can choose between one of them if you use this work.

Set as the default template using adr templates set madr

Merson Pattern

An adaptation of the Nygard pattern, by Paulo Merson which adds the rationale behind the decision. It distils the decision record into the following headings:

• Title
• Status
• Decision
• Rationale
• Consequences

Available under the MIT License.

Set as the default template using adr templates set merson

Nygard Pattern

A simple, low-friction "Agile" ADR approach by Michael Nygard, which distils the decision record into the following headings:

• Title
• Status
• Context
• Decision
• Consequences

Available under CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.

Set as the default template using adr templates set nygard

Planguage Pattern

A Quality Assurance oriented approach by John Terzakis, which distils the decision record into the following headings:

• Title
• Status
• Tag
• Gist
• Requirement
• Rationale
• Priority
• Stakeholders
• Owner
• Author
• Revision
• Date
• Assumptions
• Risks
• Defined

Source Joel Parker Henderson, see this issue about licensing.

Set as the default template using adr templates set planguage

Tyree and Akerman Pattern

ADR approach by Jeff Tyree and Art Akerman, Capital One Financial, which distils the decision record into the following headings:

• Title
• Status
• Issue
• Decision
• Group
• Assumptions
• Constraints
• Positions
• Argument
• Implications
• Related decisions
• Related requirements
• Related artifacts
• Related principles
• Notes

Source Joel Parker Henderson, see this issue about licensing.

Set as the default template using adr templates set tyree-ackerman

More Information

An extensive readme is available in the GitHub repository.