缺陷報告範本(Bug Report Template)

缺陷報告範本(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 依本範本產出的缺陷報告是否正確。 ...

October 6, 2026 · 2 min · 262 words · Eric Cheng

資料分級對照表範本(Data Classification Template)

資料分級對照表範本(Data Classification) 參照標準:OWASP ASVS 5.0.0 V14(Data Protection)/ ISO/IEC 27001:2022 A.5.12(資訊分類)/ 個人資料保護法 文件用途:為每個資料欄位標註分級,作為加密、遮罩、日誌、測試資料與保存期限的唯一依據 適用階段:系統設計階段(Design Phase);Schema 變更時同步更新 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 4.4、6.3、9.3 節 📋 章節目錄 分級定義 各級保護要求 欄位分級對照表 保存與銷毀 審查與驗證 1. 分級定義 📝 範本 等級 定義 外洩影響 典型資料 公開 {可對外公開} {無} {產品型錄} 內部 {限公司內部} {輕微} {組織架構} 機密 {限特定角色} {重大:個資、營業秘密} {姓名、Email、薪資} 極機密 {限極少數人,需加密} {嚴重:可直接造成詐騙或法律責任} {身分證字號、銀行帳號、密碼雜湊} 📖 使用說明 分級由資料擁有者(業務單位)核定,IT 負責實作保護 同時屬於多種類別時取最高等級 對應 ASVS 5.0 14.1.1(敏感資料識別與分級) 💡 範例 等級 定義 外洩影響 典型資料 公開 可公開於官網 無 公司地址、職缺 內部 全體員工可見 輕微 部門名稱、分機 機密 限本人、主管與 HR 重大(個資) 姓名、Email、手機、請假紀錄、薪資 極機密 限 HR 薪資組,需加密 嚴重 身分證字號、銀行帳號 2. 各級保護要求 📝 範本 要求 公開 內部 機密 極機密 儲存加密 {} {} {} {} 傳輸加密 {} {} {} {} 畫面顯示 {} {} {} {} 日誌 {} {} {} {} 測試環境 {} {} {} {} 存取紀錄 {} {} {} {} 📖 使用說明 對應 ASVS 5.0 14.1.2:每個等級都要有一組文件化的保護要求 這張表是開發、測試、維運共同的規格:AI 或開發者產生程式時,可直接依此判斷要不要遮罩、能不能寫日誌 💡 範例 要求 公開 內部 機密 極機密 儲存加密 不需 不需 資料庫 TDE TDE + 欄位加密(AES-256-GCM,金鑰存 KMS) 傳輸加密 TLS 1.2+ TLS 1.2+ TLS 1.2+ TLS 1.2+,內部服務間 mTLS 畫面顯示 完整 完整 依權限完整或遮罩 預設遮罩,需「顯示」權限並留紀錄 日誌 可記錄 可記錄 遮罩後記錄 禁止記錄 測試環境 可沿用 可沿用 以假資料替換 以假資料替換 存取紀錄 不需 不需 匯出時記錄 每次讀取都記錄 3. 欄位分級對照表 📝 範本 資料表.欄位 分級 個資類別 儲存 畫面顯示 日誌 測試環境 保存期限 {TABLE.COLUMN} {等級} {是/否:類別} {明文/加密} {遮罩規則} {禁止/遮罩/可} {替換/沿用} {期限與法源} 📖 使用說明 每個欄位都要列,包含「看起來不敏感」的欄位(例如備註欄常被填入個資) 遮罩規則寫成具體格式(例:A12****789),方便直接轉成測試案例 Schema 新增欄位時,PR 必須同時更新本表(Reviewer 檢查) 💡 範例 資料表.欄位 分級 個資類別 儲存 畫面顯示 日誌 測試環境 保存期限 EMPLOYEE.NAME 機密 是:識別類 明文 王○明 禁止 替換 離職後 5 年 EMPLOYEE.ID_NO 極機密 是:識別類 欄位加密 A12****789 禁止 替換 離職後 5 年 EMPLOYEE.BANK_ACCOUNT 極機密 是:財務類 欄位加密 ****-****-1234 禁止 替換 離職後 5 年 EMPLOYEE.EMAIL 機密 是:聯絡類 明文 a***@company.com 遮罩 替換 離職後 2 年 LEAVE_REQUEST.REASON 機密 可能(病假事由) 明文 本人與主管可見 禁止 替換 依勞動法規 DEPARTMENT.NAME 內部 否 明文 完整 可 沿用 永久 4. 保存與銷毀 📝 範本 資料類別 保存期限 法源/依據 到期處理方式 執行方式 {類別} {期限} {法規條號/合約} {刪除/去識別化/封存} {批次程式/人工} 📖 使用說明 保存期限必須寫出法源,並由法遵單位確認 到期處理應自動化並留紀錄(ASVS 5.0 14.2.7) 💡 範例 資料類別 保存期限 法源/依據 到期處理方式 執行方式 員工個資 離職後 5 年 公司人事規章(法遵確認 2026-09) 去識別化 每月批次 BATCH-HR-PURGE-001 稽核日誌 365 天 公司資安政策 v4.0 刪除 日誌平台 ILM 政策 5. 審查與驗證 本節供審查者使用,也用來檢查 AI 依本範本產出的分級表是否正確。 ...

October 6, 2026 · 2 min · 358 words · Eric Cheng

階段閘門審查紀錄範本(Stage Gate Review Template)

階段閘門審查紀錄範本(Stage Gate Review) 參照標準:ISO/IEC/IEEE 12207:2026 / ISO/IEC/IEEE 15288:2023(決策管理流程) 文件用途:記錄每道閘門(G1 需求核准、G2 設計核准、G3 上線核准、G4 結案)的檢查結果、證據與決策 適用階段:每個階段結束時 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 2.4 節 📋 章節目錄 審查基本資訊 進入條件檢查 決策 審查與驗證 1. 審查基本資訊 📝 範本 項目 內容 專案 {名稱/代號}(風險等級:{L1/L2/L3},裁剪紀錄:{編號}) 閘門 {G1 需求核准/G2 設計核准/G3 上線核准/G4 結案} 審查日期 {YYYY-MM-DD} 核准者 {依閘門:產品負責人/架構師+資安/CAB/PM+維運主管} 出席者 {姓名與角色} 📖 使用說明 核准者依閘門而定(手冊 2.4 表格);風險 L3 專案依裁剪紀錄可合併閘門 審查前 2 個工作日將證據連結提供給核准者 💡 範例 項目 內容 專案 HRMS 請假模組 v2(風險等級:L1,裁剪紀錄:TR-HRMS-2026-02) 閘門 G3 上線核准 審查日期 2026-10-03 核准者 CAB 主席 林志明、產品負責人 王 HR 主管 出席者 PM 陳大文、QA Lead 黃小玲、DevOps 林、資安 李小華 2. 進入條件檢查 📝 範本 # 進入條件 結果 證據(連結) 1 {條件} {✅/❌/N/A(依裁剪紀錄)} {CI 紀錄、報告、簽核單} 各閘門標準條件(依手冊 2.4,可依裁剪紀錄調整): ...

October 6, 2026 · 2 min · 239 words · Eric Cheng

需求追溯矩陣範本(RTM, Requirements Traceability Matrix Template)

需求追溯矩陣範本(Requirements Traceability Matrix, RTM) 參照標準:ISO/IEC/IEEE 29148:2018(需求追溯)/ ISO/IEC/IEEE 29119-3:2021 文件用途:串起「需求 → 設計 → 實作 → 測試」,確認每條需求都被實作與驗證,且每段程式都有需求依據 適用階段:需求核准(G1)起持續維護,於設計核准(G2)與上線核准(G3)時檢查 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 3.7、2.4 節 📋 章節目錄 文件資訊 追溯矩陣 自動追溯設定 缺口與處理 審查與驗證 1. 文件資訊 📝 範本 項目 內容 文件編號 RTM-{專案代碼}-{序號} 對應需求文件 {PRD/FRD/SRD 文件編號與版本} 最後更新 {YYYY-MM-DD}(由 CI 自動產生時填寫建置編號) 負責人 {BA/QA Lead} 📖 使用說明 前向追溯:每條需求都有設計、實作、測試 → 防止遺漏 反向追溯:每段程式與測試都對應到需求 → 防止鍍金與範圍蔓延 建議以「測試程式碼中的需求編號標註」自動產生,人工維護的 Excel 很快就會過時 💡 範例 項目 內容 文件編號 RTM-HRMS-001 對應需求文件 FRD-HRMS-001 v1.3、SRD-HRMS-001 v1.1 最後更新 2026-10-05(CI build #482) 負責人 QA Lead 黃小玲 2. 追溯矩陣 📝 範本 需求編號 需求摘要 來源 優先序 設計(SDD 章節/API) 實作(模組/類別) 測試案例 測試結果 狀態 {FR-xxx} {摘要} {BRD/CR 編號} {Must/Should/Could} {SDD x.y/METHOD /path} {模組/類別} {TC-xxx} {Pass/Fail/未執行} {✅/⏳/❌} 📖 使用說明 非功能需求(NFR)通常由效能或安全測試驗證,「測試案例」欄填寫測試報告編號 需求異動(CR)時,同步更新受影響的列並記錄 CR 編號 狀態判定:設計、實作、測試三欄都有值且測試 Pass 才是 ✅ 💡 範例 需求編號 需求摘要 來源 優先序 設計 實作 測試案例 測試結果 狀態 FR-LV-001 員工提交請假申請 BRD 3.1 Must SDD 5.2/POST /api/v1/leaves leave-service/LeaveService TC-LV-001-01~04 Pass ✅ FR-LV-002 特休額度不足時拒絕申請 BRD 3.1 Must SDD 5.2/422 Problem Details LeaveQuotaPolicy TC-LV-002-01~02 Pass ✅ FR-LV-005 主管代理人設定 CR-2026-011 Should SDD 5.4 DelegateService TC-LV-005-01 未執行 ⏳ NFR-PERF-001 請假查詢 p95 < 500 ms(200 TPS) SRD 4.1 Must SDD 8.1 快取 LeaveQueryService PT-RPT-2026-03(k6) Fail(620 ms) ❌ 3. 自動追溯設定 📝 範本 // 在自動化測試上標註需求編號(JUnit 5 以上) @Tag("{需求編號}") @DisplayName("{測試案例編號} {情境描述}") @Test void {測試方法名稱}() { /* ... */ } # 前向追溯缺口:需求清單中有、但測試程式碼中找不到的需求編號 grep -ohE "^\| (FR|NFR)-[A-Z]+-[0-9]{3}" docs/requirements/rtm.md | tr -d '| ' | sort -u > req.txt grep -rohE "@Tag\(\"(FR|NFR)-[A-Z]+-[0-9]{3}\"\)" src/test | grep -oE "(FR|NFR)-[A-Z]+-[0-9]{3}" | sort -u > tested.txt comm -23 req.txt tested.txt # 有輸出 → 有需求沒有自動化測試 comm -13 req.txt tested.txt # 有輸出 → 有測試沒有對應需求(反向追溯缺口) 📖 使用說明 正規表示式需配合專案的需求編號格式調整 由效能或安全測試驗證的 NFR 不會有 @Tag,應在比對前從 req.txt 排除,或改以測試報告編號人工確認 建議在 CI 中執行,前向缺口數量做為 G2/G3 閘門的檢查項目 💡 範例 @Tag("FR-LV-002") @DisplayName("TC-LV-002-01 特休剩餘 2 天時申請 3 天,回傳 422") @Test void shouldRejectWhenAnnualLeaveQuotaInsufficient() { /* ... */ } 4. 缺口與處理 📝 範本 缺口類型 需求/測試編號 原因 處理方式 負責人 期限 {前向/反向} {編號} {原因} {補測試/補需求/刪除程式} {姓名} {日期} 📖 使用說明 反向缺口(有程式沒需求)可能是鍍金,也可能是需求文件漏寫,需由 PO 判斷 缺口未處理完畢不得通過 G3 上線閘門(風險 L1 專案) 💡 範例 缺口類型 需求/測試編號 原因 處理方式 負責人 期限 前向 FR-LV-005 測試環境尚未建立代理人資料 補測試資料後執行 TC-LV-005-01 QA 陳 2026-10-08 反向 @Tag("FR-LV-099") 開發自行新增「批次匯出」功能,無需求 PO 決定移除功能 Tech Lead 王 2026-10-09 5. 審查與驗證 本節供審查者使用,也用來檢查 AI 依本範本產出的 RTM 是否正確。 ...

October 6, 2026 · 2 min · 385 words · Eric Cheng

風險接受單範本(Risk Acceptance Template)

風險接受單範本(Risk Acceptance) 參照標準:ISO/IEC 27005:2022(風險處理)/ ISO/IEC 27001:2022 6.1.3 / CVSS v4.0、EPSS、CISA KEV 文件用途:記錄無法在修補時限內處理的弱點或安全例外:為什麼接受、用什麼補償控制、誰核准、何時重新評估 適用階段:測試驗證、上線核准(G3)、維運階段 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 9.2 節 📋 章節目錄 風險描述 評估與補償控制 核准與期限 審查與驗證 1. 風險描述 📝 範本 欄位 內容 單號 RA-{YYYY}-{序號} 弱點/例外 {CVE 編號或弱點描述}(CVSS {版本}:{分數};EPSS {值}(查詢日);KEV:{是/否}) 影響系統/版本 {系統與版本} 無法如期處理的原因 {上游無修補版本/需大幅改版/業務限制} 📖 使用說明 列於 CISA KEV 的弱點原則上不得接受風險,必須在 24 小時內緩解 原因必須具體,「時間不夠」不是可接受的原因 💡 範例 欄位 內容 單號 RA-2026-07 弱點/例外 CVE-2026-12345(commons-foo 2.3.1;CVSS v4.0:7.5 High;EPSS 0.004(2026-10-01);KEV:否) 影響系統/版本 HRMS customer-service v2.4.0 無法如期處理的原因 上游尚未發布修補版本 2. 評估與補償控制 📝 範本 欄位 內容 可達性分析 {有弱點的函式是否被呼叫;分析方法與依據} 殘餘風險 {採取補償控制後的風險描述與等級} 補償控制 {WAF 規則、關閉功能(Feature Flag)、網路隔離、監控告警} 補償控制驗證 {如何確認補償控制有效} 📖 使用說明 補償控制要能驗證:例如以攻擊樣本測試 WAF 規則確實攔截 可達性分析需附依據(程式碼搜尋結果、呼叫圖),供複核 💡 範例 欄位 內容 可達性分析 Foo#parseXml 僅於管理後台匯入功能使用(grep -rn "parseXml" src/ 共 1 處) 殘餘風險 低:功能已關閉且限內網 ADMIN 權限 補償控制 1. 匯入功能以 Feature Flag admin-xml-import 關閉;2. WAF 加入 XXE 特徵規則 補償控制驗證 以 XXE 測試樣本呼叫匯入 API → WAF 回 403;Flag 狀態於 Flag 平台確認為 off 3. 核准與期限 📝 範本 欄位 內容 接受期限 {YYYY-MM-DD}(最長 {N} 個月) 到期處理 {重新評估/修補/延長需重新核准} 核准者 {資安主管、系統擁有者},{日期} 📖 使用說明 風險接受必須有期限;到期未處理視同違規 核准者至少包含資安主管與系統擁有者,PM 或開發者不得自行核准 💡 範例 欄位 內容 接受期限 2026-11-30 到期處理 上游若已發布修補版本則升級;否則重新評估並重新核准 核准者 資安主管 李小華、系統擁有者 陳大文,2026-10-02 4. 審查與驗證 本節供審查者使用,也用來檢查 AI 依本範本產出的風險接受單是否正確。 ...

October 6, 2026 · 1 min · 211 words · Eric Cheng

程式規格書(Program Specification)範本

程式規格書(Program Specification Document)範本 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 3.4 節 參照標準:IEEE 1016-2009、ISO/IEC/IEEE 12207:2026、ISO/IEC 8631:1989 適用對象:系統分析師(SA)、開發工程師、委外/外包開發廠商 文件性質:單一程式/批次工作之詳細規格文件,作為程式撰寫與驗收的直接藍圖 📑 章節目錄 文件資訊 程式基本資訊 功能說明 輸入規格 輸出規格 處理邏輯 畫面/報表版面配置 資料庫/檔案存取設計 錯誤處理與訊息代碼 效能與作業排程考量 測試要點 附錄 審查與驗證 範例:客戶月結對帳批次程式(BATCH-CUST-RECON-001) 📋 使用說明 程式規格書是以「單一程式或批次工作」為撰寫單位的實作藍圖,將 TSD(技術規格文件)的模組/服務層級設計,進一步展開為可直接編碼的輸入輸出欄位、處理邏輯、畫面或報表版面與錯誤代碼。相較於 TSD 偏重物件導向的類別/方法設計,程式規格書更貼近傳統主機、批次、報表與轉檔程式的撰寫方式。 何時使用本範本 批次程式(Batch Job):日結、月結、對帳、資料清算等排程程式 報表程式:產出固定版面報表、對外申報檔案 介面轉檔程式:與外部系統的檔案交換、資料匯入匯出 委外/外包開發:需要逐支程式驗收,規格必須避免「口頭補充」 任何需要精確定義輸入輸出欄位與處理邏輯、無法僅以 TSD 類別設計涵蓋的程式 與其他文件的關係 SDD(如何設計整體架構) → TSD(模組/服務層級技術規格) → 程式規格書(單一程式的實作藍圖) → Source Code ↑ ↑ ↑ ↑ 架構師 開發工程師 SA / 開發工程師 開發工程師 TSD 定義模組內的類別、方法、演算法與資料結構,適合物件導向、微服務式的系統設計 程式規格書 則是「向下再展開一層」:把 TSD 的設計具體落實到單一程式的輸入來源、輸出目的、逐步處理邏輯與例外情境,讓程式撰寫者(含委外廠商)不需回頭詢問即可完成編碼 兩者可搭配使用:物件導向服務層級用 TSD;批次/報表/轉檔類程式或委外驗收則另補程式規格書 填寫原則 輸入輸出明確:每個欄位都需標註型別、長度、必要性與驗證規則,不可只用文字概略描述 處理邏輯可執行:流程敘述與虛擬碼需精確到可直接轉換為程式碼,邏輯表示法建議依循 ISO/IEC 8631 的慣例(結構化流程圖/虛擬碼),避免撰寫者各自發明符號 正常與異常並重:正常流程之外,需完整列出所有已知的例外情境與對應處理、錯誤代碼 可獨立驗收:規格本身應足以作為驗收依據,尤其用於委外開發時 📄 範本正文 [程式代號/程式名稱] 程式規格書 1. 文件資訊 項目 內容 文件編號 PSD-[專案代碼]-[程式代碼]-[序號] 版本 v0.1 建立日期 YYYY-MM-DD 最後更新 YYYY-MM-DD 撰寫者 [SA / 開發工程師姓名] 審核者 [技術主管 / 架構師] 狀態 草稿 / 審查中 / 已核准 版本歷程 版本 日期 修改人 修改內容摘要 v0.1 YYYY-MM-DD [姓名] 初版建立 關聯文件 文件名稱 文件編號 版本 關聯性 技術規格文件(TSD) TSD-XXX-001 v1.0 所屬模組技術設計 系統設計文件(SDD) SDD-XXX-001 v1.0 系統架構來源 2. 程式基本資訊 項目 內容 程式代號 [如 BATCH-CUST-RECON-001] 程式名稱 [程式中文名稱] 程式類型 Online(線上)/ Batch(批次)/ Report(報表)/ Interface(介面轉檔) 所屬系統/模組 [系統名稱] 觸發方式 排程(Cron)/ 人工執行 / 事件觸發 / API 呼叫 執行排程 [如:每月最後一個工作日 02:00] 前置程式 [執行前必須先完成的程式代號,無則填「無」] 後續程式 [本程式完成後接續執行的程式代號,無則填「無」] 預估工時 [人天] 3. 功能說明 3.1 程式目的 一句話說明本程式解決什麼問題、為何需要。 ...

August 17, 2026 · 3 min · 596 words · Eric Cheng

PRD(產品需求文件)範本

PRD(產品需求文件|Product Requirement Document)範本 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 3.2、3.3、3.4 節 參照標準:ISO/IEC/IEEE 29148:2018、ISO 9241-210:2019、IIBA BABOK v3 適用對象:產品經理、UI/UX 設計師、業務分析師、開發團隊 文件性質:產品需求定義與功能規劃文件 📑 章節目錄 文件資訊 產品概述 使用者輪廓(User Persona) 核心功能清單(Feature List) 流程圖(Process Flow) 介面原型(Wireframe) 非功能性需求(Non-Functional Requirements) 依賴與限制 里程碑與時程 風險與緩解措施 術語定義 附件與參考 審查與驗證 範例:電子商務平台 PRD 摘要 📋 使用說明 PRD 是將商業目標轉譯為具體功能需求的關鍵文件,定義「產品要做什麼」。它是 UI/UX 設計師與工程團隊開發的主要依據,橋接業務需求(BRD)與技術實作(SDD/TSD)之間的落差。 何時使用本範本 新產品或新功能的需求定義階段 產品重大改版前的需求整理 跨部門協作時的需求溝通基準文件 填寫原則 以使用者為中心:所有功能描述應從使用者角度出發 量化可驗證:驗收條件必須可量化、可測試 優先序明確:使用 MoSCoW 或數字排序標明優先級 迭代更新:隨需求演進持續更新文件版本 📄 範本正文 [產品/功能名稱] 產品需求文件(PRD) 1. 文件資訊 項目 內容 文件編號 PRD-[專案代碼]-[序號] 版本 v0.1 建立日期 YYYY-MM-DD 最後更新 YYYY-MM-DD 撰寫者 [產品經理姓名] 審核者 [審核者姓名 / 角色] 核准者 [核准者姓名 / 角色] 狀態 草稿 / 審查中 / 已核准 / 已凍結 版本歷程 版本 日期 修改人 修改內容摘要 v0.1 YYYY-MM-DD [姓名] 初版建立 審核紀錄 審核者 角色 審核日期 結果 備註 通過 / 有條件通過 / 退回 2. 產品概述 2.1 產品願景 簡述本產品/功能的願景,說明為何需要此產品,以及期望達成的長期目標。 ...

May 19, 2026 · 5 min · 900 words · Eric Cheng

SDD(系統設計文件)範本

SDD(系統設計文件|System Design Document)範本 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 4.1–4.8 節 參照標準:ISO/IEC/IEEE 42010:2022、ISO/IEC 25010:2023、ISO/IEC/IEEE 15288:2023 適用對象:系統架構師、資深開發工程師、技術主管 文件性質:系統技術架構與設計決策文件 📑 章節目錄 文件資訊 系統概述 系統架構 模組劃分(Module Decomposition) 資料庫綱要設計(Database Schema) API 介面規格(API Specification) 資安規範(Security Design) 非功能性設計 整合設計(Integration Design) 錯誤處理與容錯設計 可觀測性設計(Observability) 設計決策記錄(ADR) 審查與驗證 範例:電商系統 SDD 摘要 📋 使用說明 SDD 用於制定技術解決方案,規劃「系統要如何實作」。內容涵蓋系統架構、資料庫綱要(Schema)、API 介面規格、模組劃分與資安規範,確保系統具備擴展性與穩定性。 何時使用本範本 系統設計階段,將需求(PRD/FRD/SRD)轉化為技術方案 重大架構變更前的設計評審 跨團隊技術溝通的基準文件 與其他文件的關係 PRD(做什麼) → SDD(如何設計) → TSD(如何實作) ↑ ↑ ↑ 產品經理 架構師 開發工程師 填寫原則 決策可追溯:每個設計決策需記錄原因與替代方案 圖文並茂:架構圖、序列圖、ER 圖等應完整呈現 安全優先:每個模組需考慮資安面向 可演進:設計應預留擴展空間 📄 範本正文 [系統/模組名稱] 系統設計文件(SDD) 1. 文件資訊 項目 內容 文件編號 SDD-[專案代碼]-[序號] 版本 v0.1 建立日期 YYYY-MM-DD 最後更新 YYYY-MM-DD 撰寫者 [架構師姓名] 審核者 [審核者姓名 / 角色] 核准者 [核准者姓名 / 角色] 狀態 草稿 / 審查中 / 已核准 版本歷程 版本 日期 修改人 修改內容摘要 v0.1 YYYY-MM-DD [姓名] 初版建立 審核紀錄 審核者 角色 審核日期 結果 備註 通過 / 有條件通過 / 退回 關聯文件 文件名稱 文件編號 版本 關聯性 產品需求文件(PRD) PRD-XXX-001 v1.0 需求來源 功能需求文件(FRD) FRD-XXX-001 v1.0 功能規格 系統需求規格書(SRD) SRD-XXX-001 v1.0 系統規格 2. 系統概述 2.1 系統背景與目標 簡述本系統的業務背景、核心問題,以及本設計文件欲達成的技術目標。 ...

May 19, 2026 · 8 min · 1583 words · Eric Cheng

TSD(技術規格文件)範本

TSD(技術規格文件|Technical Specification Document)範本 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 5.1–5.6、6.1 節 參照標準:ISO/IEC/IEEE 15288:2023、ISO/IEC 25010:2023、IEEE 1016-2009 適用對象:資深開發工程師、技術主管、QA 工程師 文件性質:工程師實作指南與底層技術規格文件 📑 章節目錄 文件資訊 技術概述 類別與函式設計(Class & Function Design) 演算法邏輯(Algorithm Design) 資料結構(Data Structures) 錯誤處理機制(Error Handling) 自動化測試規劃(Test Plan) 組態與環境設定 建置與部署 程式碼品質標準 審查與驗證 範例:訂單服務 TSD 摘要 📋 使用說明 TSD 是工程師的實作指南,詳細說明「底層技術與程式碼邏輯」。內容涵蓋類別與函式設計、演算法邏輯、資料結構、錯誤處理機制及自動化測試規劃。 何時使用本範本 進入開發實作階段前,將 SDD 的設計轉化為可直接編碼的技術規格 複雜演算法或業務邏輯需要詳細記錄時 技術交接或 Code Review 的參考文件 與其他文件的關係 PRD(做什麼) → SDD(如何設計) → TSD(如何實作) ↑ ↑ ↑ 產品經理 架構師 開發工程師 填寫原則 可直接編碼:規格描述需精確到可直接轉換為程式碼 測試可驗證:每個功能模組需附帶測試策略 錯誤完整:覆蓋所有已知的錯誤場景與處理方式 效能可量化:關鍵演算法需標注時間/空間複雜度 📄 範本正文 [模組/功能名稱] 技術規格文件(TSD) 1. 文件資訊 項目 內容 文件編號 TSD-[專案代碼]-[模組代碼]-[序號] 版本 v0.1 建立日期 YYYY-MM-DD 最後更新 YYYY-MM-DD 撰寫者 [工程師姓名] 審核者 [技術主管 / 架構師] 狀態 草稿 / 審查中 / 已核准 版本歷程 版本 日期 修改人 修改內容摘要 v0.1 YYYY-MM-DD [姓名] 初版建立 關聯文件 文件名稱 文件編號 版本 關聯性 系統設計文件(SDD) SDD-XXX-001 v1.0 架構設計 產品需求文件(PRD) PRD-XXX-001 v1.0 需求來源 API 規格文件 API-XXX-001 v1.0 介面規格 2. 技術概述 2.1 模組/功能範圍 簡述本 TSD 涵蓋的模組或功能範圍,以及與其他模組的邊界。 ...

May 19, 2026 · 10 min · 1919 words · Eric Cheng

API 規格文件範本(API Specification Template)

API 規格文件範本(API Specification Document) 參照標準:OpenAPI Specification 3.1(OAS 3.1)/ Linux Foundation 標準 文件用途:定義 RESTful API 的端點、請求/回應格式、認證機制與錯誤處理規範 適用階段:系統設計階段(Detail Design Phase) 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 4.3 節 📋 章節目錄 文件資訊 API 概述 認證與授權 共用規範 端點定義 資料模型 錯誤處理 版本策略 OpenAPI 規格檔 附錄 審查與驗證 1. 文件資訊 📝 範本 項目 內容 文件編號 API-{專案代碼}-{序號} API 名稱 {系統名稱} API API 版本 v{主版本} 文件版本 v{主版本}.{次版本} 狀態 草稿 / 審核中 / 已發布 建立日期 {YYYY-MM-DD} 最後更新 {YYYY-MM-DD} 負責人 {姓名/角色} Base URL https://{domain}/api/v{version} 📖 使用說明 API 版本與文件版本分開管理:API 版本影響端點路徑,文件版本追蹤文件修訂 Base URL 需區分環境(DEV/SIT/UAT/PROD) 依據 OpenAPI 3.1 info 物件結構設計 💡 範例 項目 內容 文件編號 API-HRM-001 API 名稱 HRMS API API 版本 v1 Base URL https://api.company.com/hrms/v1 2. API 概述 📝 範本 2.1 API 目的 {描述此 API 提供的服務範圍與主要功能} ...

May 18, 2026 · 9 min · 1840 words · Eric Cheng