Get the FREE Ultimate OpenClaw Setup Guide →

adr-format-tyree-akerman

Scanned
npx machina-cli add skill zircote/adr/adr-format-tyree-akerman --openclaw
Files (1)
SKILL.md
4.6 KB

Tyree-Akerman ADR Format

The Tyree-Akerman format, developed by Jeff Tyree and Art Akerman, is a comprehensive template for enterprise-grade architectural decision documentation. It provides extensive traceability to requirements, principles, and related artifacts.

About Tyree-Akerman Format

The Tyree-Akerman format is:

  • Comprehensive - Covers all aspects of decision documentation
  • Traceable - Links to requirements, principles, artifacts
  • Enterprise-ready - Supports formal governance
  • RACI-aware - Documents decision makers and stakeholders

Template Structure

# {NUMBER}. {TITLE}

## Metadata

| Attribute | Value |
|-----------|-------|
| Status | {STATUS} |
| Date | {DATE} |
| Decision Makers | {names/roles} |
| Consulted | {names/roles} |
| Informed | {names/roles} |

## Issue

{Architectural question}

## Decision

{Clear decision statement}

## Assumptions

* {Assumption 1}
* {Assumption 2}

## Constraints

* {Constraint 1}
* {Constraint 2}

## Positions

### Position 1: {Title}
{Analysis}

### Position 2: {Title}
{Analysis}

## Argument

{Reasoning for decision}

## Implications

* {Implication 1}
* {Implication 2}

## Related Decisions
## Related Requirements
## Related Artifacts
## Related Principles
## Notes

Section Guide

Metadata Table

Document decision governance:

FieldPurpose
StatusCurrent decision state
DateDecision date
Decision MakersThose with final authority
ConsultedThose providing input
InformedThose who need to know

Issue

State the architectural question clearly:

  • What needs to be decided?
  • Be precise and unambiguous
  • Focus on the architectural aspect

Decision

State the decision clearly:

  • Unambiguous statement
  • Specific enough to act upon
  • Direct language

Assumptions

List underlying assumptions:

  • What is assumed to be true
  • Conditions the decision depends on
  • Beliefs about the future

If assumptions prove wrong, the decision may need revisiting.

Constraints

List fixed constraints:

  • Budget limitations
  • Technology mandates
  • Regulatory requirements
  • Timeline restrictions
  • Organizational policies

Positions

Document each option (position) considered:

  • Clear description
  • Analysis of fit with issue
  • Strengths and weaknesses

Argument

Explain the reasoning:

  • Why the chosen position was selected
  • Why other positions were rejected
  • How the decision addresses the issue

Implications

List what follows from the decision:

  • Required changes
  • Follow-up actions
  • Dependencies created
  • Future constraints

Traceability Sections

Related Decisions: Links to other ADRs Related Requirements: Links to requirements documents Related Artifacts: Links to diagrams, specs, documents Related Principles: Architectural principles supporting decision

Notes

Additional information:

  • Meeting minutes
  • Background material
  • Future considerations

When to Use Tyree-Akerman Format

Best for:

  • Enterprise environments
  • Formal governance requirements
  • Audit trail needs
  • Complex stakeholder environments
  • Decisions requiring traceability

Consider other formats when:

  • Quick documentation needed
  • Small team decisions
  • Low formality acceptable
  • Limited time available

Tyree-Akerman Best Practices

Assumptions and Constraints

  • Be explicit about assumptions
  • Document all constraints, even obvious ones
  • Review assumptions periodically
  • Note when constraints are lifted

Traceability

  • Link to actual requirement IDs
  • Reference specific artifact versions
  • Use consistent linking format
  • Keep links updated

Governance

  • Complete RACI-style metadata
  • Get appropriate sign-off
  • Store in accessible location
  • Follow change management process

Comparison with Other Formats

AspectTyree-AkermanMADRNygard
Sections12+105
TraceabilityExtensiveLimitedNone
GovernanceRACI metadataStatus onlyStatus
Best forEnterpriseTech teamsQuick docs

Additional Resources

Templates

Template available at: ${CLAUDE_PLUGIN_ROOT}/templates/tyree-akerman/adr-template.md

External Resources

  • "Architecture Decisions: Demystifying Architecture" by Jeff Tyree and Art Akerman

Source

git clone https://github.com/zircote/adr/blob/main/skills/adr-format-tyree-akerman/SKILL.mdView on GitHub

Overview

The Tyree-Akerman ADR Format is a comprehensive template for enterprise-grade architectural decision documentation. It emphasizes traceability to requirements, principles, and related artifacts, and is designed for formal governance and audit readiness. The structure supports documenting decision makers, positions, reasoning, and implications across stakeholders.

How This Skill Works

It uses a Markdown-like template with sections such as Metadata, Issue, Decision, Assumptions, Constraints, Positions, Argument, Implications, and Related artifacts. It is RACI-aware and links to related decisions, requirements, artifacts, and principles to maintain traceability. Decision teams populate these sections to produce formal, auditable ADRs.

When to Use It

  • Enterprise governance and audit trail needs requiring formal documentation
  • Complex stakeholder environments where traceability across requirements, principles, and artifacts is essential
  • Decisions with explicit assumptions and constraints that must be recorded
  • Regulatory or governance-compliant documentation requiring formal artifacts
  • Decisions that require cross-team collaboration and traceability across related decisions, requirements, and artifacts

Quick Start

  1. Step 1: Define the Issue using the Tyree-Akerman structure and fill Metadata (Status, Date, Decision Makers, Consulted, Informed)
  2. Step 2: Write the Decision, list Assumptions and Constraints, and document multiple Positions with analyses
  3. Step 3: Add the Argument, Implications, and complete Traceability sections (Related Decisions, Requirements, Artifacts, Principles) and publish

Best Practices

  • Be explicit about assumptions
  • Document all constraints, even obvious ones
  • Use the Metadata section to capture Status, Date, Decision Makers, Consulted, Informed
  • Link to actual requirement IDs and related artifacts for traceability
  • Review and refresh ADRs when inputs or constraints change

Example Use Cases

  • Enterprise-wide database technology decision with regulatory alignment and traceable links to requirements and principles
  • Microservice boundary and governance choice with traceability to architecture principles and related artifacts
  • Legacy system migration plan with clear constraints, dates, and implications across multiple teams
  • Cloud provider selection exercise aligned to regulatory/compliance requirements and governance policies
  • API gateway security decision with defined roles, responsibilities, and traceable decisions

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers