SuperAPI AI 工具集

sync-docs

写作与研究

查看项目

更新于 10-15 16:42

技能介绍

用途:将文档与代码状态同步,适用于用户要求更新文档、检查文档、修复过时文档、更新 changelog,或代码变更之后。它把发现、分析和 CHANGELOG 更新整合为一个工作流。

主要能力:按范围获取变更文件,查找引用这些文件的文档(README.md、CHANGELOG.md、docs/*.md),分析版本不匹配、已移除导出、过时代码示例、导入路径变化;通过 repo-map 找出未被任何文档提及的导出(undocumented-export);检查 ## [Unreleased] 与提交信息的对应关系。输出类型包括 outdated-version、removed-export、code-example、import-path、undocumented-export,并以带标记的 JSON 返回。

使用方式:参数为 [report|apply] [--scope=all|recent|before-pr] [--include-undocumented]。mode 默认 report,scope 默认 recent。基础命令示例:git diff --name-only origin/main..HEAD 或 git diff --name-only HEAD~5..HEAD;全量扫描用 git ls-files '*.md'。代理侧流程为:获取变更文件、用 Grep 在 *.md 中搜索文件名/函数名/类名、逐份分析问题、检查 CHANGELOG、若存在 repo-map 则加载以获取准确导出列表。

限制:该技能自身不直接应用修复,只返回结构化数据,由编排器决定后续操作;report 模式不会修改文件,仅 apply 模式可能产生变更。无 git 时无法检测变更;未找到文档时会返回空 docFiles 并建议创建 README.md;无变更文件时建议使用 --scope=all。未安装 ast-grep 时自动回退到基于正则的导出检测,准确度较低。其他平台支持、收费与价格信息暂未提供。