如何写一个好的缺陷（Defect）报告

缺陷报告概述

测试工程师需要利用对需求的理解、高效的执行力以及严密的逻辑推理能力，迅速找出软件中的潜在缺陷，并以缺陷报告的形式递交给开发团队。

缺陷报告是测试工程师与开发工程师交流沟通的重要桥梁，也是测试工程师日常工作的重要输出。

缺陷报告作用

开发工程师可以根据缺陷报告快速理解缺陷，并精确定位问题
产品经理可以了解缺陷对用户或业务的影响以及严重性

缺陷报告要素

缺陷标题

标题对 “问题” 描述要具体，不要过于笼统
标题尽可能描述问题本质
标题不易过长，详细描述应该放在缺陷概述里边

缺陷概述

提供更多概括性的缺陷本质与现象的描述，是缺陷标题的细化。

缺陷影响

缺陷引起的问题对用户或者对业务的影响范围以及严重程度

要求：必须对软件的应用场景以及需求有深入的理解

环境配置

详细描述测试环境的配置细节，为缺陷的重现提供必要的环境信息。

前置条件

指测试步骤开始前系统应该处在的状态，其目的是减少缺陷重现步骤的描述

缺陷重现步骤

缺陷报告中最核心的内容，其目的在于用简洁的语言向开发工程师展示缺陷重现的具体操作步骤。

缺陷重现步骤的描述应该尽量避免以下 3 个常见问题：

笼统的描述，缺乏可操作的具体步骤。
出现与缺陷重现不相关的步骤。
缺乏对测试数据的相关描述。

期望结果和实际结果

期待结果来自于对需求的理解，而实际结果来自于测试执行的结果。

优先级和严重程度

缺陷的优先级和严重程度有什么关系呢？

缺陷越严重，优先级就越高；
缺陷影响的范围越大，优先级也会越高；
有些缺陷虽然从用户影响角度来说不算严重，但是会妨碍测试或者是自动化测试的执行，这类缺陷属于典型的严重程度低，但是优先级高；
有些缺陷虽然严重程度比较高，但是考虑到修复成本以及技术难度，也会出现优先级较低的情况。

变通方案

变通方案是提供一种临时绕开当前缺陷而不影响产品功能的方式。

原因分析

原因分析就是如果你能在发现缺陷的同时，定位出问题的根本原因，清楚地描述缺陷产生的原因并反馈给开发工程师。

附件

附件通常是为缺陷的存在提供必要的证据支持，常见的附件有界面截图、服务器端日志、GUI 测试的执行视频等。

缺陷报告案例

软件注册功能的测试过程中发现使用12345这种弱密码也可以进行注册，与需求不符合，以下为缺陷详细信息。

缺陷标题：注册功能密码输入框，没有做密码类型校验。

缺陷概述：注册过程中，使用弱类型密码仍然可以注册成功。

缺陷影响：可能导致黑客对用户密码进行暴力破解，造成用户信息泄露。

环境配置：操作系统：Linux ；浏览器： Chrome。

前置条件：无

缺陷重现步骤：

进入注册页面填写注册信息；
密码填写 123456 ；
点击注册；

期望结果：注册失败，在密码输入框提示：密码过于简单，请使用字母+数字+特殊字符组合。

实际结果：显示注册成功页面。

优先级：高

严重程度：严重

变通方案：无

原因分析：后端用户注册模块代码没有对密码数据进行类型校验。

附件：review.gif

面试题

Q：你认为好的缺陷报告是怎样的？

A：好的缺陷报告需要准确的描述问题，快速的重现问题，精准的定位问题。