如何撰写错误报告：分步指南

有效的错误报告对于改善产品的用户体验至关重要。清晰详细的错误报告可以帮助 QA 团队和开发人员了解问题、重现问题并最终修复问题。

什么是错误报告？

错误报告是包含软件缺陷详细信息的文档。它通过提供基本信息（例如错误发生的时间和方式）来帮助开发人员修复错误。缺陷应记录在错误跟踪系统（例如 GitHub）中，以监控其状态和影响。错误报告通过告知产品利益相关者错误的严重性来帮助他们优先修复错误，并且是软件开发过程的关键组成部分。

写一份好的错误报告的重要性

一个好的错误报告可能是缺陷被修复与否的区别。它传达用户体验并帮助整个团队理解问题。良好的错误报告可以加快修复过程，并确保错误不会对最终产品产生负面影响。它是软件开发生命周期的重要组成部分。

有效错误报告的关键要素

1. 标题和错误 ID

错误报告以标题和唯一的错误 ID 开头。报告的作者通常会创建标题，而错误跟踪系统通常会自动生成错误 ID。有效的错误报告的标题应该是对缺陷的清晰、简洁的总结。在某些情况下，它包括错误的类型。

2. 应用程序版本和操作系统

一份好的错误报告必须包括错误发生时所使用的应用程序版本和操作系统。了解错误是否发生在不同版本、设备类型或操作系统上也是很有价值的信息！当您使用 Snagit 进行屏幕截图时，应用程序版本和操作系统会自动记录，并可以使用捕获信息效果显示在图像上。

3. 重现bug的步骤

最有效的错误报告包括重现错误的步骤。这些步骤应该易于开发人员遵循和复制。 Snagit 可以拍摄重现步骤的图像或视频。在屏幕截图中添加箭头、标注和模糊效果，以帮助开发人员专注于重现错误所需的关键元素。

4. 实际结果与预期结果

大多数错误报告描述了错误的实际结果，但不要忘记包括预期结果。实际结果可以定义为“当错误发生时会发生什么”，而预期结果是“没有错误时应该发生什么”。如果开发人员不知道预期结果，修复错误可能会很困难。

5. 截图和视频

屏幕截图和屏幕录制可以准确显示错误发生的位置并提供视觉证据，从而显着增强错误报告的质量。

重要的屏幕捕获工具功能包括以下内容：

• 屏幕截图，包括滚动捕获
  • 洞察屏幕可见区域的屏幕截图：如果适用，最好抓取整个长网页。这可确保捕获所有需要的信息。
    • 与大多数捕获工具不同， Snagit支持向上和向下滚动以及向左和向右滚动捕获。
• 图像编辑工具
  • 利用箭头和标注等注释工具来完善屏幕截图并关注相关细节。
    • Snagit 提供高效的屏幕截图编辑功能，包括 Magnify 和 Spotlight。它还提供模糊和编辑功能来隐藏个人身份信息。
• 屏幕录制
  • 视频记录说明了导致问题的事件流程。
    • 与许多替代方案不同， Snagit捕获鼠标移动和系统音频，以尽可能捕获最丰富的错误事件。
  • 为了增加清晰度，请在录制时添加旁白和现场绘画。
    • Snagit提供麦克风捕获和各种屏幕绘制标记，包括自动步骤注释。还提供可选的网络摄像头集成，以实现更个性化的体验。
• 文本抓取和元数据捕获。
  • 最高效的产品，如Snagit，将通过简化从屏幕上的文本抓取 (OCR) 信息来减少输入错误跟踪信息所需的时间。
• 图书馆和档案管理
  • Snagit使您能够使用自动元数据和自定义标签来组织屏幕截图和录音。
  • 每次捕获都提供复制粘贴元数据（例如 URL 和时间戳），以节省完成错误报告的时间。

Snagit 是排名最高的屏幕和视频捕获软件，所有财富 500 强公司都在使用。

停止重复问题

使用 Snagit 创建清晰的视频和指南，这样您只需解释一次任务。

免费试用

6. 错误消息和日志

确保您的错误报告包含错误生成的任何错误消息或日志文件。可以通过屏幕截图快速捕获错误消息，同时可以将日志文件附加到错误报告中。这为开发人员提供了调试的关键技术信息。

错误报告示例

这是一个良好的错误报告的直观示例，其中包括错误 ID、标题、应用程序版本、操作系统、重现步骤、预期结果和实际结果、屏幕截图和错误消息等关键元素。

是什么让这个错误报告有效？

这是一份有效的错误报告，因为它包括描述性标题、重现错误的精确步骤、带注释的屏幕截图和系统信息。该报告提供了充足的信息，以确保开发人员清楚地了解问题并能够有效地解决问题。

请注意屏幕截图是如何用突出显示问题链接的形状和指向该链接的标注以及其文本框中的更多详细信息进行注释的。两侧不相关的链接都被模糊化，因此开发人员可以快速找到错误，同时保留错误所在位置的上下文。

编写错误报告时要避免的常见错误

1. 描述模糊

有效的错误报告应尽可能具体，以防止混淆。避免模​​糊的描述，例如“按钮不起作用”。更好的描述是“红色按钮点击后显示‘错误 404’消息。”这种清晰度确保整个团队对问题有深入的了解。

2.缺少重现步骤

开发人员可能需要采取步骤来重现错误，以了解或解决问题。清晰而精确的步骤将节省开发人员的时间并减少挫败感。考虑录制您自己走过的步骤的视频以进行重现。

3. 忘记视觉证据

错误报告中的一个常见错误是不包含任何屏幕截图或视频。在加速理解和修复错误方面，没有什么比屏幕截图的视觉证据更有效的了。

Snagit 可用于快速轻松地捕获屏幕截图和屏幕录制。 Snagit 编辑器可以对您的屏幕截图进行注释，清楚地突出显示相关信息。最终屏幕截图中的任何敏感信息都可以被模糊或编辑。屏幕录像是另一种多功能的证据形式。

错误报告工具和跟踪系统

为什么要使用错误跟踪系统？

错误跟踪系统可帮助开发团队在不同团队和开发阶段组织、跟踪错误并确定其优先级。它分配唯一的跟踪信息，例如标题错误 ID。它可以帮助 QA 团队了解用户遇到错误的频率，并帮助产品利益相关者了解修复错误的工作何时完成。这些系统可以提供按错误类型和错误优先级细分的见解。

谁使用错误跟踪工具？

软件开发团队使用这些工具来识别和修复开发生命周期中的错误：

• 质量保证(QA) 团队正式跟踪测试阶段发现的缺陷。
• 项目经理利用这些系统来监控及时交付的风险。
• 客户支持记录最终用户报告的问题，以确保这些问题得到解决。

Bug 跟踪工具的主要功能

• 错误捕获– 能够记录新的详细错误报告
• 错误报告– 能够根据严重级别或其他元数据查找错误
• 自定义工作流程– 支持适合其内部流程（例如状态进展和治理）的特定于团队的规则
• 错误优先级– 确定错误优先级、拉动和推迟错误的能力
• 错误分配– 将错误分配给团队成员的能力
• 集成功能– 与其他开发工具无缝集成，通常是版本控制系统或项目管理工具
• 自动通知– 支持通过推送警报通知团队成员状态变化
• 仪表板– 对错误趋势和整体团队绩效的直观洞察

错误跟踪系统的比较

流行的错误跟踪工具包括 Jira、Bugzilla、Trello 和 GitHub。这些工具支持创建错误报告以及团队成员之间的协作。其他常见工具包括 Redmine、MantisBT、Zoho Bug Tracker 和 Asana。

这些系统中的大多数对屏幕截图和屏幕录制捕获提供有限的支持或不支持。客户通常使用Snagit等附加产品来实现强大的屏幕捕获。

• 但是，其中一些平台可以使用第三方工具，例如 Zephyr 的 Capture for Jira、BetterBugs for Trello 以及名为 Trello Capture 的第三方 Chrome 扩展。

创建错误报告的最佳实践

1.提供详细的复现步骤

重现错误的清晰分步说明对于有效的错误报告至关重要。这有助于确保团队中的每个人都清楚地了解该问题。开发人员将按照步骤重现错误，然后研究潜在的解决方案。多人（包括 QA 或不同的开发团队）需要这些信息来重现问题。

2. 始终包含屏幕截图和视觉效果

每个错误报告都应包括屏幕截图、屏幕录制或视频剪辑。 Snagit 是与开发团队收集和共享视觉信息的理想工具。可以将箭头、形状、标注等添加到屏幕截图中以突出显示重要信息。

3. 多环境测试

在多个环境中进行测试可以提供有价值的信息——错误是否只发生在特定的应用程序版本、设备类型或操作系统上？这些详细信息可以帮助开发人员确定何时引入错误以及如何修复它。

4.定期更新和审查错误报告

定期查看和更新​​错误报告非常重要。当 QA 团队发现有关错误的新信息时，他们应该将其包含在现有的错误报告中。这确保了开发人员在修复错误时拥有最准确的详细信息。

与 QA 团队和开发人员合作

清晰的沟通是关键

有效的软件开发需要 QA 团队和开发人员之间进行清晰的沟通。修复错误需要开发人员了解问题并能够重现它。开发人员应该放心地向 QA 团队询问测试技术，而 QA 团队应该能够向开发人员询问他们的技术专业知识。

Snagit 如何帮助进行视觉协作

Snagit 是一款强大的工具，可帮助 QA 团队和开发人员更有效地协作。 Snagit 可以快速创建和共享可视化报告，确保开发团队之间的清晰沟通和协作。

结论

有效的错误报告对于软件开发至关重要，有助于确保高质量的产品。撰写错误报告时，请包括详细的重现步骤、屏幕截图和视频记录、系统信息以及预期结果与实际结果。

Snagit 是可用于创建高质量视觉效果并帮助改善错误修复过程中的理解和沟通的最佳产品。

加快您的屏幕截图工作流程

不要再用内置的剪切工具浪费时间了，试试 Snagit吧！

了解更多