怎样口述一份同事能复现的 Bug 报告
先用语音记下现场和操作顺序,再补入需要逐字准确的技术细节,最后从接手同事的角度检查工单。
你刚刚第三次复现一个问题,故障画面还在,但两分钟后就要开会。趁操作顺序还记得清楚,先把经过说进一份未发送的草稿。等有时间,再把需要精确拼写和格式的证据补进工单。
一份有用的 Bug 报告,要让没在现场的同事也能照着做一遍。他应该看得懂从哪个页面开始,也知道怎样判断自己看到了同一个问题。可以用语音写经过,用键盘补那些必须和原始资料一致的细节。
先交代测试时的状态
打开临时笔记或未提交的工单。故障窗口先留着,尤其是刷新后可能看不到现场的情况。草稿开头写明与复现有关的条件,比如账号角色、页面、版本或测试环境,以及操作前打开了哪个开关。只写你实际核对过的条件。
比如可以说:“我在测试工作区用编辑者账号操作。项目里原本有一个附件,我从项目页打开了附件面板。”同事读完就知道该准备什么样的项目。只写“上传有问题”,他还得回头问你在哪个页面、什么情况下遇到。
如果问题出现在真实客户账号,条件允许时,用测试数据重新做一遍。需要交代的是数据的特征,例如附件超过某个大小,而不是客户文件里的文字。把工作信息说进云端工具之前,先确认团队规则。拿不准哪些内容可以输入时,可以参考语音输入隐私清单。
按发生顺序说,每步只讲一个动作
用界面上找得到的按钮名称。操作先后会影响结果时,可以分段录入,再把草稿整理成编号步骤。
下面是一个虚构的附件上传问题:
- 在已经有一个附件的项目中打开附件面板。
- 选择第二个文件,等上传进度走完。
- 关闭面板,停留在当前项目页。
- 重新打开面板,对比两条附件记录。
把预期和实际结果分别写清楚:“预期:两个文件名都能看到。实际:第二条记录还在,但文件名为空,刷新页面后才恢复。”刷新能恢复也值得记下来,这可能影响接手同事先查哪里。
只有记过次数,才写出现频率。“在同一版本尝试三次,其中两次出现”比“偶尔出问题”更方便验证。只试了一次就照实写。怀疑原因的话,单独列在备注里,别让读者把推测当成已经观察到的现象。
从原处复制精确值
版本号从应用里复制,报错文案从对应画面复制,测试路径从确认过的笔记里复制。标识符可以用行内代码标出,短日志保留原来的换行。把一长串 UUID 或标点逐个念出来,最后往往还是要对照原文逐字检查。
如果要附截图,裁到能说明问题的范围,检查边缘有没有账号名、私人标签页、通知或客户信息。日志只放经过批准、足以展示问题的最短一段。证据需要放在受限系统时,请有权限的同事到那里查看,不要把它顺手贴到公开工单。
用接手人的视角读一遍
先看标题。“重新打开附件面板后,第二个附件的文件名消失”能让人直接找到测试入口。如果可以安全地重试,就开一个新测试会话按步骤走一遍。检查工单有没有交代用什么角色、看到什么才算触发问题,以及每次测试之间是否清理过状态。
后来没能再次复现,也可以保留第一次的观察,并写下两次尝试之间有什么变化。只要能缩小范围,报告就有价值。可以请同事验证一个具体问题,例如“查看者账号会不会也看到空白的附件行”,这样他知道接下来做什么。
想练习的话,可以编一个小问题,把起始状态和步骤说进备忘录。如果你用的是符合要求的 Mac,可以下载 Whisper One,登录后按快速开始试一段。检查语音稿、手动补入精确值,再提交工单。
