AGENT SKILL

develop-adr

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.

License 许可
Apache-2.0
最近更新
2026-11-14
Stars
★ 805
Forks
102

01 前言 Front Matter

name
develop-adr
license
Apache-2.0
metadata
{ "phase": "develop", "author": "product-on-purpose", "updated": 1787270400000, "version": "3.0.0", "category": "specification", "frameworks": [ "triple-diamond", "lean-startup", "design-thinking" ] }
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.

02 资源文件 6

03 SKILL.md 正文

<!-- PM-Skills | https://github.com/product-on-purpose/pm-skills | Apache 2.0 -->

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

When NOT to Use

  • The decision is a product or UX design choice, not architecture or technology -> use develop-design-rationale
  • You are still exploring whether an approach is feasible -> time-box the exploration and record it with develop-spike-summary first
  • You need to pitch a solution to stakeholders -> use develop-solution-brief; an ADR records a decision, it does not sell one
  • Nothing is actually being decided (the status quo continues unchanged): an ADR without a decision is noise; wait until there is one

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?

  6. Record the Model-Choice Consequences (only when the decision selects a model or commits the system to one) Skip this step entirely otherwise; it is a subsection inside Consequences, not a seventh heading. A model choice differs from an ordinary dependency choice in one way that matters for an ADR: the thing you evaluated will be replaced, often inside the life of this decision. So record what the choice costs to undo, not just which option won. Name whether you are building, buying, or prompting a general model and what ruled the other two out; what is now coupled to the choice (prompts, evaluation sets, output schemas, latency budgets); the operating cost accepted and the volume at which it stops being acceptable; the real reversal cost given that coupling; and the observation that would reopen this ADR, which is a trigger rather than a review date.

Output Format

Use the template in references/TEMPLATE.md to structure the output. A complete ADR fills every template section: Status; Context; Decision; Consequences; Alternatives Considered; and References.

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
  • [ ] If the decision selects or commits to a model: coupling, operating cost, reversal cost, and the observation that would reopen the decision are all recorded

Examples

See references/EXAMPLE.md for a completed example.

04 同仓库更多 Skills

product-on-purpose
product-on-purpose/pm-skills

utility-update-pm-skills

Checks for newer pm-skills releases, compares local vs. latest version, previews what would change, and updates local files after user confirmation. Generates a structured update report documenting changed files, new capabilities, and the value delta between versions. Use when you want to bring a local pm-skills installation up to date.

★ 805
product-on-purpose
product-on-purpose/pm-skills

utility-slideshow-creator

Generates professional presentations from a JSON deck specification using 18 slide types with dark/light variants, content-to-layout decision logic, and calibrated character limits. Ships with a default professional theme.

★ 805
product-on-purpose
product-on-purpose/pm-skills

utility-pm-workflow-orchestrator

Run an ordered sequence of pm-skills against one input, pausing for go/no-go and stopping on a failed or empty step. Accepts a saved prioritized action plan (Mode A) or an ad-hoc named chain (Mode B; the chain command routes here). Explicit invocation only; run --dry-run first while the native path is EXPERIMENTAL. To author a durable workflow instead, use utility-pm-workflow-builder.

★ 805
product-on-purpose
product-on-purpose/pm-skills

utility-pm-workflow-builder

Guides a contributor from a workflow idea to a complete Workflow Implementation Packet (draft workflow file, draft workflow command, cross-cutting update checklist) in a staging area for review. Runs overlap analysis against the existing workflows with a Why Gate, then helps select and sequence skills with authored handoffs. Use when creating a new multi-skill workflow or promoting a repeated ad-hoc chain into a durable one. To build a single skill instead, use utility-pm-skill-builder; to run a sequence without authoring anything, use the chain command or utility-pm-workflow-orchestrator.

★ 805
product-on-purpose
product-on-purpose/pm-skills

utility-pm-skill-validate

Audits an existing pm-skills skill against structural conventions and quality criteria. Produces a structured validation report with pass/fail checks, severity-graded findings, and actionable recommendations. Use when checking whether a skill meets repo standards before shipping or after making changes.

★ 805
product-on-purpose
product-on-purpose/pm-skills

utility-pm-skill-iterate

Applies targeted improvements to an existing pm-skills skill based on feedback, validation reports, or convention changes. Reads current files, previews proposed changes, writes on confirmation, and suggests a version bump. Use when improving a skill after validation or feedback.

★ 805