[缺陷管理]软件测试缺陷报告实用写作技术

软件测试缺陷报告实用写作技术

提供准确、完整、简洁、一致的缺陷报告是体现软件测试的专业性、高质量的主要评价指标。遗憾的是，一些缺陷报告经常包含过少或过多信息，而且组织混乱，难以理解。由此导致缺陷被退回，从而延误及时修正，最坏的情况是由于没有清楚地说明缺陷的影响，开发人员忽略了这些缺陷，使这些缺陷随软件版本一起发布出去。 　　因此，软件测试工程师必须认识到书写软件缺陷报告是测试执行过程的一项重要任务，首先要理解缺陷报告读者的期望，遵照缺陷报告的写作准则，书写内容完备的软件缺陷报告。本文将阐述软件测试缺陷报告的读者，描述软件缺陷报告的主要组成部分和各部分的书写要求，指出某些常见错误和实用改进方法，最后总结了缺陷报告的写作要点。
　　1. 缺陷报告的读者对象
　　在书写软件缺陷报告之前，需要明白谁是缺陷报告的读者对象，知道读者最希望从缺陷报告中获得什么信息。通常，缺陷报告的直接读者是软件开发人员和质量管理人员，除此之外，来自市场和技术支持等部门的人也可能需要查看缺陷情况。每个阅读缺陷报告的人都需要理解缺陷针对的产品和使用的技术。另外，他们不是软件测试人员，可能对于具体软件测试的细节了解不多。
　　概括起来，缺陷报告的读者最希望获得的信息包括：

易于搜索软件测试报告的缺陷；
报告的软件缺陷进行了必要的隔离，报告的缺陷信息更具体、准确；
软件开发人员希望获得缺陷的本质特征和复现步骤；
市场和技术支持等部门希望获得缺陷类型分布以及对市场和用户的影响程度。
　　软件测试人员的任务之一就是需要针对读者的上述要求，书写良好的软件缺陷报告。
　　2. 缺陷报告的写作准则
　　书写清晰、完整的缺陷报告是对保证缺陷正确处理的最佳手段。 它也减少了工程师以及其它质量保证人员的后续工作。
　　为了书写更优良的缺陷报告，需要遵守“5C”准则：

Correct（准确）：每个组成部分的描述准确，不会引起误解；
Clear（清晰）：每个组成部分的描述清晰，易于理解；
Concise（简洁）：只包含必不可少的信息，不包括任何多余的内容；
Complete（完整）：包含复现该缺陷的完整步骤和其他本质信息；
Consistent（一致）：按照一致的格式书写全部缺陷报告。
　　3. 缺陷报告的组织结构
　　尽管不同的软件测试项目对于缺陷报告的具体组成部分不尽相同，但是基本组织结构都是大同小异的。一个完整的软件缺陷报告通常由下列几部分组成：

缺陷的标题；
缺陷的基本信息；
测试的软件和硬件环境；
测试的软件版本；
缺陷的类型；
缺陷的严重程度；
缺陷的处理优先级。
复现缺陷的操作步骤；
缺陷的实际结果描述；
期望的正确结果描述；
注释文字和截取的缺陷图像。
　　对于具体测试项目而言，缺陷的基本信息通常是比较固定的，也是很容易描述的。实际书写软件缺陷报告容易出现问题的地方就是标题、操作步骤、实际结果、期望结果和注释部分。下面针对这些“事故多发地带”具体论述如何提供完整的信息，由于英文是软件开发的主要语言，以下的软件缺陷报告的信息都使用英文书写。
　　4. 缺陷报告的写作技术
　　4.1 标题（Title）
　　标题应该保持简短、准确，提供缺陷的本质信息，并且便于读者搜索查寻。
　　良好的缺陷标题应该按照下列方式书写：

尽量按缺陷发生的原因与结果的方式书写（“执行完A后，发生B，”或者“发生B，当A执行完后”）；
避免使用模糊不清的词语，例如“功能中断，功能不正确，行为不起作用，”等。应该使用具体文字说明功能如何中断，如何不正确，或如何不起作用；
为了方便搜索和查询，请使用关键字；
为了便于他人理解，避免使术语、俚语或过分具体的测试细节。