如何撰写错误报告（附示例）

由： 卢卡斯·贝内特 卢卡斯·贝内特
Hours 更新

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

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

此测试后文档的目的是向相关专业团队提供有关测试过程中遇到的错误级别的信息。

你的 软件开发工程师 可以使用此类报告了解软件中存在的所有缺陷和问题。它还可以让您找出错误所在，以便使用最佳方法修复它。它还可以帮助您发现错误和问题，从而节省您的时间和金钱。

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

良好的错误解释

为了编写一份好的、详细的软件错误报告，您需要考虑以下几点：

  • 它可作为指南，帮助避免在未来的版本中出现同样的错误。
  • 节省沟通时间（电子邮件、电话）。
  • Less 为开发人员工作（他们会做你想做的事）。
  • 项目中的瓶颈将会减少；错误将以更快、更有效的方式得到修复。

如何撰写错误报告（错误报告模板）

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

然而，当您想要编写错误报告时，始终需要以下常用字段：

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

让我们逐一看看这些错误修复组件：

1) 标题/错误ID：

每个错误都应有一个唯一的识别号。错误报告工具应该为新提出的错误提供唯一的编号，以便我们轻松识别错误。

例子：

❌ 不好：“我再次看到产品时，我看不到它。”

  • 模糊
  • 进取
  • 太罗嗦

要求实施解决方案。

✅ 好：“购物车 – 购物车中添加了未出现的新商品”。

  • 这种标题可以立即定位问题（CART）
  • 它关注的是实际的技术问题。

2）漏洞严重程度：

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

  • 阻滞剂： 此错误导致应用程序失败。
  • 专业： 严重错误表明业务逻辑发生重大变化。
  • 辅修： 该问题不会影响应用程序的功能，但会影响预期结果。
  • 琐碎的： 它不会影响应用程序的功能或操作。这可能是一个印刷错误。

3）漏洞优先级：

以下是确定错误优先级的一般等级：

  • 高： 它涵盖影响流量或阻止应用程序使用的任何事物。
  • 适用介质： 这会给用户体验带来不利影响。
  • 辅修： 所有其他错误，如（拼写错误、缺少图标、布局问题等）。

4）环境：

Bug 可能出现在特定环境中，而不会出现在其他环境中。例如，有时在以下环境中运行网站时会出现 Bug： Firefox或应用程序仅在 Android 设备并在 iPhone 上运行良好。

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

5）总结：

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

您的摘要应尽可能简短，包括错误发生的时间和方式。您的标题和错误描述也应在搜索中使用，因此您必须确保涵盖了重要的关键字。

例子:

  • 不好： “我试图在测试中添加一些东西，但当我这样做或单击按钮时什么都没有出现。”
  • 好： “当我尝试将 [产品] 添加到购物车时，单击特定产品概览网页上的‘添加’按钮时什么也没有发生。”

6）复现步骤：

报告错误时，务必指定重现错误的步骤。您还应包括可能导致错误的操作。在这里，不要做任何泛泛的陈述。

具体说明要遵循的步骤：

这是一个编写良好的程序的示例：

步骤：

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

7）预期成果：

在错误报告中，描述技术任务、测试用例结果设计或根据测试人员的意见的预期结果非常重要。所有这些都有助于开发人员集中精力快速找到所需的信息。

例如：

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

8）实际结果：

顾名思义，该字段描述了错误的实际影响。写出对实际结果的清晰描述非常重要。

例如：

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

9）附件（截图和视频）：

在错误报告中，最佳做法是将文件附加到错误报告中，这样当您需要以直观的方式显示信息时，可以更轻松地感知信息：

例如：

  • 截图： 屏幕截图可以轻松详细说明程序中的错误；当使用特定的注释、圆圈或箭头图像突出显示错误时会很方便。
  • 视频： 有时很难用语言描述bug，所以最好制作视频，以便开发人员可以纠正程序中的缺陷）。

10）受影响的版本：

这是报告该错误的受影响软件版本。

11）修复版本：

这是修复错误的软件版本。因此，当报告错误的 QA 检查错误是否已修复时，他使用的是正确的软件版本。

12） Target 版本：

修复错误应针对的目标版本。因此，当开发团队修复错误时，他们大多会针对特定的应用程序版本。

13) 结束日期：

这是软件测试团队关闭错误的日期。关闭错误是软件测试中至关重要且不可或缺的一部分。

14）状态：

当创建新 Bug 时，其状态应为打开。此后，它会经历“进行中”、“已修复”、“正在运行”、“重新打开”等阶段。

相关文章

编写 Bug 报告的技巧

在撰写有效的错误报告时，您应该记住以下一些重要提示：

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

错误报告工具

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

您可以查看我们对 最好的错误报告工具。

撰写错误报告时常见问题及解决方案：

以下是编写错误报告时的一些常见问题及其解决方案：

错误报告示例 市场问题
当 2 乘以 3 时，答案为正数。 报告模式，而不是示例。
为了避免这种情况，添加新项目时将按字母顺序排列列表。 不要只描述哪里出了问题
例如：
首先，您需要打开浏览器并输入网站的 URL。您会发现第一个字段“用户名”拼写错误。		 总是直奔主题（永远不要讲述故事！）。
报告中客户的名字拼写错误。优先级：高，严重性：高 切勿混淆优先级和严重性。
税收计算公式不正确!!?? 不使用大写字母、红色字母、红色圆圈、“！”，
我觉得主页Ul设计不太好。 不要运用你的判断力。
不清楚的描述示例：关于我们今天的讨论，请对此页面执行所需的操作。 让每个人都能理解你的描述。
页面背景应为蓝色、橙色或绿色，或者可以设为黑色或白色。

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

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

错误报告示例

以下是错误报告的一个小例子：

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

Descript离子： 当鼠标悬停在“我的帐户”部分的“更新”按钮上时，我们需要删除下划线。

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

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

重现步骤：

1. 访问 www.test.com

2. 通过登录凭证登录

3. 导航至我的账户

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

实际结果： 有下划线。

预期结果： 没有下划线。

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

必须避免在编写错误报告时犯错误

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

  • 不要写你的不满，也不要包含你的个人感受。
  • 当你在帖子中添加过多表情符号时，那些想要集中精力完成任务的人会感到厌烦。
  • 切勿在帖子中过多使用感叹号；这不会加快工作速度。
  • 没人愿意感到被冒犯。这会破坏积极性，并减缓对问题的认识。

你可能会喜欢：