SuperAPI AI 工具集

aw-create-walkthrough

智能体与模型

查看项目

更新于 10-16 01:29

技能介绍

用途:在 PR 交付前生成最终总结文档 .agent/{branch-name}/walkthrough.md,汇总已完成的工作,便于评审与交接。

前提条件:所有测试通过;文档已更新;plan.md 存在且 Progress Log 为最新;需位于对应 worktree 内。

主要能力:从 plan.md 提取 Summary、Decisions、Requirements、File Changes 表;从 git 获取分支、差异统计与提交记录;从测试结果确认当前状态;按模板生成 walkthrough.md,包含 frontmatter(created、branch、task、pr)、Quick Reference、Summary、Changes 表、Key Decisions、Testing Results、How to Verify、Next Steps;写完后在对话中直接展示内容。

使用方式:先运行命令确定产物路径并收集 git 信息,不要猜测分支名: BRANCH=$(git branch --show-current) && mkdir -p ".agent/${BRANCH}" && echo "Artifact path: .agent/${BRANCH}/walkthrough.md" && echo "---" && git diff --stat main...HEAD && echo "---" && git log --oneline main...HEAD 读取 plan.md: BRANCH=$(git branch --show-current) && cat ".agent/${BRANCH}/plan.md" 随后按模板写入文件,并在对话中输出内容。时间戳必须使用完整 ISO 8601(YYYY-MM-DDTHH:MM:SSZ)。

适用场景:功能开发或修复完成后,准备提交 PR 时生成交付总结。

限制:需满足上述前提条件;Changes 表须与 git diff --stat 一致;Key Decisions 来自 plan.md;文件与对话内展示两者均为必需,缺一不可。资料未提供其他平台、收费或效果信息。