SuperAPI AI 工具集

simplify-docs

写作与研究

查看项目

更新于 10-16 06:15

技能介绍

用途:对代码注释和 Markdown 文档做多智能体审查,找出多余或失实内容并直接修复。

使用方式: 第一步确定范围。给定 diff 命令(如 git diff --cached)就使用它;给定文件或目录就直接读完整文件;都没有时按当前 git 状态选择 diff 命令。分支属于打开的拉取请求时,用 gh pr view --json baseRefName --jq '.baseRefName' 取基线分支,执行 git fetch origin <base-branch>,再对比 origin/<base-branch>...HEAD。没有 git 改动则默认全树扫描源码文件加顶层 markdown。启动代理前须先列出解析出的文件清单(diff 命令加 --name-only)。

第二步并行启动两个审查代理,均为 model: "opus",须等全部报告后再继续。代理把工作树和 git 索引视为只读,不改 HEAD,用 git show <ref>:<path> 读其他引用,发现写入会话临时目录的唯一命名文件并返回路径。代理提示中不得预设结论。

代理一审查代码注释:错述代码实际行为、位置引用失效、复述代码或签名、叙述历史与变更、会失效的交叉引用、解释语言或框架构造、无价值分节横幅、过长的理由说明、为弥补代码难读而存在的注释。

代理二审查 Markdown 文档:状态更新式措辞、复述代码库已展示的内容、只有 WHAT 没有 WHY、脚手架残留、解释腐化、本可一句话的多段长文。

两次审查都要应用可读性标准:子句堆叠、标点链、密集段落;保留承载因果、条件、对比、限定、范围关系的连接。

第三步汇总并直接修复,跳过误报,拿不准时保留。范围为 diff 时,只改本次变更撰写或证伪的文字。结果用表格报告,列为 File、Finding、Outcome,Outcome 为 Deleted、Corrected、Tightened、Restructured、Rewritten、Flagged 或 Skipped。表格为空时说明文档已干净。最后用 TaskList 工具继续剩余任务。

限制:本技能依赖 git、gh、Agent 与 TaskList 工具;未提供其他平台、收费或效果信息。