缺陷报告书写规范和注意事项

---

缺陷报告的重要性

概念：软件缺陷又叫做Bug。即为计算机软件、程序、web应用中存在的某种不符合正常运行的功能问题。也是错误、隐藏，让用户不满意的功能缺陷。
  从产品内部看，缺陷是软件产品开发或维护过程中存在的错误、毛病等各种问题；
  从产品外部看，缺陷是系统所需要实现的某种功能的失效或违背。

• 错误的缺陷报告会误导开发人员，影响开发人员的开发效率
• 错误的缺陷报告会影响测试人员自身的可信度

---

一、缺陷报告的注意事项

• 尽量保持缺陷可以重现
• 缺陷描述简洁、准确、完整
• 一个缺陷对应一个报告

---

二、缺陷书写规范

1.标题

应保持简短、准确，提供缺陷的本质信息

• 尽量按照缺陷发生的原因与结果的方式书写；
• 避免使用模糊不清的词语，例如：“功能中断”、“功能不正确”、“行为不起作用”等，应该使用具体文字说明缺陷的症状；

2.复现步骤

应包含如何使别人能够很容易的复现该缺陷的完整步骤

• 简单地一步步引导复现该缺陷，一个步骤包含的操作不要过于复杂；
• 每一个步骤前使用数字或者其他方式给步骤进行编号；
• 尽量保持短语和短句，避免使用复杂的句型句式；
• 根据实际需要，提供测试的环境信息；
• 尽量不要出现个人的感情色彩，例如：我觉得…你应该…某某怎么样怎么样；
• 避免多余的步骤，避免丢失必要的步骤。

3.实际结果

是执行复现步骤后软件的现象和产生的行为

• 实际结果的描述应向标题信息那样，列出具体的缺陷症状，而不是简单的指出“不正确”或“不起作用”

4.期望结果

描述应与实际结果的描述方式相同，通常需要列出期望的结果是什么

5.附件

对缺陷描述的补充说明，可以是以下类型：

• 提供缺陷的截图
• 测试使用的数据文件

---

其他常见的错误

• 避免使用我、你等人称代词，可以直接使用动词活必要时使用“”用户“代替；
• 避免使用情绪化的语言和强调符号
• 避免使用诸如“似乎”、“看上去可能"等含义模糊的词汇，需要报告确定的缺陷结果；
• 避免提交不确定的测试问题，自己至少需要重现一次再提交；