adr

分类: 工具与效率 | 上传者: jellydn | 下载: 0 | 版本: v1.0（最新）

管理架构决策记录 (ADR) 以跟踪重要的架构决策

更新日志: Source: GitHub https://github.com/jellydn/my-ai-tools

目录结构

当前层级: tree/main/skills/adr/

📁 templates/
- 📄 adr-template.md 355 B
📄 SKILL.md 2.3 KB

SKILL.md

---
name: adr
description: Manages Architecture Decision Records (ADR) for tracking important architectural decisions
license: MIT
compatibility: claude, opencode, amp, codex, gemini, cursor, pi
hint: Use when managing architecture decisions, creating ADRs, or tracking architectural choices
user-invocable: true
metadata:
  audience: all
  workflow: documentation
---

# Architecture Decision Records (ADR)

Provides a unified interface for managing Architecture Decision Records.

## Usage

`/adr <ACTION> [ARGUMENTS]`

## Actions

- **init [DIRECTORY]** - Initialize ADR directory structure
- **new <TITLE>** - Create new ADR with given title
- **supersede <NUMBER> <TITLE>** - Create ADR that supersedes existing one
- **list** - List all ADRs in the project
- **search <TERM>** - Search ADRs by content
- **view <NUMBER>** - View specific ADR
- **help** - Show this help

## What are ADRs?

Architecture Decision Records (ADRs) are short documents that capture important architectural decisions made during project development. They help teams:

- Record the context and reasoning behind decisions
- Track the evolution of architectural choices
- Onboard new team members
- Avoid revisiting already-settled decisions

## ADR Structure

Each ADR typically contains:
- **Title**: Brief description of the decision
- **Status**: Proposed, Accepted, Deprecated, Superseded
- **Context**: The situation requiring a decision
- **Decision**: The chosen solution
- **Consequences**: Positive and negative outcomes

## ADR Template

A template is available at `$SKILL_PATH/templates/adr-template.md`:

```markdown
# [NUMBER]. [TITLE]

Date: [DATE]

## Status

[Proposed | Accepted | Deprecated | Superseded by [ADR-NUMBER]]

## Context

[Describe the context and problem statement]

## Decision

[Describe the decision and solution]

## Consequences

### Positive
- [Positive outcome 1]
- [Positive outcome 2]

### Negative
- [Negative outcome 1]
- [Risk or trade-off]
```

## ADR Directory Detection

Common ADR locations to check:
- `doc/adr/` (default)
- `docs/adr/`
- `docs/architecture/decisions/`
- `architecture/decisions/`

## Process Examples

### Create new ADR:
```bash
/adr new "Use PostgreSQL for primary database"
```

### List all ADRs:
```bash
/adr list
```

### Search ADRs:
```bash
/adr search "database"
```

### View specific ADR:
```bash
/adr view 5
```

登录后下载/点赞/收藏 ❤ 53 | ★ 0

adr

目录结构

SKILL.md

举报内容

提示