BUG描述规范

一、目的与适用范围

1.1 目的

报告软件测试错误的目的是为了保证修复错误的人员可以明确报告的错误，从而有利于分析错误产生的原因，定位错误，然后修正之。因此，报告软件测试错误的基本要求是准确、简洁、完整、规范。

1.2 适用范围

本规范适用于测试过程中对BUG描述的规范与约束。

二、 BUG描述规范

1. 描述：简洁、准确，完整，揭示错误实质，记录缺陷或错误出现的位置描述要准确反映错误的本质内容，简短明了。为了便于寻找指定的测试错误，描述中要包含错误发生时的用户界面（UI）。例如记录对话框的标题、菜单、按钮等控件的名称。

2. 明确指明错误类型：布局、翻译、功能等；

根据错误的现象，总结判断错误的类型。例如，布局错误、翻译错误、功能错误、双字节错误，这是最常见的缺陷或错误类型，其他形式的缺陷或错误也从属于其中某种形式。

3. 短行之间使用自动数字序号，使用相同的字体、字号、行间距；短行之间使用自动数字序号，使用相同的字体、字号、行间距，可以保证各条记录格式一致，做到规范专业。

4. UI要加引号，可以单引号，推荐使用双引号；

UI加引号，可以容易区分UI与普通文本，便于分辨、定位缺陷或错误。

5. 每一个步骤尽量只记录一个操作；保证简洁、条理井然，容易重复操作步骤。

6. 确认步骤完整，准确，简短；

保证快速准确的重复错误，“完整”即没有缺漏，“准确”即步骤正确，“简短”即没有多余的步骤。

7. 根据缺陷或错误类型，选择图象捕捉的方式；

为了直观的观察缺陷或错误现象，通常需要附加缺陷或错误出现的界面，以位图的形式作为附件附着在记录的“附件”部分。为了节省空间，又能真实反映缺陷或错误本质，可以捕捉缺陷或错误产生时的全屏幕，活动窗口和局部区域。

8. 附加必要的特殊文档、个人建议和注解；

如果打开某个特殊的文档而产生的缺陷或错误，则必须附加该文档，从而可以迅速再现缺陷或错误。有时，为了使缺陷或错误修正者进一步明确缺陷或错误的表现，可以附加个人的修改建议或注解。

9. 检查拼写和语法错误；

在提交每条缺陷或错误之前，检查拼写和语法，确保内容正确，正确的描述错误。

10. 尽量使用业界惯用的表达术语和表达方法；

使用业界惯用的表达术语和表达方法，保证表达准确，体现专业化。

11. 通用UI要统一、准确；

错误报告的UI要与测试的软件UI保持一致，便于查找定位。

12. 尽量使用短语和短句，避免复杂句型句式；

软件错误管理数据库的目的是便于定位错误，因此，要求客观的描述操作步骤，不需要修饰性的词汇和复杂的句型，增强可读性。

13. 每条错误报告只包括一个错误；

每条错误报告只包括一个错误，可以使错误修正者迅速定位一个错误，集中精力每次只修正一个错误。校验者每次只校验一个错误是否已经正确修正。