SuperAPI AI 工具集

decision-doc-sync

写作与研究

查看项目

更新于 10-15 17:30

技能介绍

用途:在变更引入或修改结构性决策时(架构、UI/UX 标准、脚本或质量门禁、跨领域约定)加载该技能,使既有项目文档与变更后的代码保持同步。

主要能力:按变更类型把内容映射到对应文档:架构、目录结构、脚本对应 README.md;视觉或 UX 标准、tokens、组件用法对应 DESIGN.md;智能体工作流、命令、操作指引对应 AGENTS.md;带有备选方案与后果的持久决策则在 docs/adr/ 中新增记录。一次变更可能同时命中多行。

使用方式:先检查 README.md、DESIGN.md、AGENTS.md、docs/adr/ 中哪些已存在;只更新已存在的文档,仅在规则要求时才新建。每个事实只保留在一处文档,其他文档通过链接引用而非复制。记录决策本身,不记录变更历史。ADR 需沿用 docs/adr/ 中已有的编号与格式,可参考 references/doc-map.md。编辑后需对照代码重读被修改的段落。

输出要求:列出每个被更新、创建或有意跳过的文档,并各附一行理由。

限制:不得在变更后留下与代码矛盾的文档;文档格式、新增条件等细节以技能内的 doc-map 参考为准,其余功能或平台支持信息暂未提供。