缺陷報告範本(Bug Report)#
參照標準:ISO/IEC/IEEE 29119-3:2021(Incident Report)
文件用途:讓開發者不必再詢問就能重現、定位與修復缺陷,並讓 PO 判斷優先序
適用階段:測試驗證與維運階段
範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 6.4 節
📋 章節目錄#
- 基本資訊與分級
- 重現資訊
- 證據與影響
- 修復與驗證
- 審查與驗證
1. 基本資訊與分級#
📝 範本#
| 項目 | 內容 |
|---|
| 缺陷編號 | {BUG-專案-序號} |
| 標題 | [{模組}] {現象}({在什麼情況下}) |
| 嚴重度(Severity) | {P1 Critical/P2 High/P3 Medium/P4 Low}(QA 判定:影響多大) |
| 優先序(Priority) | {Highest/High/Medium/Low}(PO 判定:多快要修) |
| 環境/版本 | {SIT/UAT/PRD},{版本或 commit SHA} |
| 對應需求/測試案例 | {FR-xxx}/{TC-xxx} |
| 是否為安全問題 | {是:改走弱點管理流程/否} |
📖 使用說明#
- 標題要能單獨看懂:寫出模組、現象、條件;避免「系統錯誤」
- 嚴重度與優先序不同:報表標題錯字嚴重度低,但明天要交主管機關時優先序最高
- 安全問題不要寫在公開的缺陷系統中,改依弱點管理流程處理
💡 範例#
| 項目 | 內容 |
|---|
| 缺陷編號 | BUG-HRMS-0731 |
| 標題 | [請假] 申請 0.5 天特休時,剩餘額度剛好 0.5 天仍被拒絕 |
| 嚴重度(Severity) | P3 Medium(有替代方案:改請 4 小時事假) |
| 優先序(Priority) | High(月底結算前需修正) |
| 環境/版本 | UAT,v2.4.0-rc.2(commit a41f9c2) |
| 對應需求/測試案例 | FR-LV-002/TC-LV-002-03 |
| 是否為安全問題 | 否 |
2. 重現資訊#
📝 範本#
### 前置條件
- {帳號、資料狀態}
### 重現步驟
1. {步驟}
2. {步驟}
### 預期結果
{依據需求或驗收條件,寫出應有的結果}
### 實際結果
{實際看到的結果,含錯誤訊息原文}
### 重現頻率
{每次/偶發(N 次中 M 次)}
📖 使用說明#
- 步驟要具體到「另一個人照做就能重現」
- 預期結果要引用需求或驗收條件,不是「應該要正常」
- 錯誤訊息貼原文,不要轉述
💡 範例#
### 前置條件
- 帳號 E20260001,特休剩餘 0.5 天
### 重現步驟
1. 登入 UAT,進入「請假申請」
2. 假別選「特休」,日期 2026-10-15 上午(0.5 天)
3. 按「送出」
### 預期結果
申請成功,狀態為 pending(驗收條件「申請天數剛好等於剩餘額度」)
### 實際結果
HTTP 422,畫面顯示「特休剩餘 0.5 天,不足申請天數 0.5 天」
### 重現頻率
每次
3. 證據與影響#
📝 範本#
| 項目 | 內容 |
|---|
| traceId | {從錯誤回應或日誌取得} |
| 日誌/截圖 | {連結;須遮罩個資} |
| 影響範圍 | {功能、使用者數、資料是否受損} |
| 替代方案 | {有/無:說明} |
📖 使用說明#
- 提供 traceId 讓開發者直接在日誌與追蹤系統找到該請求
- 截圖與日誌中的個資必須遮罩(依資料分級對照表)
💡 範例#
| 項目 | 內容 |
|---|
| traceId | 4bf92f3577b34da6a3ce929d0e0e4736 |
| 日誌/截圖 | UAT 日誌連結(員工姓名已遮罩) |
| 影響範圍 | 剩餘額度為小數的員工(約 12%)無法用完最後半天 |
| 替代方案 | 有:改請 4 小時事假後由 HR 人工調整 |
4. 修復與驗證#
📝 範本#
| 項目 | 內容 |
|---|
| 根本原因 | {開發者填寫} |
| 修復 PR | {連結} |
| 新增的回歸測試 | {測試名稱} |
| 驗證者/日期 | {QA 姓名,日期} |
📖 使用說明#
- 每個缺陷修復都必須附對應的自動化回歸測試,避免再犯
- 由提出者或 QA 驗證後才能關閉
💡 範例#
| 項目 | 內容 |
|---|
| 根本原因 | 額度比較使用 double,0.5 的運算結果為 0.49999… |
| 修復 PR | #1287(改用 BigDecimal) |
| 新增的回歸測試 | LeaveQuotaPolicyTest#shouldAllowWhenRequestEqualsRemainingHalfDay |
| 驗證者/日期 | QA 陳,2026-10-09 |
5. 審查與驗證#
本節供審查者使用,也用來檢查 AI 依本範本產出的缺陷報告是否正確。
自動檢查#
| 檢查項目 | 方法 |
|---|
| 必填欄位 | 缺陷系統設定必填:重現步驟、預期結果、實際結果、環境/版本 |
| 修復附測試 | 關閉時檢查修復 PR 含新增或修改的測試檔 |
| 個資外洩 | 附件上傳前以 DLP 或關鍵字掃描身分證字號格式 |
人工審查問題#
- 另一個人照步驟做能重現嗎?
- 預期結果有引用需求或驗收條件嗎?
- 嚴重度與優先序是否由正確的角色判定?
- 是否其實是安全問題而應改走弱點流程?
AI 常見錯誤#
- 把嚴重度與優先序混為一談。
- 重現步驟缺少前置資料,導致無法重現。
- 截圖或日誌未遮罩個資。
📌 範本使用注意事項
- 本範本可直接設定為缺陷系統(Jira、Azure Boards、GitLab Issues)的 Issue 範本
- 搭配「測試案例範本」「測試報告範本」使用