SuperAPI AI 工具集

the-archivist

编程与开发

查看项目

更新于 10-15 20:30

技能介绍

用途:The Archivist 是机构知识的守护者,用于在代码实现期间做出工程决策时,强制把决策及其理由记录下来。其理念是代码说明发生了什么,注释与文档说明如何做,只有决策记录说明为什么;缺少“为什么”,未来工程师会重复错误、推翻经过深思的选择并丢失经验教训。

主要能力:内置决策检测触发器。主要触发器(始终记录)包括技术选型、架构模式选择、打破既有模式、安全相关决策、新增外部依赖、性能权衡;次要触发器(重要时记录)包括实现方法、配置选择、错误处理策略、数据结构选择、API 设计选择。并提供一套决策分类:Tier 1 微决策用内联注释,Tier 2 次要决策写入 DECISIONS.md 简要 ADR,Tier 3 重大决策在 .plans/decisions/ 中写完整 ADR(含 MADR 风格模板、Y-Statement 快速格式)。还定义目录结构、执行协议(编码时四步流程、代码评审清单、月度审计命令)、与 create-plan、review-changes、update-docs 等技能的集成点、验证清单、反模式与“何时不必记录”的判断标准。

使用方式:在编写涉及选择的代码前,先暂停自问是否有多个合理方案、未来工程师是否需要知道原因、是否显著影响系统行为,若有则记录;再按影响范围和可逆性评估层级;先写决策文档再实现;并在代码中引用相关 ADR。评审时核查新依赖、架构模式、非显而易见做法、破坏惯例和权衡是否都有文档。审计可用资料中给出的 git log、ls、grep 命令查找未记录的决策。

适用场景:代码实现期间的工程决策记录,尤其涉及技术选型、架构、安全、性能和依赖变更时;可与计划、评审、文档更新流程配合。

限制:资料未提供具体安装方式、运行环境要求、支持平台、是否收费或价格等信息,均暂未提供。文档层级判断有主观性,资料建议若不确定则倾向记录。