SuperAPI AI 工具集

plannotator-guide

编程与开发

查看项目

更新于 10-16 03:42

技能介绍

用途:把扁平的改动文件列表组织成有阅读顺序的引导式评审,让评审者一次读完大体量改动。作者负责理解和写作,CLI 负责校验、补充来源信息并生成 HTML。

使用方式:先确定指南覆盖范围并保存对应 diff,例如 git diff origin/main...HEAD > guide.patch(分支)、git diff HEAD > guide.patch(未提交改动)或 git show --format= <sha> > guide.patch(单个提交)。对 PR 可先 gh pr checkout <n> 再与其基线分支比较;从未 git add 的新文件不会出现在 diff 中,需先执行 git add -N <files>。

随后编写 guide.json,包含 title、intent 和 sections。每节有概念性标题、2 至 6 句 overview(说明改了什么、为什么、关键影响,必要时标注风险集中处)以及一个或多个 diff 引用,每个引用需要文件路径和 1 至 2 句 summary。章节按重要性排序而非文件路径;通常 2 至 6 节,最多 10 节。硬性约束:每个改动文件必须且只能出现在一个章节或 unplacedFiles 中,文件路径必须是 diff 中的准确路径;全文不使用 em dash、双连字符和 emoji。

导出命令:plannotator guide export --guide guide.json --patch guide.patch,成功后打印 HTML 文件路径,失败时退出码为 1 并说明是哪个文件不在 patch 中、重复放置或缺少字段;可用 --out <file.html> 指定输出位置。如需链接则用 plannotator guide share --guide guide.json --patch guide.patch,默认端到端加密上传至 guides.show 并打印 URL 与删除令牌,--public 才会存储为未加密。未安装时可用 curl -fsSL https://plannotator.ai/install.sh | bash -s -- --minimal。

限制:这是“解释与定位”而非找 bug 的评审;资料未说明费用、支持平台或与具体模型绑定的情况,也未提供分类相关的更多信息。