用途
melech-plan-review 用于在用户批准某个方案之前,先让他们预见该方案会带来什么变化。它把方案呈现为类似 GitHub 变更标签页的评审界面:一个文件树,里面是红绿两色的伪代码,用户可以像审阅 PR 一样对具体内容做内联评论,最后给出批准、已评论或拒绝的结论。
主要能力
- 以文件树形式展示方案将带来的变更,用类似 git diff 的红绿行表示。
- 页面面向用户或产品读者,不要求他们深入代码细节。
- 每个文件部分用蓝色 @@ 段落 @@ 行标记,并按 diff 方式缩进。
- 行为是重点时写一句话说明;句子不如代码行易读时,写一行简短代码。不粘贴周边实现。
- 支持内联评论:评论会保存到页面旁的 JSON 文件中。
- 提供三选一的结论流程:Approve、Commented、Rejected。
使用方式
- 将 template.html 复制为 <plan-name>-plan-review.html,放在方案文件旁边;如果方案只存在于聊天中,则放在仓库根目录。填充其中所有 {{TOKEN}}。
- 使用与本文件同目录的 scripts/review_server.py 在后台提供页面:
python3 <skill-dir>/scripts/review_server.py <plan-name>-plan-review.html
该脚本会打开页面,并打印 URL 和评审文件路径。读者撰写评论时,评论会保存到页面旁的 <plan-name>-plan-review.json。
-
等待结论。用一个问题提供三个选项:Approve、Commented、Rejected。如果有提问工具就使用它;否则在聊天中提问并结束本轮。
-
用户回答后,读取评审文件。文件包含一个总体摘要和若干评论。每条评论有一个正文,以及它指向的位置:文件、行号和用户选中的引用。一条评论可以指向多行,也可以指向多个文件中的位置。文件为 null 表示页面头部。
结论处理
- Approve:方案成立。合并任何评论,然后停止服务器。除非用户要求,否则不要开始实施。
- Commented:在聊天中逐条回复评论,在评论要求处修改方案,并重写页面。将评审文件重命名为 <plan-name>-plan-review-<round>.json,请用户刷新标签页,然后再次询问。
- Rejected:阅读评论了解原因。如果没有评论,询问哪里有问题。在方向明确之前不要重写页面。停止服务器。
适用场景
适合在实施前需要用户或产品相关方确认方案变更的场合,尤其是希望以直观的变更视图而非完整代码来沟通方案时。
限制
资料未提供关于收费、价格、平台支持范围、效果保证等方面的信息。