JIRA的BUG编写规范

1、、摘要二、名词解释三、目的四、范围五、BugBug 编写规范o1.1.主题o2 2.描述o3.3.环境o4.4.截图o5.5.其他六、注意事项一、摘要本文档主要描述了技术产品部测试人员提交 BugBug 时需要遵守的规范二、名词解释 JIRAJIRAJIRAJIRA 是 AtlassianAtlassian 公司出品的项目与事务跟踪工具，被广泛应用于缺陷跟踪、客户服务、需求收集、流程审批、任务跟踪、项目跟踪和敏捷管理等工作领域。三、目的规范 BugBug 编写，一方面，可以方便开发人员根据 BugBug 描述快速进行定位问题原因，减少沟通成本，另一方面，可以帮助测试经理、非技术人员、产品经理、

2、开发经理及其他测试人员等了解 BugBug, ,第三，可以体现测试团队的专业性、严谨性。四、范围该文档适合技术产品部测试人员使用，适合于任何产品和项目。五、Bug编写规范1.1.主题为了节约开发阅读 BugBug 时间，同时考虑到开发人员容易通过 BugBug 标题来猜想 BugBug, ,所以，BugBug 标题显得尤为重要。以下为 BugBug 标题编写时需要遵守的规范。1 1）用简短的语句描述问题，主题文字过多，增加开发阅读 BugBug 时间。2 2）格式：在什么位置，在什么条件下，做什么操作，操作的结果。XX-包舌；采购中心、集采采购、集采销售、销售中心、赚户设置、云库房./贞面小添

3、加页：添加XX；修改页：修改XXr列表页：XX列表；洋情页：XX详情。非添加、修改、列表、详情，则为面包屑或弹挺名称如果属于多标签页面，格式为“XX-页面crab名称）：，比如集采错售-招标tt划列表（待手演：二P在什么条件下：如果问题为兼容性 BugBug，比如浏览器兼容或者分辨率兼容。格式为“在 IE11IE11 浏览器下，如果 BugBug 不属于兼容性问题，不用加此描述。做什么操作：问题触发的动作，比如：”执行审批通过”。操作的结果：即问题的表象，比如：字段“报送时间”取值不对、报 404404 错误。格式举例：采购中心-招标计划详情：在 IE11IE11 浏览器下，展开“查看参与人员

4、”，内容错乱。3 3）除了第二点描述的格式，对于 BugBug 描述，除了描述实际的结果外，有时候我们会直接描述期望结果，比如，集采销售-招标计划列表：列表字段“填报时间”应该修改为“报送时间”。4 4）描述无歧义。BugBug 描述如果有歧义，开发容易因为改错 BugBug, ,导致增加 BugBug 修复成本。在什么位置：问题所在的路径，格式为XX-XX-页面:5 5）涉及界面 UIUI 的文字，用双引号标注，比如：集采销售-招标计划列表：列表字段“报送时间”取值错误。2 2.描述描述是对 BugBug 标题的详细补充，对于复杂 Bug,Bug,标题不足以帮助开发定位问题，需要详细步骤来支

5、撑BugBug, ,描述可以与标题完全一致。2 2）对于标题不能描述清楚的 BugBug, ,描述一般格式如下：1 1 . .重现步骤2 2 . .【实际结果】3 3 . .【期望结果】一在实际编写过程，可以省略某一部分，比如标题清晰表达了问题现象，此时再”【期望结果就能清晰表达问题3 3）对于需要复杂数据准备的 BugBug, ,在描述里备注账号格式为：账号/密码，比如，lotus009qq.coom3.lotus009qq.coom3.环境环境为产生 BugBug 时，用户使用的浏览器、操作系统、分辨率、账号等，主要用于辅助开发排查问题。1 1）URL:BugURL:Bug 产生的页面 U

6、RL,URL,方面开发快速找到修改代码的地方。2 2）浏览器、操作系统、分辨率：如果是兼容性问题，需要在此注明产生问题的环境。4 4 . .截图一份好的截图，可以方便开发人员快速确认错误的表现形式和错误的位置。1 1）截图工具统一使用：FSCapture.exeFSCapture.exe。2 2）不要仅仅截图，需要在图上标注出有问题的地方，并文字进行辅助说明。1 1）对于标题就能描述清楚的3 3）如果问题为 500500、404404 等错误，需要附上日志截图，方便开发定位代码行。4 4）如果 BugBug 为与需求不符 BugBug, ,截图需要同时包括需求与系统实现，减少开发查阅需求的时间

7、5 5）如果 BugBug 为读取数据错误，截图需要同时包括数据库的存储结果及系统数据的展示的对比图5 5 . .其他1 1）正确选择“BugBug 分类”BugBug 来源来源解释代码逻辑错误代码逻辑错误导致对的 BugBug未理解需求/需求遗漏实现因未理解需求导致功能实现错误需求描述，但开发未实现与 UIUI 不符未按照 UIUI 规范来进行开发用户体验不修改不会影响业务，但会影响用户体验产品描述错误产品描述错误导致的 BugBug产品需求及更测试阶段，需求变更及其导致的 BugBug产品描述遗漏需求不完整导致的 BugBugBugBug 来源来源解释部分浏览器、分辨率下才重现的 BugB

8、ug兼容性问题其他不属于以上分类的 BugBug2 2）正确选择 BugBug 的优先级BugBug 优先级别级别定义危险造成系统崩溃、数据丢失、主要功能完全丢失、测试完全受阻严重系统主要功能部分丢失、数据不能保存、次要功能完全丢失重要系统次要未完整实现、功能模块失效、常见系统功能失效轻微不影响功能的失效、用户体验明显不友好、界面不规范建议建议性问题，不修复/、影响系统发布上线3 3）正确选择 BugBug 所属卞 K K 块 BugBug 模块主要是用于 BugBug 分析和输出测试报告时，做模块 BugBug 统计六、注意事项1.1.一个 BugBug 只能包括一个错误同一个 BugBug

9、 里包括多个问题，开发修改 BugBug 的时候，容易遗漏，导致 BugBug 被多次 ReopenReopen2.2.3.3.所有 BugBug 统一记录在 JIRAJIRA 中，测试人员在测试过程中发现的或非测试人员本身发现的 BugBug, ,无特殊情况，不能用其他工具记录，同时不允许以口头方式直接告知开发人员，统一记录在 JIRAJIRA 中以便统一管理，一方面，有利于项目资产的建立及项目过程问题的分析，另一方面，避免造成记录丢失或遗忘。4.4.5.5.避免重复提交 BugBug, ,BugBug 的重复提交会增加测试人员的工作量，同时也可能增加开发人员的心理压力，所以在多人测试的时候,一方面，避免多人同时测试同一个功能点，另一方面，提 BugBug 之前