【发布时间】：2015-06-07 15:24:04
【问题描述】：
我想编写更好的错误报告 - 在向我使用的软件的开发人员报告错误时我应该记住哪些事项？
【问题讨论】：
-
这是相当广泛的，但通常：#1：确保它实际上是一个错误，而不仅仅是它的工作方式。 #2 可重复性。如果您不能给出重现错误的确切步骤，请不要打扰。 #3：他们在乎吗？他们是否公开要求“请测试并将错误发送给我们”。 #4 最后，如果他们有公共错误跟踪器，请在提交任何新的之前搜索它。
【发布时间】：2015-06-07 15:24:04
【问题描述】：
我会说这取决于您的团队/组织。但是，请记住，您可以查看：
- Wikipedia Bug Report Template
- Apache Bug Writing Template
- Apple Bug Report Sample
- 您可以在任何其他操作系统项目中找到相同的内容。
添加从here提取的更多信息：
要具体。如果您可以用两种不同的方式做同样的事情，请说明您使用的是哪一种。 “我选择了加载”可能意味着“我点击了加载”或“我按下了 Alt-L”。说你做了什么。有时这很重要。 详细说明。提供更多而不是更少的信息。如果你说的太多，程序员可以忽略其中的一些。如果你说的太少，他们必须回来问更多的问题。我收到的一个错误报告是一句话；每次我问更多的信息，记者都会再回复一句。我花了几个星期才获得有用的信息，因为它一次只出现一个简短的句子。 注意代词。当不清楚它们的意思时，不要使用像“它”这样的词，或者像“窗户”这样的引用。考虑一下：“我启动了 FooApp。它打开了一个警告窗口。我试图关闭它，但它崩溃了。”目前尚不清楚用户试图关闭什么。他们是试图关闭警告窗口，还是关闭整个 FooApp？它有所作为。相反，您可以说“我启动了 FooApp，它显示了一个警告窗口。我试图关闭警告窗口，但 FooApp 崩溃了。”这更长，更重复，但也更清晰，更不容易误解。 阅读您所写的内容。把报告读给自己听，看看你是否认为它很清楚。如果您列出了一系列会导致失败的操作，请尝试自己执行这些操作，看看您是否错过了某个步骤。
我会说，您必须提供描述、严重性、重现步骤和状态。然后你可以通过添加标签、受影响的版本、受让人等来改变一些风格。
希望这会有所帮助！
【讨论】：