可以直接复制的
Bug 报告模板。
好的 Bug 报告模板,能让开发者读完一遍就动手复现:发生了什么,原本预期什么,步骤是什么,在哪里出现。把下面的模板复制到文档、表单或任务跟踪工具里,或者在一块同样能接收文件的看板上设置同样的字段。
Bug 报告模板
七个问题。标题和复现步骤设为必填,其余选填。
标题
哪里出了什么问题。一句话。
例如:导出 CSV 时下载到的是空文件
发生了什么?
用一两句话描述您看到的情况。
您原本预期什么?
本来应该发生什么。
复现步骤
1.
2.
3.
多久出现一次?
每次都出现、偶尔出现,还是只出现过一次。
在哪里出现?
浏览器或应用版本、操作系统、账号或工作区。
有什么可以给我们看的吗?
截图、录屏、日志、HAR 文件。
Bug 报告示例
同一份模板,填好之后的样子。产品和数字都是虚构的。
标题
导出 CSV 时下载到的是空文件
发生了什么?
我在“报表”页面点了“导出”。文件下载下来了,
但里面只有表头那一行。
您原本预期什么?
屏幕上表格里显示的 214 行数据。
复现步骤
1. 打开“报表”,选择“最近 30 天”。
2. 按套餐“Scale”筛选。
3. 点击“导出”,再选 CSV。
多久出现一次?
开着筛选时每次都出现。不筛选时导出正常。
在哪里出现?
macOS 15 上的 Chrome 141。工作区:northwind。
有什么可以给我们看的吗?
export.csv(那个空文件)、reports.har
每个字段为什么在那里
- 标题。 哪里出了什么问题,这样报告日后还找得到,重复的报告也才能彼此碰上。
- 发生了什么? 用报告者自己的话描述现象,赶在任何人加以解读之前。
- 原本预期什么? 有一半的报告其实是误会,这一行能看出是哪一半。
- 复现步骤。 这是开发者猜不出来的部分。编好号,一步一个操作。
- 多久出现一次? 每次都出现,问题多半在逻辑;偶尔出现,多半在时序或数据。
- 在哪里出现? 浏览器、版本和账号,比任何描述都更能缩小排查范围。
- 有什么可以给我们看的吗? 一段录屏或一份日志,抵得上三段文字。
把模板变成 Bug 提交表单
Bug 提交表单问的应该比模板少。每多一个必填项,就会少收到一些报告;而少一份报告的代价,比少一个细节大。
- 只把标题和复现步骤设为必填,别的都不必。
- 在每个字段的提示语里放一个例子,让用户知道您想要多详细。
- 提交之前先显示相似的报告,让用户投上一票,而不是再写一条重复的。
- 允许把文件直接拖到表单上来添加附件。
- 说清楚接下来会怎样:报告会出现在哪里,答复会以什么方式送到。
Bug 报告该附上什么
证据能让来回沟通短很多。下面这些文件值得向用户要,每一种能说明什么也一并列出。
- 截图,适用于一切看得见的问题。
- MP4 格式的录屏,适用于步骤很难用文字讲清的情况。
- HAR 文件,适用于页面加载、保存或导出失败。
- TXT 或 LOG 格式的控制台日志或服务器日志。
- EML 格式的邮件原件,适用于投递和格式方面的问题。
- 导入不进去的 CSV、XLSX 或 JSON 文件,或者导出来有问题的那一个。
在 Kjerr 看板上收集 Bug 报告
Kjerr 的看板可以提出模板里的这些问题,并保存证据。看板背后的反馈跟踪工具会让团队看到有什么新动态。
- 表单可以编辑:把“复现步骤”“预期结果”和“出现位置”加成自己的字段,总共最多 10 个字段,每个都可以设为必填或选填,并有各自的提示语。
- 每份报告或每条评论最多 5 个文件,每个不超过 10 MB:图片、PDF、EML、TXT、LOG、CSV、JSON、HAR、ZIP、DOCX、XLSX、PPTX 和 MP4。
- 输入标题时,相似的报告会立即出现,每条旁边都有投票按钮。
- 如果是给测试团队用的看板,可以把它设为仅限成员,并只允许公司的邮箱域名登录,做法和在线意见箱一样。
- 状态改为 Shipped 时,报告者和每一位投过票的人都会收到邮件。
- 它不是缺陷跟踪工具:没有负责人、严重级别和迭代。
常见问题,直接回答。
什么是 Bug 报告模板?
Bug 报告模板是一组固定的问题,让每一份报告都交代同样的事实:发生了什么,原本预期什么,怎样复现,在哪里出现。有了它,开发者读完就能动手复现,不必再来回追问。
一份 Bug 报告应该包含什么?
一句话的标题,发生了什么,原本预期什么,带编号的复现步骤,出现的频率,运行环境,以及截图或日志之类的证据。如果只能有两项必填,就选标题和复现步骤。
Bug 报告和功能需求有什么区别?
Bug 报告说的是产品没有做到它承诺的事。功能需求要的是它从未承诺过的东西。两者要问的问题不同;后者请用功能需求模板。
怎样写好复现步骤?
从一个谁都能到达的状态开始,一行只写一个操作,并写明您输入或选择的确切内容。写到问题出现的那一步为止。如果某一步有时需要、有时不需要,也请说明。
HAR 文件是什么,该不该附上?
HAR 文件记录了一个网页发出的所有请求,可以从浏览器的开发者工具里保存下来。页面加载、保存或导出失败时,请附上它。附上之前先检查一遍:里面可能包含会话 Cookie 和个人数据。
Kjerr 能代替缺陷跟踪工具吗?
不能。Kjerr 负责收集报告、去除重复,并在状态变更时通知报告者。它没有负责人、严重级别和迭代,也不与 Jira 或 Linear 同步。团队把它当作前门,缺陷跟踪工具仍然留在门后。
相关页面
给用户一个答复。
早期体验阶段,Kjerr 完全免费:包含全部功能,无需信用卡。日后推出付费套餐时,将按工作区计费,绝不按管理员席位计费。