SuperAPI AI 工具集

walkthrough

通用与其它

查看项目

更新于 10-16 06:52

技能介绍

用途:在 /goal 等实现及其验证(/review-it、/verify 或手工测试)完成后、/ship-it 之前,生成一份走查文档,让评审者快速了解改了什么、哪些已被证明可用,并在合并前用 Git 做 staging 检查。触发词包括 walkthrough、/walkthrough、生成走查文档。

主要能力:确定变更范围(功能/Issue/分支、涉及哪些仓库);撰写不含标识符的大白话开篇(改前/改后、为什么改);必要时补充术语表;撰写技术变更摘要与关键文件清单;执行并记录验证步骤(终端命令、单元测试、lint/build,以及浏览器自动化走查),并为每条结论标注来源:已实测、代码推断、未验证;捕获截图或录屏作为可视化证据,截图建议以 base64 内嵌;构建 Review Gate,包括 git status、git diff --stat HEAD、git diff --name-status、高风险说明、部署顺序前置(含影响范围)与可直接粘贴的 PR 描述和合并清单。

输出与用法:生成两个同名文件 tasks/walkthrough-[feature-name].md(源文件)与 tasks/walkthrough-[feature-name].html(交付物)。HTML 由随技能附带的脚本渲染:python3 scripts/md2html.py tasks/walkthrough-[feature-name].md,安装后可用 python3 ~/.claude/skills/walkthrough/scripts/md2html.py;脚本依赖 markdown 包,缺失时按提示执行 python3 -m pip install --user markdown。功能名可由用户指定、从分支名推导或询问确定。

适用场景:需要向评审者交付变更证明与摘要的前端或后端改动,涉及 UI 时附带浏览器测试证据,涉及迁移或配置时说明部署顺序。

限制:无法执行时须如实标注未验证;无测试、无 UI 或测试面已红的情况需明确记录并逐条追溯失败所属提交;资料未提供具体功能效果、收费与平台信息。