SuperAPI AI 工具集

sync-specs

写作与研究

查看项目

更新于 10-16 01:36

技能介绍

用途:在代码变更可能使文档过时、需要审查文档一致性,或用户要求同步/审计文档时使用。它会审查代码变更并更新项目文档。

模式:delta(默认,无参数或输入 delta)以 origin/main 的 merge-base 为基准,对比分支变更与工作区改动;full(输入 full audit 或 full sync)对全部文档做完整审计;也可输入范围关键字(如 db、api)做定向检查。

delta 模式用 git diff --name-only $(git merge-base HEAD origin/main)...HEAD,加上 git diff --name-only --cached 与 git diff --name-only 收集变更文件,再按影响映射定位需更新的文档:如路由、前端页面、运行时、schemas、package.json 脚本、新目录、配置生成器、认证改动、文档文件增删等各有对应文档。

交叉引用对:需校验 CLAUDE.md 与 AGENTS.md 的 Commands、Documentation Map 路径、Hard Rules,ARCHITECTURE.md 的 monorepo 布局,以及各 specs 索引与实际文件的一致性。

范围过滤关键字包括 db、api、frontend、commands、architecture、security、links、guides、designs、exec-plans、product-specs,分别检查对应源与文档。

规则:不删除前瞻性文档,不确定时询问;保留原文语言与风格;后端 API 以 apps/controller 为准;每次更新后校验 CLAUDE.md 与 AGENTS.md 一致;不自动提交,只呈现 diff 摘要。

流程:确定模式,delta 下收集变更文件,映射受影响文档,逐份比对代码,检查交叉引用,报告过期/缺失/不一致项,经用户同意后修复并再次校验。