SuperAPI AI 工具集

doc-updates

写作与研究

查看项目

更新于 10-15 17:20

技能介绍

用途:在代码变更后同步更新文档,覆盖 README、计划、wiki 与 docstring。使用前需先运行 Skill(sanctum:git-workspace-review) 获取变更上下文。

主要能力:通过合并检测识别冗余;按目录执行不同风格规则(docs/ 严格,book/ 宽松);校验版本号与组件数量;在支持的 Claude Code 版本中通过 LSP 做语义文档验证;用 Skill(scribe:slop-detector) 检测 AI 生成痕迹;审计 plugin.json 与磁盘注册是否一致;同步能力文档。

使用方式:按 TodoWrite 项推进——收集上下文、确定目标、检查合并、应用编辑、验证规范、扫描 slop、同步插件、同步能力、验证准确性、预览。常用命令包括 head -100 CHANGELOG.md、jq 读取 plugin.json 版本、uv run --with pyyaml python scripts/slop_score.py --audit <edited-files>、make docs-sync-check。slop 分数超过 2.5 时可运行 Agent(scribe:doc-editor) --target [file]。

适用场景:代码改动需要对应文档更新时;需要检查文档冗余、风格、版本与计数准确性时。

限制:README 专属更新应改用 update-readme;复杂多文件合并应改用 doc-consolidation。合并、删除、拆分文件需用户批准。可用 --skip-consolidation、--skip-slop、--strict、--book-style 等标志。准确性警告默认非阻塞。LSP 增强需设置 ENABLE_LSP_TOOL=1(2.0.74+)。