debugging - 我怎样才能写出好的错误报告？

Question

我想写更好的错误报告 - 在向我使用的软件的开发人员报告错误时，我应该记住哪些事情？

Answer 1

我会说这取决于您的团队/组织。但是，请记住，您可以查看：

1. 维基百科错误报告模板
2. Apache Bug 编写模板
3. 苹果错误报告样本
4. 您可以在任何其他 OS 项目中找到相同的内容。

添加从此处提取的更多信息：

要具体。如果您可以用两种不同的方式做同样的事情，请说明您使用的是哪一种。“我选择了加载”可能意味着“我点击了加载”或“我按下了 Alt-L”。说你做了什么。有时这很重要。 详细一点。提供更多而不是更少的信息。如果你说的太多，程序员可以忽略其中的一些。如果你说的太少，他们必须回来问更多的问题。我收到的一个错误报告是一句话；每次我问更多的信息，记者都会再回复一句。我花了几个星期才获得大量有用的信息，因为它一次只出现一个简短的句子。 小心代词. 当不清楚它们的意思时，不要使用像“它”这样的词，或者像“窗户”这样的引用。考虑一下：“我启动了 FooApp。它打开了一个警告窗口。我试图关闭它，但它崩溃了。” 目前尚不清楚用户试图关闭什么。他们是试图关闭警告窗口，还是关闭整个 FooApp？它有所作为。相反，您可以说“我启动了 FooApp，它显示了一个警告窗口。我试图关闭警告窗口，结果 FooApp 崩溃了。” 这更长，更重复，但也更清晰，更不容易误解。 读你写的。把报告读给自己听，看看你是否认为它很清楚。如果您列出了一系列应该导致失败的操作，请尝试自己遵循它们，看看您是否错过了一个步骤。

我想说，您必须提供描述、严重性、重现步骤和状态。然后你可以通过添加标签、受影响的版本、受让人等来改变一些风格。

希望这可以帮助！