用途
feature-walkthrough 面向需要向他人解释一个功能分支如何运行的场景。它要回答的问题是:如果跟着这个功能实际执行一次(一次请求、一条命令或一个后台任务),哪些代码按什么顺序运行、为什么这样运行。它不写规格摘要,也不写 PR 描述,而是沿着真实代码路径逐站讲解。
主要能力
- 固定审查目标:要求提供精确的提交哈希、仅包含该功能的 diff 范围(如有合并提交需排除)、相关规格文档和 ADR。走查只使用规格中“领域语言”表里的术语。
- 结构化产出:文档按固定结构组织,包括一句话概述、功能文件树(ASCII,标注新增/修改)、按真实执行顺序的主路径说明(每站附 file:line)、第二参与者或路径的时序图、数据变更的 ER 图与状态图、测试覆盖说明、本地试用命令、最多三条令读者意外的点。
- 可视化:使用 plain-visual-docs 约定生成 ASCII 或 Mermaid 流程图、时序图、ER 图和状态图,并要求每个 Mermaid 块通过校验器验证。
- 可委派:环境中有子代理时,可将写作交给一个只读子代理,并在任务说明中列出需加载的约定技能,避免主上下文膨胀;无子代理时按同一说明自行撰写。
- 引用校验:提供 check_walkthrough.py 脚本,检查引用是否越过文件末尾、文件在指定提交中不存在或缺少路径,并统计 Mermaid 块数量与文档长度。
- 只读约束:对仓库只读,仅允许写入 .scratchpad/<slug>/walkthrough.md 及该目录下的临时脚本,不使用 /tmp。
- 交付方式:在聊天中给出路径、各节内容概述和检查结果,并可询问是否以 PR 评论形式发布。
使用方式
- 准备:收集提交哈希、功能 diff 范围、规格与 ADR、读者语言。
- 写作或委派:按给定任务模板填写功能名、读者、仓库路径、分支、提交、diff 范围、需加载的技能、先读文件及文档结构,并遵守引用需带完整路径、推断内容标记“not run”、文档长度约 150–300 行、不重复规格表格等规则。
- 检查:运行 check_walkthrough.py 校验引用,渲染全部 Mermaid 块,实测标记为“not run”的断言,并检索领域语言“避免”列中的词汇。
- 交付:在聊天中说明路径与各节内容,提供检查结果,并询问是否发布为 PR 评论;除非用户要求,不提交。
适用场景
适用于功能分支评审前的知识传递、新成员理解某功能执行路径、PR 中附带可读的代码走查,以及需要验证代码引用准确性的文档写作。
限制
该技能依赖项目内约定技能(如 plain-visual-docs、no-slop-code、scratchpad-working-files、simplified-technical-language)与测试环境;子代理、校验脚本的具体路径和行为以技能所在环境为准。资料未提供独立命令行工具、收费模式、支持平台或性能数据,暂未提供。