如何撰写有效的错误报告

:bookmark: 本指南旨在指导如何在 Discourse 中编写有效的错误报告,以最大程度提高修复错误的几率。

:person_raising_hand: 所需用户等级:任何用户均可报告错误

编写一份优秀的错误报告对于帮助 Discourse 团队高效解决问题至关重要。本指南将引导您完成各个步骤并介绍最佳实践,以确保您的错误报告清晰、简洁且具备可操作性。

摘要

在本文档中,我们将涵盖以下内容:

  • 提供可复现步骤和具体细节的重要性
  • 如何描述问题及预期行为
  • 在不同平台上报告错误的最佳实践
  • 在报告中保持恰当的语气
  • 常见陷阱及解决方案

编写有效错误报告的步骤

优先级/严重程度

确定修复错误的紧急程度。虽然每个人都希望自己的问题能迅速得到解决,但请将最高优先级保留给那些严重影响功能的严重问题。

平台

始终指定观察到错误的环境。这包括:

  • 设备类型(桌面端、移动端、触摸屏、平板电脑)
  • 操作系统及其版本
  • Web 浏览器及其版本

如果可能,请在多个平台上复现该错误以确认其存在。

描述

请保持简洁。简单描述问题,避免不必要的细节。如果可以单独报告,请将不同的问题分开描述。清晰的描述格式包括:

实际结果: 正在发生什么?
预期结果: 应该发生什么?

避免假设读者已经了解背景信息。请明确指出应该看到或发生的情况。

可复现步骤

确保错误能够稳定复现。从 Discourse 的主屏幕开始,逐步编写操作说明。如果错误随机出现,请说明其发生频率(例如,每 10 次尝试中有 1 次)。对于与 UI/UX 相关的错误,请添加截图或视频以增强清晰度。

语气

保持尊重和礼貌的语气。不要利用错误报告来表达不满。任何有毒的语言或行为都可能导致您的报告被延迟处理或忽略。

模板

使用以下模板快速开始创建新的错误报告主题:

优先级/严重程度

平台

描述

可复现步骤

最佳实践

  1. 在安全模式下复现:在报告之前,如果您怀疑自定义定制可能导致了问题,请尝试在 Discourse 的安全模式中复现该问题。
  2. 质疑假设:错误报告往往源于错误的假设。即使在您的报告中,也要质疑并澄清您可能存在的任何假设。
  3. 提供详细信息:对于难以捉摸或罕见的错误,请尽可能提供详细信息。包括您认为可能相关的任何内容,如错误消息或日志文件。

常见问题及解决方案

问题: 无法稳定复现错误。
解决方案: 记录错误出现时的环境和条件。注意任何模式或共同点。

问题: 对错误报告没有回应。
解决方案: 确保您的报告详细但简洁,并采用礼貌的语气撰写。

常见问题解答

问:如果我没有时间撰写详细报告怎么办?
答:使用您拥有的信息打开报告仍然会有所帮助。请注明您稍后会更新更多详细信息。

问:我应该在哪里发布我的错误报告?
答:请使用适当的类别——错误报告应发布在 Contribute > Bug 类别中。

其他资源

42 个赞