Bug报告 5C标准说明与示例

以下是基于5C标准的缺陷报告编写指南及具体示例,帮助团队高效提交高质量Bug报告:


Bug报告 5C标准说明与示例

1. Correct(准确)

要求:描述无歧义,技术细节精确,避免主观推测。
反例❌:

“点击按钮时页面卡死,可能是服务器问题。”
问题:推测原因(未验证是否服务器问题),未记录具体现象。

正例✅:

标题:点击【提交订单】按钮后,页面持续加载动画超过30秒,控制台报错 ERR_CONNECTION_TIMEOUT
复现步骤

  1. 使用测试账号 user_test/123456 登录电商平台
  2. 添加任意商品至购物车,进入结算页
  3. 点击【提交订单】按钮
    实际结果:页面加载动画持续显示,30秒后浏览器报错 ERR_CONNECTION_TIMEOUT
    预期结果:5秒内跳转至支付页面

2. Clear(清晰)

要求:语言简洁直接,避免模糊代词,操作路径明确。
反例❌:

“在设置页面修改配置后,那个功能失效了。”
问题:未说明“哪个配置”、“哪个功能”。

正例✅:

步骤

  1. 进入【系统设置 > 通知管理】
  2. 关闭【邮件提醒】开关
  3. 返回首页,触发订单完成事件
    实际结果:仍收到邮件通知(配置未生效)
    预期结果:关闭开关后不再接收邮件

3. Concise(简洁)

要求:仅保留必要信息,删除冗余操作。
反例❌:

“我先打开APP,然后登录,再点5次首页的 banner,接着...”
问题:无关操作(点banner)干扰核心流程。

正例✅:

步骤

  1. 使用账号 admin/Admin@2023 登录后台
  2. 进入【用户管理】→ 搜索用户 “Test_01”
  3. 点击【禁用账户】
    实际结果:页面提示“操作成功”,但用户状态仍显示“正常”

4. Complete(完整)

要求:包含环境、前置条件、完整操作链、关键数据。
反例❌:

“导出报表时报错。”
问题:缺失环境、操作细节、错误信息。

正例✅:

环境:Chrome 115 / Windows 11 / v2.3.0
前置条件:存在超过10,000条订单记录
步骤

  1. 进入【报表中心】→【订单报表】
  2. 时间范围选择 2023-01-01 至 2023-12-31
  3. 点击【导出Excel】
    实际结果:弹出错误提示 “Failed to load resource: net::ERR_INSUFFICIENT_RESOURCES”
    预期结果:成功导出Excel文件

5. Consistent(一致)

要求:统一报告结构、术语、日期格式等。
反例❌:

报告1标题:登录功能BUG - 2024/6/28
报告2标题:Error when user login (June 28)
问题:标题结构、日期格式、语言不统一。

正例✅(标准化模板):

标题:[模块] 问题简述 - 日期 【用户管理】禁用账户状态未更新 - 20240628
环境Android 14 / App v3.1.2
优先级P1
步骤

  1. ...
  2. ...
    附件:错误日志截图、屏幕录制

关键检查清单

标准 自查要点
Correct 是否避免“可能”“似乎”等推测性词汇?
Clear 是否所有操作指向唯一路径?(如菜单层级)
Concise 能否删除非必要步骤(如无关页面跳转)?
Complete 是否包含环境/数据/错误代码等关键证据?
Consistent 是否与团队模板字段完全对齐?

📌 实践建议:在团队Wiki中固化模板,使用工具(如Jira)预设必填字段,通过自动化检查(如字数/格式校验)提升合规率。

posted @ 2025-07-03 21:33  开山怪  阅读(84)  评论(0)    收藏  举报