SuperAPI AI 工具集

sync-docs

办公与效率

查看项目

更新于 10-15 20:09

技能介绍

用途:让仓库中已有的持久文档与代码/仓库现状保持一致;在用户点名新增时,可新建 .agents/docs/ 自定义文档并写入根 AGENTS.md 索引。

范围与触发:.agents/docs/ 下所有已有文件都在范围内。仅用户显式调用、由 rush 编排触发,或未走 implement 的直接改文件可能让已有文档撒谎时使用;不由 review 自动触发。走 implement / rush 时文档对齐在实现当轮完成(架构级变更由 rush 派本技能处理),review 只检查有没有漏。

路径选择:参数或用户原话要求新增文档(含「新增一个…文档」)走新增路径,其余走对齐路径;两者同时命中则都做。

新增路径:只在 .agents/docs/ 下新建用户自定义文档,路径为 .agents/docs/<NAME>.md,NAME 用大写短横线(如 TEAM-RULES.md);已存在则改为更新正文,仍确保索引行在。可从用户原话确定的不要再问,缺文件名、何时读或正文内容时用交互式提问询问。不要新建 setup 必有项(PROJECT.md;代码类还有 ARCHITECTURE.md、DEV-STANDARDS.md、CODE-MAP.md、SMELLS.md)和 ACCEPTANCE.md。正文只写该仓库要执行的内容,不写教程。在根 AGENTS.md 文档表追加一行:| .agents/docs/<NAME>.md | <何时读> | <何时更新> |,何时更新默认 sync-docs;不可删改模板规定的必有行,不可在 AGENTS.md 写正文。非代码也可新增自定义文档,但不要因此去写代码类必有 docs。

对齐输入:由 rush 派发(任务书点名变更)时以点名条目为准,不问用户;用户点名改某份文档或给出类别/架构/规范/地图等变更时以用户原意为准;用户给了路径则只据这些路径判断;否则用 git 取工作区和暂存区变更(git status --porcelain、git diff --name-only、git diff --cached --name-only 并集去重),忽略 .agents/cooking/。没有点名变更、没有路径、工作区和暂存区都无变更时,用交互式提问问用户要对照哪次提交或哪些文件,不要自动取最近一次提交。

改动原则:只改被推翻或被点名的句子/节,不重写全文;非代码不要打开代码类 docs(盘上有残留也一样),除非用户点名那一份。PROJECT.md 在类别、组织结构、全栈形态被推翻或被点名时才改;改成代码↔非代码时停止并让用户 setup。ARCHITECTURE.md 在架构级变更或业务/技术架构说错、被点名时才改,改了架构则同步 CODE-MAP.md。DEV-STANDARDS.md 仅用户点名改规范/偏好,禁止从代码推断新规范。SMELLS.md 与 smells.md 不一致则原样覆写,禁止按项目改写、追加或删条。CODE-MAP.md 只改相关行。ACCEPTANCE.md 有且被说错或被点名才改。其它已有文档(技能、包/模块 AGENTS.md、模块约定)说错才改。拿不准时用交互式提问询问,不要猜;子代理环境没有该工具则跳过并在结束汇报中列出。

禁止:不写业务代码,不改 cooking;根 AGENTS.md 只动文档表(可追加或修正自定义行,不可删改模板必有行,不可写入正文);除新增路径外不新建文件。

结束汇报:对照了哪些路径、新建/改了 .agents/docs 里哪几份、根 AGENTS.md 是否追加索引行、其它已有文档改了哪几份、是否需要 setup;没有改动就说没有。