SuperAPI AI 工具集

living-documentation

写作与研究

查看项目

更新于 10-16 08:04

技能介绍

Living Documentation 的核心思路是“规格指导生成、代码变更更新规格”。

触发时机:修改实现了 requirements.md 中所定义行为的代码;改动 design.md 中描述的架构或接口;发现尚未记录的边界情况或模式。

生命周期:生成阶段由规格到代码,把规格当作契约遵循;修改阶段由代码到规格,更新规格以反映代码。

同步协议:完成代码变更后,先识别受影响的规格,检查任务的 _writes 清单,映射到具体涉及的 requirements/design 章节;然后更新规格内容,删除过时描述、记录实际实现方式、把新发现的边界情况补充为新的验收标准(AC),并保持规格在脱离代码时仍可阅读;接着添加可追溯性标注,格式为 <!-- impl: path/to/file.ts#FunctionName -->;最后把规格变更与代码变更放在同一次提交中。

需要更新的对应关系:新增函数或模块加入 design.md#Components;行为变化更新 requirements.md 中的 AC;边界情况处理以 EARS 格式新增 AC;架构决策在 design.md 中记录理由;被移除的功能从两份规格中删除。

质量检查清单:规格描述的是当前现实而非最初计划;没有遗留过时章节;新读者仅凭规格即可理解系统;已添加可追溯性链接。

限制:资料未提供具体安装命令、依赖、价格与平台支持信息;该技能依赖 .kiro/specs 目录结构与任务 _writes 清单约定,需在这些前提成立时使用。