Project

General

Profile

如何提bug单

技术文档
07/27/2026

这是一份详细的《Bug提交操作指南》,适合放在 Redmine 的“帮助”页面、Wiki 首页,或作为公司内部文档下发。内容覆盖从“判断是不是Bug”到“提交后的跟进”,并配有模板和示例,可直接使用。


缺陷(Bug)提交操作指南

适用系统:公司 Redmine 缺陷追踪系统
版本:V1.0
生效日期:2026-07-27


1. 目的

统一 Bug 提交规范,确保每个缺陷信息完整、可复现、可追踪,减少因描述不清导致的沟通成本和处理延误。


2. 提交前准备工作

2.1 先确认这是不是 Bug

在提交前,请先自问:

  • 是否与需求文档或设计稿不符?
  • 是否程序崩溃、报错、卡死或数据错乱?
  • 是否影响核心业务流程?

如果只是“觉得不好用”或“个人偏好”,请走「优化建议」流程,不要提交为 Bug。

2.2 搜索是否已存在

在 Redmine 中使用 搜索框 或 过滤器,按关键词、模块、版本检索,避免重复提交。


3. 提交操作步骤(图文说明)

步骤 1:登录 Redmine

步骤 2:进入项目

  • 在顶部导航栏点击 “项目”
  • 选择对应产品/项目(例如:XX商城、后台管理系统)

步骤 3:新建问题

  • 点击右侧或顶部 “新建问题” 按钮

步骤 4:填写关键字段

字段 必填 说明
跟踪 ✅ 选择「错误」(Bug)
主题 ✅ 一句话概括问题,格式:[模块] 现象简述,例如 [订单] 支付成功后订单状态未更新
描述 ✅ 按第 4 节模板详细填写
状态 自动 默认为「新建」,不需修改
优先级 ✅ 见第 5 节优先级定义
指派给 ✅ 选择该模块负责人,若不确定选「项目经理」统一分配
版本 ✅ 选择发现 Bug 的版本号(如 V2.3.1)
严重程度 ✅ 见第 5 节严重程度定义
附件 推荐 上传截图、日志、抓包文件等(支持 .png/.jpg/.log/.txt)

步骤 5:保存提交

点击 “创建” 按钮,系统会自动生成问题编号(如 #1234),并邮件通知被指派人。


4. Bug 描述标准模板

在「描述」框中,请按以下结构填写:

【前置条件】
(需要什么环境、数据、配置)

【复现步骤】
1. 进入 XX 页面
2. 点击 XX 按钮
3. 输入 XXX 数据
4. 观察结果

【预期结果】
(系统应该怎样正确运行)

【实际结果】
(系统实际出现了什么问题)

【复现概率】
(必现 / 偶现(请估算概率,如 30%))

【附件说明】
(截图、日志文件名及重点说明)

示例(实际填写内容)

【前置条件】
- 测试环境:https://test.xxx.com
- 账号:test01 / 123456
- 商品 ID:10086,库存=5

【复现步骤】
1. 登录系统,进入商品详情页
2. 点击「立即购买」,数量填 3
3. 选择支付方式「微信支付」
4. 支付成功后,返回订单列表

【预期结果】
订单状态应变为「待发货」,库存减少 3

【实际结果】
订单状态仍为「待支付」,库存未变化

【复现概率】
必现(5 次测试均出现)

【附件说明】
- 截图:order_error.png(显示状态错误)
- 日志:pay_20260727.log(含错误堆栈,行号 156)

5. 优先级 & 严重程度定义

优先级(处理紧急程度)

等级 适用场景
紧急 系统崩溃、核心功能不可用、影响所有用户、无临时方案
高 重要功能异常、影响部分用户、有临时绕过方案
中 非核心功能异常、不影响主流程
低 界面错别字、样式微调、不影响使用

严重程度(问题本身的严重性)

等级 说明
致命 数据丢失、系统宕机、安全漏洞
严重 主要功能错误,无替代方案
一般 功能部分异常,有替代方式
轻微 UI 显示问题、提示不友好

建议组合:

  • 致命/严重 + 紧急/高 → 需立即响应
  • 一般/轻微 + 低 → 可排入后续迭代

6. 常见错误写法(×)与正确写法(√)

❌ 错误示例 ✅ 正确示例
登录不了 [登录] 输入正确账号密码后,点击登录按钮无响应,控制台报 CORS 错误
页面报错 [商品] 在商品编辑页上传图片后,点击保存,页面白屏并提示 500 Internal Server Error
功能不好用 [报表] 导出 Excel 时,数据量超过 1000 行时仅导出前 500 行,与预期全部导出不符

7. 提交后的跟进

  • 状态流转:
    新建 → 进行中 → 已解决 → 已关闭
  • 职责:
    • 提交人:负责验证「已解决」的 Bug,确认修复后变更为「已关闭」;若未修复则重新打开。
    • 处理人:收到指派后 24 小时内确认,并更新进度。
  • 超时提醒:超过 48 小时未更新的问题,系统会自动邮件催办。

8. 附件上传要求

  • 支持格式:png, jpg, jpeg, gif, log, txt, xlsx, csv, zip
  • 单个文件上限:5 MB
  • 命名建议:模块_日期_内容描述.扩展名,如 order_20260727_error.png

9. 常见问题 FAQ

Q1:不确定 Bug 属于哪个模块怎么办?
A:选择「公共/未知」,指派给项目经理,由他转交。

Q2:偶现的 Bug 怎么填复现步骤?
A:尽量记录出现时的操作序列、时间点、网络环境,并附上日志;复现概率写“偶现,约 20%”。

Q3:可以提需求或优化建议吗?
A:可以,但请将「跟踪」选为 “功能” 或 “支持”,不要选“错误”。


10. 附录:提交前自检清单

提交前对照以下项目打勾(✅):

  • 已搜索过,无重复问题
  • 主题简洁清晰,含模块名称
  • 描述包含前置条件、步骤、预期、实际
  • 已选择正确的版本和优先级
  • 已上传必要的截图/日志
  • 已指派给正确的负责人

文档维护:IT 支持组
反馈渠道:如有文档建议,请在 Redmine 中提交「支持」类问题,指派给“文档管理员”。


如果你需要,我还可以继续帮你:

  • 转为 Wiki 格式(Redmine Textile 语法)
  • 精简为 一页速查表(海报版)
  • 制作成 邮件模板 用于新员工培训

随时告诉我你的下一步需求。😊

Files