如何撰写 Bug 报告（附示例）

作者： Lucas Bennett Lucas Bennett
时间 - 权威教程 更新于

什么是 Bug 报告？为什么需要一份好的 Bug 报告？

Bug 报告是 STLC 中的重要文档，它为测试团队提供了各种优势。它跟踪软件测试期间发现的所有缺陷、多个 Bug、错误和其他不一致之处并进行报告。

这个测试后文档的目的是向相关专业团队提供有关测试过程中遇到的 Bug 水平的信息。

通过此类报告，您可以让您的软件开发工程师了解软件中存在的所有缺陷和问题。它还可以帮助您弄清楚 Bug 的问题所在，以便您可以使用最佳方法来修复它。它还可以通过帮助您捕获 Bug 和问题来帮助您节省时间和金钱。

为什么你应该关心好的 Bug 解释？

Good Bug Explanations

以下是您在撰写一份好的、详细的软件 Bug 报告时需要考虑的要点

  • 它作为指南，有助于在未来的版本中避免相同的 Bug。
  • 节省沟通时间（电子邮件、电话）。
  • 减少开发人员的工作量（他们将完全按照您的要求去做）。
  • 您的项目瓶颈会更少；Bug 将得到更快、更有效的修复。

如何撰写 Bug 报告（Bug 报告模板）

没有确切的 Bug 报告模板，因为它取决于您的 Bug 跟踪系统。您的模板可能会有所不同。

但是，当您想写一份 Bug 报告时，以下常见字段是必需的

  • Bug ID/标题。
  • 严重性和优先级。
  • 描述
  • 环境
  • 重现步骤。
  • 预期结果。
  • 实际结果。
  • 附件（屏幕截图、视频、文本）

让我们逐一看看这些 Bug 跟踪组件

1) 标题/Bug ID

每个 Bug 都应获得一个唯一的标识号。Bug 报告工具应为新提出的 Bug 提供唯一的编号，以便我们轻松识别 Bug。

示例

❌ 不好：“我再次看不到产品，再试一次，它就不见了。”

  • 模糊
  • 攻击性
  • 太啰嗦

要求实施解决方案。

✅ 好：“购物车 – 添加到购物车的新项目没有显示”。

  • 这种标题可以立即定位问题（购物车）
  • 它侧重于实际的技术问题。

2) Bug 严重性

Bug 严重性是 Bug 报告中非常重要的一个因素。它描述了缺陷对应用程序性能的影响。

  • 阻碍性：此错误导致应用程序崩溃。
  • 主要：关键错误表明业务逻辑发生了重大变化。
  • 次要：不影响应用程序功能但影响预期结果的问题。
  • 琐碎：不影响应用程序的功能或操作。可能是一个排印错误。

3) Bug 优先级

以下是确定 Bug 优先级的一般分级

  • 高：它包括任何影响流程或阻止应用程序使用的内容。
  • 中：它对用户体验产生不利影响。
  • 低：所有其他错误，例如（拼写错误、缺失图标、布局问题等）。

4) 环境

Bug 可能出现在特定环境中而不出现在其他环境中。例如，有时 Bug 在 Firefox 上运行网站时出现，或者应用程序只在 Android 设备上运行时出现故障，而在 iPhone 上运行正常。

这些 Bug 报告只能通过跨浏览器或跨设备测试来识别。因此，在报告 Bug 时，QA 应能够指定 Bug 是否应在一种或多种特定环境中观察到。

5) 摘要

但是，仅在 Bug 报告中添加标题并不能达到目的。因此，如果您的标题不够，您可以添加一个简短的报告摘要。

您的摘要应尽可能简洁，包括 Bug 发生的时间和方式。您的标题和 Bug 描述也应用于搜索，因此您必须确保已包含重要关键字。

示例:

  • 不好：“我试图将东西添加到测试中，但当我这样做或点击按钮时，什么都没有显示。”
  • 好：“当我尝试将 [产品] 添加到购物车时，但当我在特定产品概览网页上单击‘添加’按钮时，没有任何反应。”

6) 重现步骤

报告 Bug 时，指定重现它的步骤很重要。您还应包含可能导致 Bug 的操作。这里不要做任何泛泛的陈述。

请具体说明要遵循的步骤

以下是一个编写良好的程序的示例

步骤

  1. 选择产品 X1。
  2. 点击“添加到购物车”。
  3. 点击“移除”将产品从购物车中移除。

7) 预期结果

在 Bug 报告中，根据技术任务、测试用例结果设计或根据测试人员的意见描述预期结果很重要。所有这些都有助于开发人员专注于快速查找所需信息。

例如

单击“提交”按钮后，必填字段将以红色突出显示。

8) 实际结果

顾名思义，此字段描述了 Bug 的实际效果。编写实际结果的清晰描述非常重要。

例如

单击“提交”按钮后，必填字段将以绿色突出显示。

9) 附件（屏幕截图和视频）

在 Bug 报告中，最好将文件附加到 Bug 报告中，这样在需要可视化显示信息时会更容易理解。

例如

  • 屏幕截图：屏幕截图可以轻松阐述程序中的错误；当 Bug 用特定注释、圆圈或箭头图像突出显示时，非常方便）。
  • 视频：有时很难用语言描述 Bug，所以最好创建一个视频，以便开发人员可以纠正程序中的缺陷）。

10) 受影响的版本

这是报告 Bug 的受影响软件版本。

11) 修复版本

这是 Bug 已解决的软件版本。因此，当报告 Bug 的 QA 检查它是否已修复时，他会使用正确的软件版本。

12) 目标版本

应将 Bug 定向修复的目标版本。因此，当开发团队处理 Bug 修复时，他们通常会针对特定应用程序版本。

13) 关闭日期

这是软件测试团队关闭 Bug 的日期。关闭 Bug 是软件测试的重要组成部分。

14) 状态

当创建一个新的 Bug 时，它的状态应该是“打开”。之后，它会经历“进行中”、“已修复”、“运行”、“重新打开”等阶段。

相关文章

撰写 Bug 报告的技巧

以下是一些您在编写有效的 Bug 报告时应牢记的重要技巧

  • 在创建 Bug 报告时要具体。确保不包含任何无用或不相关的事实。
  • 一旦检测到 Bug，必须立即报告。
  • 详细准备报告，以便开发人员可以使用事实和信息来调试问题。
  • 您应该测试同一 Bug 在其他类似模块上的发生情况以进行验证。
  • 提交前至少审核一次 Bug 报告。
  • 您应确保 Bug 报告仅包含一个错误描述。
  • 最后，如果您对某些内容感到不确定，请不要害怕向项目经理寻求帮助。

Bug 报告工具

手动执行的 Bug 报告过程，现在正通过市场上各种可用的 Bug 报告工具来执行。

您可以查看我们关于最佳 Bug 跟踪工具的详细评论。

撰写 Bug 报告时的常见问题及解决方案

以下是撰写 Bug 报告时的一些常见问题及解决方案

Bug 报告示例 问题
将 2 乘以 3 时，答案将是正数。 报告模式，而不是示例。
添加新项目时，列表将按字母顺序排序以避免这种情况。 不要只描述错误之处
例如
首先，您需要打开浏览器并输入网站的 URL。您会发现第一个字段“用户名”拼写错误。		 始终直奔主题（切勿讲故事！）。
报告中的客户姓名拼写错误。优先级：高，严重性：高 切勿混淆优先级和严重性。
税款计算公式不正确！！？？ 不要使用大写字母、红色字母、红圈、“！”。
我认为主页 UI 设计不好。 不要使用您的判断。
不清晰描述的示例：关于我们今天的讨论，请对该页面执行必要的操作。 使您的描述人人都能理解。
页面背景应该是蓝色、橙色或绿色，或者您可以将其设为黑色或白色。

这不好，因为它不清楚需要网页开发和设计团队做什么

 最小化选项
税款计算公式有时无法按预期工作。 黄金法则：不要使用“有时”这个词。

Bug 报告示例

这是一个 Bug 报告的小示例

[我的账户] 鼠标悬停在“更新”按钮上时会显示下划线。

描述：我们需要在“我的账户”部分的“更新”按钮上鼠标悬停时删除下划线。

链接： http://test.com/mv-account/

浏览器/操作系统：Chrome 25.OSX Yosemite 10.10.2

重现步骤

1. 前往 www.test.com

2. 使用登录凭据登录

3. 导航到“我的账户”

4. 鼠标悬停在“更新”按钮上

实际结果：有一个下划线。

预期结果：没有下划线。

登录数据：test@test.com / mysecretpass12

撰写 Bug 报告时应避免的错误

以下是您在编写 Bug 报告时应避免的一些重要错误

  • 不要写您的不满，切勿包含您的个人感受。
  • 当您在帖子中充斥着许多表情符号时，会惹恼那些想专注于任务的人。
  • 切勿在帖子中滥用感叹号；它不会加快工作速度。
  • 没有人想感到被冒犯。它会破坏动力并减缓问题的实现。