SuperAPI AI 工具集

walkthrough

办公与效率

查看项目

更新于 10-16 04:08

技能介绍

用途

Walkthrough 用于为某项功能、原型、工作流或已完成的任务创建引导式演示,向读者展示这项工作能做什么、为什么有用,以及如何亲自尝试。它支持浏览器应用、桌面工具、终端工作流和非交互式输出。

使用当前任务作为范围;一次 walkthrough 请求并不意味着新的实现、部署或完整的测试矩阵。

主要能力

  • 选择并验证演示故事:从请求和项目文档中识别受众、收益和最短有用路径。仅在缺失的选择会改变演示时才提问。对于原型,解释设计选择并标明模拟数据;对于已完成的工作,演示可观察的结果及其限制。
  • 发现当前环境:从仓库或运行中的应用获取启动说明、URL、工作树、输入和已授权账户。启动服务时阅读其本地开发说明。不使用记忆中的端口或记录 ID。选择现有的安全示例数据并先检查它。不为了改善故事而重置数据库或播种大量数据集。
  • 执行选定流程:使用可用的浏览器、桌面或终端工具执行。对于需要认证的浏览器工作,在可用且允许时使用用户的正常会话。观察每个操作的结果。如果核心流程失败,如实报告,不把指南写成成功的样子。

使用方式

编写指南时,将 walkthrough.md 保存在项目既定的文档位置或用户选择的产物目录中。指南应包含:

  • 收益以及读者将学到什么;是可用功能还是原型。
  • 起点、前置条件和安全的示例输入。引用登录说明,但不把凭据写入指南。
  • 带可见标签或精确命令的编号操作,以及每步的预期结果。对于非交互式产物,说明应关注什么。
  • 实际观察到的范围以及任何遗留限制。
  • 录制时,提供简短场景旁白和成品视频链接。

根据观察到的实际工作流修正指南。遵循仓库的写作约定,不要求另一个项目的文档技能。仅在要求时暂停等待脚本审查。

视频与交付

当请求视频时,如果已安装 video-walkthrough 则使用它;该技能负责捕获、可选旁白、组装和播放验证。否则使用可用的录制器生成并检查真实视频,或报告缺少录制能力。仅书面指南不满足视频请求。除非本仓库要求,否则不要求每个 PR 都附带视频。

在最终回复中链接指南和任何录制内容;说明实际演示了什么。对于请求的 PR 交接,仅当审阅者可访问时才将这些链接添加到 PR;本地文件路径不是共享的观看 URL。发布或通知他人需要用户授权。遵循仓库的提交策略,将原始媒体和凭据排除在 Git 之外。成功的 walkthrough 是所演示流程的证据,而非 QA 批准。

适用场景

  • 需要向他人展示某个功能、原型或工作流如何运作。
  • 需要为已完成任务提供可复现的分步说明。
  • 需要为浏览器应用、桌面工具或终端工作流生成演示。
  • 需要附带视频的演示(需具备相应录制能力)。

限制

  • 不隐含新的实现、部署或完整测试矩阵。
  • 不重置数据库或播种大量数据集。
  • 不使用记忆中的端口或记录 ID。
  • 不将凭据写入指南或提交到 Git。
  • 发布或通知他人需要用户授权。
  • 仅书面指南不满足视频请求。
  • 成功的 walkthrough 不代表 QA 批准。
  • 具体安装命令、收费、价格、平台支持等信息暂未提供。