Get the FREE Ultimate OpenClaw Setup Guide →

Develop Adr

Scanned
npx machina-cli add skill product-on-purpose/pm-skills/develop-adr --openclaw
Files (1)
SKILL.md
3.0 KB
<!-- PM-Skills | https://github.com/product-on-purpose/pm-skills | Apache 2.0 -->

name: develop-adr description: Creates an Architecture Decision Record following the Nygard format to document significant technical decisions, their context, and consequences. Use when making technical choices that affect system architecture, technology selection, or development patterns. phase: develop version: "2.0.0" updated: 2026-01-26 license: Apache-2.0 metadata: category: specification frameworks: [triple-diamond, lean-startup, design-thinking] author: product-on-purpose

Architecture Decision Record (ADR)

An Architecture Decision Record documents a significant technical decision along with its context and consequences. ADRs capture the "why" behind architectural choices so future team members understand the reasoning — especially important when they question why something was done a particular way. This skill follows Michael Nygard's lightweight ADR format.

When to Use

  • Making significant technical decisions that affect system architecture
  • Choosing between technology options (frameworks, databases, services)
  • Establishing patterns that future development should follow
  • Documenting the rationale for constraints or non-obvious approaches
  • Preserving institutional knowledge about past decisions

Instructions

When asked to create an ADR, follow these steps:

  1. Assign a Number and Title ADRs are numbered sequentially (ADR-001, ADR-002, etc.) for easy reference. The title should be a short noun phrase describing the decision, like "Use PostgreSQL for order data" or "Adopt React for frontend."

  2. Set the Status New ADRs start as "Proposed." After team review, they become "Accepted," "Deprecated," or "Superseded by ADR-XXX." Status changes should be tracked.

  3. Describe the Context Explain the circumstances that led to this decision. What problem are you solving? What forces are at play (technical constraints, team expertise, timeline, cost)? This section should help a reader who wasn't there understand why this decision was needed.

  4. State the Decision Clearly articulate what you decided. Use active voice: "We will use..." rather than "It was decided..." Be specific about what is and isn't included in the decision.

  5. Document the Consequences List the outcomes of this decision — positive, negative, and neutral. Good ADRs are honest about trade-offs. What becomes easier? What becomes harder? What new constraints or options does this create?

Output Format

Use the template in references/TEMPLATE.md to structure the output.

Quality Checklist

Before finalizing, verify:

  • Title is a short, descriptive noun phrase
  • Status is clearly indicated (Proposed/Accepted/Deprecated/Superseded)
  • Context explains why this decision was needed
  • Decision is stated clearly in active voice
  • Consequences include both positive and negative outcomes
  • ADR can stand alone without requiring other documents

Examples

See references/EXAMPLE.md for a completed example.

Source

git clone https://github.com/product-on-purpose/pm-skills/blob/main/skills/develop-adr/SKILL.mdView on GitHub

Overview

Develop ADRs using the Nygard format to capture significant technical decisions, their context, and consequences. This practice helps teams preserve the rationale behind architecture, technology choices, or development patterns for future readers.

How This Skill Works

When asked to create an ADR, follow these steps: assign a sequential number and concise title (e.g., ADR-001), set the status (Proposed/Accepted/etc.), describe the context and constraints, clearly state the decision in active voice, and document the resulting consequences. ADRs should be self-contained and formatted according to the template in references/TEMPLATE.md.

When to Use It

  • Making significant technical decisions that affect system architecture
  • Choosing between technology options (frameworks, databases, services)
  • Establishing patterns that future development should follow
  • Documenting the rationale for constraints or non-obvious approaches
  • Preserving institutional knowledge about past decisions

Quick Start

  1. Step 1: Assign a number and a concise title (ADR-XXX).
  2. Step 2: Set status and write the context, decision, and consequences.
  3. Step 3: Record in the project repository using the TEMPLATE.md output format.

Best Practices

  • Use a short, descriptive ADR title and a unique sequential number (e.g., ADR-001)
  • Keep context, decision, and consequences clearly separated and factual
  • State the decision in active voice and avoid hedging
  • Capture both positive and negative consequences and trade-offs
  • Review and update ADRs when decisions change or are superseded

Example Use Cases

  • ADR-001: Use PostgreSQL for order data
  • ADR-002: Adopt React for frontend UI
  • ADR-003: Use OpenID Connect for user authentication
  • ADR-004: Choose Kafka for event streaming
  • ADR-005: Implement Redis for caching

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers