SuperAPI AI 工具集

adr

写作与研究

查看项目

更新于 10-15 22:41

技能介绍

用途:该技能提供统一接口来管理架构决策记录(ADR),即记录项目开发中重要架构决策的简短文档,帮助团队记录决策背景与理由、追踪架构选择演变、方便新成员上手,并在推进前将已定决策标记为最终状态。

主要能力:通过 /adr <ACTION> [ARGUMENTS] 调用,支持以下动作:init [DIRECTORY] 初始化 ADR 目录结构;new <标题> 创建新 ADR;supersede <参数> 创建替代现有 ADR 的新 ADR;list 列出项目内所有 ADR;search <关键词> 按内容搜索 ADR;view <编号> 查看指定 ADR。

ADR 结构:每条 ADR 通常包含标题、状态(Proposed、Accepted、Deprecated、Superseded)、背景、决策、后果(正面与负面)。模板位于 $SKILL_PATH/templates/adr-template.md,包含编号与标题、日期、状态、背景、决策、后果(正面/负面)等字段。

目录检测:会检查常见 ADR 位置,包括 doc/adr/(默认)、docs/adr/、docs/architecture/decisions/、architecture/decisions/。

用法示例:/adr new "Use PostgreSQL for primary database";/adr list;/adr search "database";/adr view 5。

适用场景:需要沉淀架构决策、追踪决策演变、团队协作与新人入职时使用。

限制:资料未提供安装方式、平台支持、收费信息及具体实现细节,暂未提供。