Impa 审查
在独立的锁定会话中启动技术文档审查,并返回报告。它适用于任何文档,无需作者参与。仅返回发现:绝不会编辑文档或代码,即使被要求“审查并修复”。
不要读取 method.md、checklist.md 或 reference/ 中的任何内容。审查器会自行加载它们,将它们排除在此会话之外正是重点所在。
如果你在此会话中编写或更改了这些文档,请遵循 round.md。
步骤
-
将简报写入
"${TMPDIR:-/tmp}"/impa/<project>/direct-<n>/brief-1.md,其中<n>比上一个文件夹的编号大一。它包含事实,绝不包含你的观点,所以不要先阅读文档:按照 impa 审查方法审查技术文档。不要编辑任何文件。 项目:<绝对路径> 文档:<用户命名的绝对路径,或“找到它们”> 其他来源:<用户命名的依赖项或兄弟仓库的绝对路径,或“无”> 文档计划:<如果项目有,则为 .impa/plan.md 的绝对路径,否则为“无”> 本轮请求(用用户的原话):“<提示>” 范围:<用户命名的范围,或“整个文档集”> 上一轮仍未解决的问题:无 转交他人:无 返回方法的报告。指出你发现的任何超出范围的问题,但不要刻意寻找。 -
在后台启动它。为每个位于
其他来源下的路径添加--add-dir:impa review --brief <brief> --add-dir <project>大型文档集可能需要
--timeout <分钟>,默认超时为 20 分钟。 -
如果命令退出码为 1,说明审查未完成,任何
review-1.md都是不完整的。如果没有review-1.json,或者error以Error: spawn开头,说明无法启动:读取命令的输出,然后使用备用方案。否则,使用更大的--timeout再运行一次。如果仍然失败,告知用户审查未完成,并附带来自review-1.json的error。 -
否则,只读取简报旁边的
review-1.md。按原样返回,并附上命令打印的成本行,然后停止。除非用户要求,否则不要对发现采取行动:修复是此步骤之后的单独步骤。如果review-1.json中的verdict为空,则没有裁定行,因此说明报告不可信。
如果 impa 不在 PATH 中或无法启动,请使用 round.md 第 3 节中的备用方案。如果该方案也无法启动,告知用户未进行任何审查。绝不在当前会话中进行审查。