如何写一个好的缺陷报告？技巧和窍门

写问题报告的重点是去让问题修复——杰姆·卡尼尔

如果一个测试人员不能正确的提交Bug，那么程序员大概率会拒绝修复，因为它不能复现，这会伤害到测试人员的自尊。

如果缺陷报告是正确有效的，那么Bug会被修复第更快。所以修复一个Bug依赖于你提交的报告有多有效。提交Bug不过是一项技能，在这篇文章中，我们将演示如何掌握这项技能。

任何人都可以写缺陷报告，但不是每一个人都会写有效的缺陷报告。你应该能区分一份中等的缺陷报告和一份优秀的缺陷报告。那么怎么去区分一份优秀的报告和一份欠佳的报告呢？

拥有一个清晰明了的Bug编号：总是使用一个独一无二的编号去提交Bug，这会帮你识别Bug记录。如果你正在使用一个自动bug提交工具，那么每次提交bug的时候都会自动生成一个特定的编号。提交bug的时候需要记录编号和一份简要的描述。
可复现性：如果你的Bug不可复现，它永远不会被修复。你应该清晰的描述每一个复现Bug的步骤。不要对任何可复现的步骤造假或者忽略。
描述细节：但是不要写一篇关于问题的论文。把问题写的具体些并直指重点，试着用简要的文字去描述一个问题。不要把多个问题结合起来即便他们看上去比较相似。你应该为每一个问题书写不同的报告。

缺陷报告在软件测试中是重要的一环。有效的缺陷报告可以与开发团队保持良好的沟通以避免遗漏任何混乱或者沟通不畅。

优秀的缺陷报告应该简洁明了并不遗漏任何关键点。任何不清晰的地方会导致开发产生误解并减慢开发流程。缺陷编写和报告是最重要的一点，但也是测试生命周期中容易被忽视的区域。

优秀的书写利于Bug归档。测试人员应该记住最重要的一点，不要在报告中使用命令的口气，这会破坏并创造一种不和谐的工作关系。要使用建议的语气。

当开发人员犯错时，不要责怪他，你不可以使用严厉的用语。在报告之前，你需要确定相同的缺陷是否被重复提交过，这也很重要。

重复的bug是测试周期中的负担，我们要查看已发现的缺陷列表。有时候开发人员肯呢个会意识到这个问题，但在未来的版本中忽视它。类似Bugzilla，可以自动过滤已知的重复Bug，但最好还是手工搜索一遍。

提交Bug非常重要的一个信息是描述“什么现象”，“在哪里发现”，报告上应该写明测试步骤如何演示并且在哪里导致了这个报错。阅读者应该很容易重现并找出Bug在哪里。

请记住，编写缺陷报告的目的是让开发可视化以这个问题，他应该能够容易理解测试报告的内容。记住提供开发人员需要的所有信息。

还应该注意的是，测试报告会保存下来以备未来使用时提取信息。所以使用有意义的语句和简洁明了的文字。不要使用模棱两可的模糊表述，这会使得阅读者浪费时间。

报告每一个Bug时应该分开。如果在一篇报告中描述了多个问题，你可能无法轻易关闭它除非所有问题都得到解决。

这是一份简单的Bug报告模板，这会比较依赖你在使用的Bug提交工具。如果你要手动编写缺陷报告，则需要特别提及某些字段，例如Bug编号，这应该手动编写。以下是一个简单的Bug报告模板

报告人：你的名字和邮箱

产品：你是在哪个产品中发现的这个问题？

版本：产品版本

模块：发生在产品的哪个模块

机器：写明在你是在哪些硬件上发现了这个Bug，不同的平台例如‘PC端’，‘MAC’,‘HP’，‘SUN’等等

操作系统：列明你在哪些操作系统上可以发现Bug

处理优先级：什么时候应该处理这个bug，一般会使用P1-P5级别划分。P1表示“修复bug最高优先级”，P5表示“有时间再看这个问题”。

影响面：这里需要写明bug影响的范围

bug级别:

状态：当你把Bug记录到任何大型的系统中时，Bug的初始状态应该是“new”，在这之后，Bug流转到不同状态，比如已修复，已核实，再打开，不可修复等等。

关注人：如果你知道Bug是哪个开发负责的模块导致问题产生，你可以直接写明开发的邮件地址。除此之外，留出一栏空行给这个Bug的模块负责人，如果不这么做，管理人员会直接分配Bug给开发。可能会增加管理人员的邮箱到这个列表中。

链接：Bug产生的页面链接。

总结：对Bug的简要概述，大多在60字以下。确保你的文档反映了bug是什么以及在哪里。

描述：Bug的详细说明，包括：

类型：

立刻报告缺陷，如果你在测试过程中发现了任何Bug，你不可以在好一会儿之后才书写缺陷报告，相反，你应该立即书写缺陷报告。这将确保有效的缺陷报告。如果你决定稍后才提交缺陷报告，那么有可能错过报告中的重要步骤。
在编写缺陷报告之前复现Bug三次，你的报错应该是可重现的，请确保你的步骤足够可靠，可以毫不费力地复现Bug。如果你提交的Bug不是每次必现的，你也应该提交一个报告，并表明Bug是偶现的。
在其他类似的模块上测试相同的Bug，有时候，开发会在其他类似的模块内复用相同的代码。这会使得Bug一旦在一个模块中产生，在其他模块中也会产生。你甚至可以尝试发现更多不同版本中复现你发现的Bug。
书写优秀的Bug概要，Bug概要可以帮助开发人员更快分析Bug的本质。低质量的报告会导致不必要的开发和测试时间增加。请记住，Bug摘要可以在清单中用作搜索的参考。
在点击提交按钮前，检查你的缺陷报告。阅读在报告中提到的每一个句子，用词以及步骤。查看句子是否会产生歧义造成误解。避免使用误导性的文字和语句。
不要使用辱骂用语，你做得很好并发现了一个缺陷是令人高兴的，但不要用这个功劳来批评开发人员或攻击任何个人。

毫无疑问，你的缺陷报告应该是一个高质量的文档。管理者应在团队中建立一种意识：编写一份优秀的缺陷报告是任何测试人员的首要责任。你为缺陷编写有效的报告所付出的努力不仅可以节省公司的资源，还可以让你和开发人员之间建立良好的关系。为了提高工作效率，请确保编写有效的缺陷报告。

你是编写缺陷报告的专家吗？请随时在下面的评论区分享您的想法。我们很乐意听取你的意见。