mcpField
A
adr

adr

github.com/jellydn开发12652 次安装2 天前更新
代码仓库

关于 adr

adr 是用于管理项目架构决策记录的命令技能，面向开发团队，支持建立记录目录、撰写决策并跟踪其状态。

主要功能

  1. 01初始化 ADR 目录结构
  2. 02创建或取代 ADR
  3. 03列出并搜索项目 ADR
  4. 04查看单条 ADR
  5. 05使用提供的 ADR 模板

适用场景

  1. 01在项目中建立决策记录
  2. 02记录新的架构选择
  3. 03查找或回顾过往决策

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/jellydn/my-ai-tools --skill adr

安装后在 Claude Code 中输入/adr确认已加载。

附带文件templates/adr-template.md

详细介绍

架构决策记录（ADR）

提供用于管理架构决策记录的统一接口。

用法

/adr <ACTION> [ARGUMENTS]

操作

  • init [DIRECTORY] - 初始化 ADR 目录结构
  • new - 使用给定标题创建新的 ADR
  • supersede <NUMBER> <TITLE> - 创建一份取代现有 ADR 的 ADR
  • list - 列出项目中的所有 ADR
  • search - 按内容搜索 ADR
  • view - 查看指定的 ADR

什么是 ADR？

架构决策记录（ADR）是简短文档，用于记录项目开发过程中做出的重要架构决策。它们有助于团队：

  • 记录决策背后的背景和原因
  • 跟踪架构选择的演变
  • 帮助新团队成员熟悉项目
  • 在继续推进前将已确定的决策标记为最终决定

ADR 结构

每份 ADR 通常包含：

  • 标题：对决策的简要描述
  • 状态：提议、已接受、已弃用、已取代
  • 背景：需要做出决策的情境
  • 决策：选定的解决方案
  • 后果：正面和负面的结果

ADR 模板

模板位于 $SKILL_PATH/templates/adr-template.md：

# [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 目录检测

可检查的常见 ADR 目录：

  • doc/adr/（默认）
  • docs/adr/
  • docs/architecture/decisions/
  • architecture/decisions/

流程示例

创建新的 ADR：
/adr new "Use PostgreSQL for primary database"
列出所有 ADR：
/adr list
搜索 ADR：
/adr search "database"
查看指定的 ADR：
/adr view 5

评论

支持 Markdown