教程
Shotomatic Team
约 8 分钟阅读

如何在 Mac 上用分步截图记录软件缺陷

在 Mac 上记录可复现的软件缺陷,包含清晰步骤、截图、环境信息、预期结果和有效证据。

一台显示软件的笔记本电脑,旁边正在准备缺陷报告

本指南介绍如何为软件缺陷收集一组他人可以复现的截图证据。你将记录环境,明确预期和实际结果,捕捉必要操作,清理证据,并在发送前完整测试一次报告。

简而言之: 实用的缺陷报告应包含清楚的起始状态、准确复现步骤、预期和实际结果、出现频率、环境信息,以及第一次可见失败的证据。

先记录环境

环境信息告诉审核者问题在哪里发生。记录应用版本、macOS 版本、设备类型、账户或权限状态,以及会改变行为的设置。

信息要具体到能够还原条件。“最新版本”会在下次发布后变得含糊,而“macOS 15.5 上的 Shotomatic 1.8.2”之后仍然有用。

适用时包含以下字段:

  • 应用和构建版本;
  • macOS 版本;
  • Mac 型号或处理器架构;
  • 账户类型或方案;
  • 浏览器及其版本;
  • 外接显示器或输入设备;
  • 相关权限和功能设置;
  • 网络状态。

写明预期和实际结果

审核者阅读步骤前,结果对照就能界定问题。用一句话说明应该发生什么,再用一句话说明实际发生了什么。

应描述可观察的结果,不要先下诊断。“PDF 导出按钮没有响应”是证据;“导出服务坏了”则假设了尚未确认的原因。

例如:

预期: 选择 Export PDF 后打开保存对话框。

实际: 选择 Export PDF 后菜单关闭,但没有出现保存对话框,也没有生成文件。

在结果旁写明出现频率:每次出现、偶尔出现,还是只在某个先前操作后出现。

从已知起始状态复现

明确的起始状态能排除报告中未写出的设置。捕捉序列前,关闭并重新打开应用、新建测试数据,或重置相关设置。

先从该状态确认一次缺陷。如果问题不再出现,应记录发生了哪些变化,不要仅凭记忆硬写出一套看似确定的步骤。

每个必要操作截取一张图片

每张截图都应帮助审核者重复下一个操作,或识别失败。截取起始状态、每次必要点击或输入、第一次错误状态,以及会影响判断的错误消息。

不影响结果的操作可以省略。把窗口挪到一边或打开无关面板只会增加干扰,除非这些操作本身就是触发条件。

使用 Action Capture 时,从干净状态开始,按正常速度复现问题。Shotomatic 会在每次有效点击前保存目标状态并标记点击位置,因此捕捉序列可以作为复现步骤的初稿。Free 会话可保存 5 个步骤;Pro 取消会话步骤上限。

添加解释状态变化的文字

简短文字应解释截图本身无法展示的信息。写明控件名称、需要输入的数值,以及操作后预期出现的变化。

可以按以下形式编写步骤:

  1. 操作: 选择 Export PDF
  2. 预期检查点: 打开保存对话框。
  3. 观察结果: 菜单关闭,但没有出现对话框。

不要写“点击这里”这类只会重复可见标记的文字。点击标记已经说明位置;句子应告诉审核者控件是什么,以及接下来要观察什么。

保护私密信息

报告离开测试环境前,应移除私密信息。尽量使用样本账户和测试数据,因为从源头替换数据比之后遮盖更安全。

无法避免真实数据时,裁掉无关区域,并模糊姓名、邮箱地址、消息、令牌、许可证详情、客户记录和通知预览。同时保留足够的周边界面,让审核者能识别画面。

请另外进行一次遮盖检查,专门判断哪些内容应裁剪、模糊或改用样本数据。

使用这套缺陷报告结构

以下结构能保证报告完整,又不会变成长篇叙述:

标题:

环境:
- 应用/构建版本:
- macOS/设备:
- 账户或权限状态:
- 相关设置:

预期结果:

实际结果:

出现频率:

前置条件:

复现步骤:
1.
2.
3.

证据:
- 每个必要操作的截图
- 第一次可见的失败
- 相关错误消息或日志

临时解决办法:

补充说明:

这是一套写作结构,并不是可以导入 Shotomatic 的模板。请把它复制到团队现有的问题跟踪或支持系统中。

发送前测试报告

最后一次复现能发现遗漏的前提。从报告列出的环境开始,只按照书面步骤操作,不要依靠记忆。

当同一序列能到达所述结果、所有必要数值都已写明,而且截图按正确顺序展示正确画面,报告才算完成。如果某一步依赖时序或动作,可以附一段短录屏作为补充证据,但书面序列仍应是主要参考。

Action Capture 可以收集点击序列,但报告仍需要环境、预期结果、实际结果和出现频率。通用捕捉和编辑流程见如何在 Mac 上根据点击制作分步指南

Frequently Asked Questions

相关文章

查看更多文章

把点击操作整理成清晰的分步指南

Action Capture 会按顺序记录每次点击。之后可在 Mac 上编辑并导出指南。

如何在 Mac 上用分步截图记录软件缺陷 | 博客 | Shotomatic