SuperAPI AI 工具集

adr-code-traceability

通用与其它

查看项目

更新于 10-16 00:20

技能介绍

用途:为代码添加架构决策记录(ADR)引用,实现决策可追溯,并提供各语言的引用模式与放置指南。

主要能力:给出引用格式 ADR: {adr-id},路径推导示例:ADR: 2025-12-01-my-feature → /docs/adr/2025-12-01-my-feature.md。提供语言模式摘要:Python 新文件头用 """...\n\nADR: {adr-id}\n""",行内注释用 # ADR: {adr-id} - reason;TypeScript 新文件头用 /** ... \n * @see ADR: {adr-id} */,行内注释用 // ADR: {adr-id} - reason;Rust 新文件头用 //! ...\n//! ADR: {adr-id},行内注释用 // ADR: {adr-id} - reason;Go 新文件头用 // Package ... \n// ADR: {adr-id},行内注释用 // ADR: {adr-id} - reason。

使用方式:按放置决策树判断——若为 ADR 创建的新文件,在文件头添加引用;否则若变更非显而易见,添加带原因的行内注释;否则跳过。触发场景包括创建新文件、记录非显而易见实现选择、用户提及 ADR traceability、code reference、document decision,以及在 /itp:go 第一阶段添加决策上下文。

限制:不要为每一行、琐碎变更(格式、拼写)、标准模式、测试文件(除非测试方法本身是 ADR 决策)添加引用。常见问题:ADR 未找到多为路径格式错误,应使用仓库根目录相对路径;引用不显示多为注释语法错误;引用过多属过度记录;链接过时需更新为当前 ADR 文件名。该技能为自进化型,仅在问题真实可复现时更新文件。