SuperAPI AI 工具集

docs-sync

写作与研究

查看项目

更新于 10-28 13:24

技能介绍

用途

docs-sync 是一个文档同步审计技能,用于比对 src/ 与 .github/ 下的代码和配置与 docs/ 中的设计文档,检测代码与文档之间的漂移(drift)。它是 @docs-auditor 代理运行的差异比对操作手册,也可以通过 /docs-sync 直接调用。

该技能只生成漂移报告,不写入 docs/ 目录。若要应用修改,需要交由 @author 处理。

主要能力

技能按固定步骤执行审计:

  1. 采集代码快照:按顺序收集 src/data/paths.ts 的导出、src/content/community/*/ 下所有 path.json 文件、src/content/{tutorial,advanced,terminal}/ 下每个 Markdown 文件的前置元数据(id、number、title、subtitle)、src/components/diagrams/ 下的文件列表(不含 index.ts)、.github/{instructions,prompts,skills,agents,hooks}/ 下的文件列表,以及 src/App.tsx 中的路由表。
  2. 采集文档快照:收集 docs/tracks/{foundation,agentic,terminal}.md 中的轨道表格与 docs/community-contributions.md 中的贡献形态表、docs/components.md 中的组件/图表引用、docs/content-architecture.md 第 5 节的自定义语法表与第 2 节的路由表、docs/harness.md 的 harness 清单表格、docs/lifecycle.md 的状态表,以及所有 docs/*.md 文件中的相对链接。
  3. 差异比对:代码中存在但文档缺失的条目应补充到文档;文档中存在但代码中已不存在的条目,若文件确实被删除则从文档移除,若可能只是重命名则标记供人工复核;字段(title、subtitle、status、applyTo 等)不一致时更新文档;相对链接失效时修复链接。
  4. 按 docs/ 下的目标文件对发现的问题分组,每组构成报告中的一个章节。
  5. 按 templates/report.md 模板输出报告,包含日期、审计范围、工作区 git 短 SHA、汇总统计(需更新文件数、待新增条目数、待移除条目数、失效链接数)以及各文件的详细问题与处理建议,最后给出建议的下一步操作(运行 @author 并粘贴报告)。

使用方式

可通过 /docs-sync 直接调用,可传入可选参数 $ARGUMENTS 将审计范围限定为以下之一:paths、tracks、components、syntax、harness、routes、lifecycle、links 或 all(默认 all)。

适用场景

  • 审计 docs 文件夹。
  • 合并结构性变更(如新增内容、调整组件)之后,检查文档与代码是否仍保持一致。

限制与边界

  • 不写入 docs/,仅输出报告。
  • 不更改内容生命周期状态或示例轨道。
  • 不运行 npm run build(这是 @reviewer 的职责);仅在链接存在歧义时以只读方式运行。
  • 当 .github/CONTENT_LIFECYCLE.md 与 docs/lifecycle.md 冲突时,以 .github/CONTENT_LIFECYCLE.md 为准。

相关

  • 代理:docs-auditor。
  • 规范:docs/harness.md。