我怎样才能写出好的错误报告?

How can I write good bug reports?

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

我会说这取决于你的 team/organization。但是,请记住,您可以查看:

  1. Wikipedia Bug Report Template
  2. Apache Bug Writing Template
  3. Apple Bug Report Sample
  4. 您可以在任何其他 OS 项目中找到相同的内容。

添加从 here 中提取的更多信息:

具体。如果你可以用两种不同的方式做同样的事情,请说明你使用的是哪一种。 "I selected Load" 可能意味着 "I clicked on Load" 或 "I pressed Alt-L"。说说你做了什么。有时这很重要。 冗长。提供更多而不是更少的信息。如果你说的太多,程序员可以忽略一部分。如果你说得太少,他们必须回来问更多问题。我收到的一个错误报告是一句话;每次我问更多的信息,记者都会用一句话来回答。我花了几周的时间才获得大量有用的信息,因为它一次只出现一个短句。 小心代词。不要使用像 "it" 这样的词,或者像 "the window" 这样的引用,当它们的意思不清楚时。考虑一下:"I started FooApp. It put up a warning window. I tried to close it and it crashed." 不清楚用户试图关闭什么。他们是试图关闭警告 window 还是整个 FooApp?它有所作为。相反,您可以说 "I started FooApp, which put up a warning window. I tried to close the warning window, and FooApp crashed." 这更长且重复性更强,但也更清晰且不易被误解。 阅读您写的内容。自己再读一遍报告,看看你是否认为它很清楚。如果您列出了应该导致失败的一系列操作,请尝试自己执行这些操作,看看是否遗漏了一个步骤。

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

希望对您有所帮助!