如何写一份良好的缺陷（Bug）报告

没错，任何工具都存在bug，哪怕是我们自己也存在弊端，因为程序员也是普通人，人是会犯错误的。当有人在使用工具时碰到bug，你应该使用邮件产生一份缺陷bug，发送给研发员工。开发者可以根据该报告定位问题，复现问题，修复问题。

但是这些之后，开发员工很难理解提交上的缺陷报告，因为发送人并不了解我们必须的是哪个，那怎么与开发员工沟通或者怎么说出一份缺陷报告，在这篇文章，我将教你怎么说出一份清晰的缺憾报告能使开发者理解、复现、修复问题，这里下载缺陷报告模板。

为什么要发送缺陷报告

缺陷报告可以用这些方法来帮助我们的开发者。

● 他们能告知我们没有意识到的问题

● 他们能看到我们也许还没想到的新特性

● 他们能帮助我们感受到客户是怎样使用我们的硬件，以至于我们可以做的更好

没有这些缺陷报告，我们就不知道出错的地方，我们应该它好像你说话唱歌时必须有工具的支持一样。

什么时候发送缺陷报告

● 简单来说就是越快越好，详细来说就是：

● 当你看到一个错误消息时就发送出错报告

● 当屏幕是空白以及数据缺乏就发送报告

● 当程序没有出现预期的结果时发送报告

● 当程序崩溃、死机、没有响应以及响应很慢时发送报告

● 当程序返回错误结果时发送报告

● 当你得不到想应该的结果时发送报告

● 如果你不知道如何做时发送报告

● 如果你不讨厌软件做的方法，或者工具老打搅你时，发送错报告

● 如果你想在平台中谋求一个变通方案时发送报告

12

缺陷报告必须有什么内容

缺陷报告应当包括这些信息，你提供的信息越多效果越好，对于开发者，就像我，提供一个纯文本文件模板给你填充并且短信转给我，当然还有表格方式的，但是最渴望你自己杜撰一份然后发给我。下面是一些需要包含的个别以及怎样写好每部分：

标题：创建一个简短的标题，让问题看起来更清晰。“应用崩溃”是一个很恼人的标题因为它没有足够的信息包含在这份报告上面。取而代之的是标题必须包括错误消息和消息码，或者是结果的名称及其成功时你正在做的事情。例如：Error 402：访问拒绝当点击“发送短信”这个示例就提供了缺陷系统的上下文信息。

差：“程序崩溃”，“报错”，“Bug”

好：“从’Kifu’中打印时5C79错误”，“’Kifu honors’报表为空”

产品：用名称标示产品，告知你使用的是什么版本。绝大部分软件都包括有版本信息。web应用的版本信息一般在页脚。

差：“你的应用”

好：”Kifu v1.01″

平台：告诉我们工具运行在哪个系统。尤其是操作系统的昵称及版本和游览器名称版本。特别是web应用，这些信息对我们很重要。

差：“Windows”

好：“Windows7，IE9”

是否能再现：有些恼火的Bug是间歇性的发生，我们想预先了解，如果我们正在处理一个灵异事件以及正逢Bug出现时。

差：留空白

好：“每次”，“偶然”，“不再现”

描述：这部分是很拿不定的地方，不知道怎么表述问题，在叙述中做到包括以下的内容：

● 总结：用简单的语言概括出Bug出现时你正在做的事情。从上下文开始，在操作应用的那个部分。聚焦在你做的之后软件做了哪些？

差：“系统不能用了”

好：在“honor report”页面点击“打印图标”，但是报表是空的。

● 发生了哪些：一步一步描述你做的事情当bug发生时，为什么你觉得是出错的。事无巨细，打印出菜单的名称，页面标题，点击时的图标以及链接的名称。做同样的操作是不是出现一样的出错。

差：“空白报表”

好：“点击 ‘File/Save as…’，’Save‘对话空跳出，然后单击‘OK’按钮，但是文件没有保存”

● 错误时哪个：如果出错消息发生时，拷贝粘贴整个信息，这样更有利于我们跟踪错误。

差：“有个错误，点击它一直读不出”

好：“Error 403：访问拒绝”

● 复现的方法：如果你可以让bug重现，那太好了，这能提供巨大的帮助。一步步描述怎么再现次bug。

差：“打印没法使用”

好：“从‘Honors Report’页面，点击‘打印图标’”

● 预期结果：描述你预期出现的结果当bug发生时，这部分非常有用如果程序没有按照你等待的结果出现时，因为它很可怕。

差：“我期望能正常工作”

好：“我期望能看到‘Honors Reports’的PDF文件”

真实结果：当bug出现时是怎样发生的，什么出错，为什么有错，或者即使出错抛出，抛出什么错。

差：“没法用”

好：“我收到是空的PDF文件，或者’403错误缺陷报告包含哪些内容，访问拒绝’”

● 附件：如果你了解如何截屏，做吧，附上一个简短的错误，截屏可以是错误之前甚至出现错误以后，我们的开发者能够看见到底出现了哪些。如果应用有崩溃的日志缺陷报告包含哪些内容，同样附上它。

● 联系形式：附上你的名字和email，我们可以让你提交的报告迅速的给与答复，在我们不理解问题的表述时还会够询问你，如果你忘记附联系方法了，我们也就无法联系到你，也无法修复bug。

12

本文来自电脑杂谈，转载请注明本文网址：
https://www.pc-fly.com/a/ruanjian/article-120917-1.html