如何描述BUG

news2025/5/30 11:31:35

一、如何描述BUG

1.1 版本信息

1.1.1 必填项

精确到构建版本号（如v2.3.1_build20240615）

获取方式：
- 代码版本控制系统（Git提交哈希值）
- 应用内版本信息（App的About页面）
- 持续集成工具生成的版本标识（Jenkins Build ID）

1.1.2 示例模板

[版本信息] 
前端版本：OMS-Web v2.3.1（Git提交号：a1b2c3d）
后端服务：order-service v1.4.2
数据库版本：MySQL 8.0.32
发现时间：2024-06-15 14:30

1.2 环境信息

1.2.1 标准环境矩阵

环境类型	记录要素	工具推荐
硬件环境	机型/CPU/内存/存储空间	CPU-Z/AIDA64
软件环境	OS版本/运行时环境/JDK版本	`systeminfo`命令
网络环境	IP地址/网络类型/代理配置	Wireshark/Fiddler
中间件	数据库版本/中间件配置	`SELECT version();`
特定配置	实验性功能开关/Feature Flag	配置中心截图

1.2.2 示例模板

[测试环境]
- 操作系统：Windows 11 Pro 22H2
- 浏览器：Chrome 115.0.5790.110（内核版本537.36）
- 网络环境：公司内网（IP：192.168.1.100，网关：192.168.1.1）
- 屏幕分辨率：1920×1080
- 登录账号：test_export / Export@1234

1.3 复现步骤

1.3.1 编写原则（SMART准则）

Specific：每个步骤独立编号
Measurable：包含必要的数据参数
Action-oriented：使用主动语态
Repeatable：可被任何人复现
Time-bound：注明特定时间条件

1.3.2 示例模板

[复现步骤]
1.访问订单管理系统：https://oms.example.com
2.输入账号密码登录进入后台
3.导航至【订单管理】→【高级筛选】
4.设置筛选条件：
时间范围：2024-06-01 至 2024-06-15
订单状态：已支付
5.点击右上角【导出Excel】按钮
6.查看下载文件（重复操作3次）

1.4 预期结果

1.4.1 描述标准

引用需求文档章节（如：SRS 3.2.1节）
用户视角的正常表现
符合业务逻辑的量化指标

1.4.2 示例模板

[期望输出]
根据需求文档《OMS系统需求规格说明书v3.2》第15页规定：
- 应导出符合筛选条件的所有订单数据（当前应导出32条记录）
- 文件格式为标准的Excel 2019兼容格式（.xlsx）
- 文件命名规则：订单导出_YYYYMMDDHHmmss.xlsx

1.5 实际结果

1.5.1 证据收集规范

问题类型	收集内容	工具推荐
UI问题	标注缺陷的截图/屏幕录像	Snipaste/ScreenToGif
接口异常	Postman响应截图+日志片段	Charles/Postman
崩溃问题	完整堆栈日志+设备日志	Android Studio Logcat
性能问题	性能分析报告+资源监控截图	JProfiler/Chrome DevTool

1.5.2 示例模板

[实际输出]
1. 导出的Excel文件仅有表头无数据（空文件）
2. 控制台报错：TypeError: Cannot read properties of null (reading 'map')
    at ExportService.generateExcel (export.js:45) 
3. 服务器返回500错误：POST /api/orders/export → 500 Internal Server Error
	Response Body: {"error":"Internal server error"}
4.附件证据

1.6 问题分级

1.6.1 缺陷分级标准

严重等级	标准说明	响应时效要求	描述
P0	导致系统崩溃/数据丢失	2小时内	Blocker（崩溃）
P1	主流程阻断	4小时内	Critical（严重）
P2	功能异常但可绕过	1个工作日内	Major（一般）
P3	界面问题/体验缺陷	2个工作日内	Minor（次要）

如果出现P0级别错误，测试打回给开发，开发再修改后自己测试一下再继续交给测试人员测试

1.6.2 缺陷类型标记

[Category]
- Type: Functional Error
- Severity: P1 (High)
- Module: Order Management System

1.7 关联信息

1.7.1 必要附加信息

相同环境其他模块是否受影响
历史版本是否出现相同问题
是否特定数据组合触发

1.7.2 示例模板

[关联分析]
- 历史版本：v2.2.0版本相同功能正常
- 数据相关性：仅当筛选时间范围≥15天时出现
- 关联接口：/api/orders/export（可查看Swagger文档）
- 影响范围：所有使用Chrome内核的浏览器

1.8 沟通记录

1.8.1 Bug生命周期

1.8.2 示例模板

[跟踪]
- 2024-06-15 14:35 测试工程师张三提交缺陷
- 2024-06-15 15:00 开发李四确认可复现（标记为"已受理"）
- 2024-06-15 17:20 发布修复版本build202406151700
- 2024-06-15 17:40 验证通过（关闭缺陷）

二、Bug报告模板（Markdown版）

## [BUG] 订单导出功能返回空文件

**Version**: v2.3.1_build20240615  
**Environment**:  
- OS: Windows11 22H2  
- Browser: Chrome 115.0.5790.110  
- Network: Corporate VPN Enabled  

**Repro Steps**:  
1. 登录后台管理系统（账号：export_test）  
2. 进入【订单管理】-【高级筛选】  
3. 设置筛选条件：日期范围=最近30天  
4. 点击【导出Excel】按钮  

**Expected**:  
根据PRD 3.2节应导出包含筛选结果的Excel文件（预期数据量：152条）  

**Actual**:  
1. 下载的Excel文件大小为0KB（空文件）  
2. 控制台报错截图：[Console_Error.png]  
3. 网络请求响应：500 Internal Server Error  

**Classification**:  
- Type: Functional Error  
- Severity: P1  
- Module: Order/Export  

**Additional Info**:  
- 仅当选择"最近30天"时出现  
- 关联接口：/api/order/export  
- 日志片段：  
  `ERROR [2024-06-15 14:05:32] ExportService - NullPointerException at line 45`