SuperAPI AI 工具集

the-archivist

编程与开发

查看项目

更新于 10-15 20:30

技能介绍

用途:The Archivist 是面向代码实现阶段的决策记录技能,角色定位为“机构知识的守护者”。它要求在写代码前先识别需要记录的工程决策,确保未来的工程师能看到选择背后的理由,避免重复犯错或推翻经过深思熟虑的设计。

主要能力:提供决策检测触发器(如技术选型、架构模式、破坏既有模式、安全决策、新增外部依赖、性能取舍等),并用检测问题判断是否需要记录;将决策分为三层——Tier 1 微决策用行内注释,Tier 2 次要决策用简要 ADR,Tier 3 重大决策用完整 ADR。提供行内注释、DECISIONS.md 条目、MADR 风格完整 ADR、快速 Y-Statement 等模板,以及代码评审检查清单、周期性审计命令。

使用方式:在写代码前先暂停并自问是否存在多个合理方案、未来工程师是否需要知道原因、是否显著影响系统行为;据分层流程选择记录级别;先写决策文档再写实现代码,并在代码中引用决策工单。决策以带 decision 标签的工单存储,可用 tk list --tag decision 浏览;评审时检查是否缺少决策文档;审计可用 git log --since="30 days ago" --name-only --oneline 等命令。

适用场景:涉及技术选型、架构模式、安全决策、性能取舍、新增依赖等工程判断的实现过程;与创建计划、代码评审、更新文档等技能配合使用。

限制:决策工单一旦被接受即不可修改,只能通过新工单取代旧工单;并非所有选择都需正式记录,变量命名、框架惯例、语言惯用法、已有 ADR 覆盖的内容、临时原型代码通常无需记录,可用“撤销耗时少于 5 分钟且影响少于 10 行”作为判断启发。具体工具集成与执行细节以资料所述为准,资料未提供收费、平台支持或其他未提及信息。