git-adr

基于Git笔记的架构决策记录管理工具,无缝集成Git工作流。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:git-adr。
它的用途是:基于Git笔记的架构决策记录管理工具,无缝集成Git工作流。
完整的 Skill 内容见:https://321skill.com/skills/git-adr/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

'帮我为当前提交创建一个关于数据库选型的架构决策记录',它会引导你填写ADR标题和内容,并自动将记录关联到该次提交。或者,当你想回顾项目关键决策时,可以说'列出所有与缓存相关的架构决策',它会快速搜索并呈现结果。

介绍

git-adr 解决了在软件开发过程中,架构决策记录(ADR)难以管理、容易与代码历史脱节的问题。传统文件型ADR工具会污染仓库目录结构,而git-adr创新性地将ADR存储在Git笔记(git notes)中,使决策记录与特定提交关联,随Git历史同步,且不产生额外文件。

使用时,开发者只需在Git仓库中运行 git adr init 初始化,之后即可通过 git adr new 创建决策记录、git adr list 查看列表、git adr search 进行全文检索。所有操作都通过熟悉的Git命令行完成,决策记录可通过 git adr sync 像普通代码一样推送到远程仓库。

该工具非常适合需要规范技术决策流程的研发团队,尤其是后端开发、全栈开发、运维工程师和项目经理。它帮助团队在代码演进的同时,清晰地记录和追溯每一次重要的架构选择及其上下文。

建议在项目早期引入此工具以形成习惯。需要注意的是,由于依赖Git笔记,需确保团队使用的Git版本支持此功能,并且所有成员都安装并配置了git-adr客户端,以便顺利同步和查阅决策记录。

核心特点

与传统的文件型ADR工具(如adr-tools)不同,git-adr将记录存储在Git笔记中,而非独立的Markdown文件,因此不会增加仓库的文件数量,且能精准关联到触发该决策的代码提交。

注意事项

不适合需要脱离Git环境独立查看或编辑ADR文档的场景,也不适合尚未使用Git进行版本控制的项目。

常见问题

git-adr和adr-tools有什么区别?

git-adr使用git notes存储,无文件污染,且能与提交关联;adr-tools生成独立的Markdown文件。

如何与团队成员共享ADR?

使用 `git adr sync --push` 推送笔记到远程仓库,其他成员 `git adr sync --pull` 即可获取。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/git-adr/raw/index.md 读取 git-adr 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。