SuperAPI AI 工具集

goclaw-docs-audit

通用与其它

查看项目

更新于 10-16 01:36

技能介绍

用途:在 GoClaw 源码变更后,找出需要同步更新的 GoClaw 文档页面,并核对文档内容与源码文档(source of truth)是否一致,同时检查英文、越南语、中文版本的同步状态。

触发方式:/goclaw-docs-audit、/goclaw-docs-audit <commit-range> 或 /goclaw-docs-audit <file1> <file2>。

主要能力:

  1. 识别变更文件:按提交范围(如 HEAD~5..HEAD)、指定文件路径,或自上次审计以来的变更(读取 .last-audit 记录,首次运行回退到 HEAD~1..HEAD)执行 git diff --name-only。
  2. 加载 mapping.json 映射规则,用 glob 匹配变更文件与文档页面,并收集优先级。
  3. 准确性核对:将匹配到的文档页与 $GOCLAW_SOURCE/docs/ 下对应内部文档(如 01-agent-loop.md、03-tools-system.md 等)比对配置字段、API 签名、行为描述,标记差异为 Needs accuracy update。
  4. 多语言同步检查:用 git log -1 --format=%cd --date=short -- <file> 比较 EN、vi/、zh/ 文件最后修改日期,判断 Outdated 或 Synced。
  5. 生成 Markdown 报告,包含受影响文档、准确性核对、EN-VI-ZH 同步状态和推荐操作,保存到 plans/reports/docs-audit-{YYYY-MM-DD}.md,并更新 .last-audit 标记。

必要配置:技能需访问 GoClaw 源码仓库,解析顺序为 GOCLAW_SOURCE_PATH 环境变量,其次回退到 ../goclaw/。示例:export GOCLAW_SOURCE_PATH=/path/to/my/goclaw,或在 .claude/settings.local.json 中设置 env。若均无效则需用户提供路径。

限制:资料未提供安装命令、收费信息、支持平台及实际效果说明;技能依赖本地 git 仓库与 mapping.json 配置,缺少源码路径时无法运行。