Feature Flag 登記表範本(Feature Flag Register Template)

Feature Flag 登記表範本(Feature Flag Register) 參照標準:OpenFeature 規格(CNCF) 文件用途:登記每個 Feature Flag 的用途、擁有者、預設值與移除日期,避免旗標變成無人管理的技術債 適用階段:開發、部署與維運階段 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 8.4 節 📋 章節目錄 旗標登記 變更紀錄 清理檢查 審查與驗證 1. 旗標登記 📝 範本 旗標名稱 類型 用途 擁有者 預設值(安全值) 目前狀態 建立日 預計移除日 {kebab-case 名稱} {發布/營運開關/實驗/權限} {說明} {姓名} {值與理由} {各環境狀態} {日期} {日期} 📖 使用說明 類型 用途 生命週期 發布(Release) 隱藏未完成功能、逐步開放 短:全面開放後 30 天內移除 營運開關(Ops) 緊急關閉高耗能或不穩定功能(Kill Switch) 長:需定期確認仍需要 實驗(Experiment) A/B 測試 實驗結束即移除 權限(Permission) 依客戶或方案開放功能 長:視同產品設定 預設值必須是「安全」的行為(通常是舊流程或關閉):旗標服務故障時不得啟用未完成的功能 名稱用 kebab-case,描述行為而非人名或工單號 💡 範例 旗標名稱 類型 用途 擁有者 預設值(安全值) 目前狀態 建立日 預計移除日 new-leave-quota-check 發布 新版特休額度檢查 Tech Lead 王 false(走舊檢查) DEV on/UAT on/PRD 25% 2026-09-20 2026-11-15 admin-xml-import 營運開關 管理後台 XML 匯入(RA-2026-07 期間關閉) 資安 李 false 全環境 off 2025-03-01 不移除(每季確認) 2. 變更紀錄 📝 範本 時間 旗標 環境 變更 執行者 核准者 原因 {YYYY-MM-DD HH:MM} {名稱} {環境} {舊值 → 新值} {姓名} {姓名} {原因/工單} 📖 使用說明 正式環境的旗標變更等同上線,必須留稽核紀錄並經核准 優先使用旗標平台內建的稽核日誌,本表作為摘要 💡 範例 時間 旗標 環境 變更 執行者 核准者 原因 2026-10-06 10:00 new-leave-quota-check PRD 0% → 25% DevOps 林 PO 王 漸進開放(CHG-2026-118) 3. 清理檢查 📝 範本 旗標名稱 是否已全面開放或廢止 程式中引用處 清理 PR 狀態 {名稱} {是/否} {檔案:行數} {PR 連結} {待清理/已移除} 📖 使用說明 每個 Sprint 檢查過期的旗標;移除旗標時同時刪除舊流程程式碼與對應測試 長期不清理的旗標會產生無法測試的組合,並增加事故風險 💡 範例 旗標名稱 是否已全面開放或廢止 程式中引用處 清理 PR 狀態 leave-attachment-v2 是(2026-08-01 起 100%) LeaveController.java:88、LeaveService.java:142 #1301 已移除 4. 審查與驗證 本節供審查者使用,也用來檢查 AI 依本範本產出的登記表是否正確。 ...

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

上線檢核清單範本(Go-Live Checklist Template)

上線檢核清單範本(Go-Live Checklist Template) 適用標準:ITIL 4 Release Management(ITIL Version 5 已於 2026-01 發布,過渡期間 ITIL 4 仍適用)、ISO/IEC 20000-1:2018 適用階段:部署上線階段(Deployment Phase) 負責角色:Release Manager、PM、Tech Lead 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 2.4(G3)、10.1 節 📑 章節目錄 文件資訊 上線概要 上線前置作業檢核 上線當日檢核 上線後驗證檢核 通訊與通知計畫 回退判定與流程 簽核記錄 附錄 審查與驗證 📝 範本 1. 文件資訊 項目 內容 文件名稱 [系統名稱] 上線檢核清單 文件編號 [專案代碼]-GLC-[版本號]-[日期] 版本 v[X.Y] 預定上線日期 [YYYY-MM-DD HH:mm] 上線視窗 [YYYY-MM-DD HH:mm] ~ [HH:mm] Release Manager [姓名] 核准者 [PM / IT Director] 2. 上線概要 項目 內容 上線類型 [全新上線 / 版本升級 / Hotfix / 設定變更] 影響範圍 [影響的模組/功能/用戶群] 預計停機時間 [N 分鐘 / 零停機] 影響用戶數 [N] 人 回退計畫 [有 / 無] → 參考 §7 相關 Change Request [CR-NNN] 3. 上線前置作業檢核 3.1 開發與測試 # 檢核項目 負責人 完成日 狀態 備註 1 所有功能開發完成並合併至 release branch [Dev Lead] [日期] [✅/❌/N/A] 2 Code Review 完成(所有 PR 已核准) [Dev Lead] [日期] [✅/❌/N/A] 3 單元測試通過率 ≥ [N]% [Dev] [日期] [✅/❌/N/A] 4 整合測試全數通過 [QA] [日期] [✅/❌/N/A] 5 UAT 簽核完成 [PO/使用者] [日期] [✅/❌/N/A] 6 效能測試報告 — 符合 NFR 標準 [QA/效能] [日期] [✅/❌/N/A] 7 安全掃描通過(Critical/High = 0) [AppSec] [日期] [✅/❌/N/A] 8 Regression Test 通過 [QA] [日期] [✅/❌/N/A] 3.2 部署準備 # 檢核項目 負責人 完成日 狀態 備註 9 部署手冊/腳本已更新並審閱 [DevOps] [日期] [✅/❌/N/A] 10 CI/CD Pipeline 驗證通過(Staging) [DevOps] [日期] [✅/❌/N/A] 11 資料庫 Migration Script 已測試 [DBA] [日期] [✅/❌/N/A] 12 回退腳本已準備並測試 [DevOps/DBA] [日期] [✅/❌/N/A] 13 設定檔已更新(環境變數/Config) [DevOps] [日期] [✅/❌/N/A] 14 TLS 憑證/網域確認有效(剩餘效期 > 30 天,已設定到期監控) [Infra] [日期] [✅/❌/N/A] 15 第三方服務/API 就緒確認 [SA] [日期] [✅/❌/N/A] 16 容量/資源已到位(VM / K8s / DB) [Infra] [日期] [✅/❌/N/A] 3.3 文件與溝通 # 檢核項目 負責人 完成日 狀態 備註 17 Release Note 已完成 [PM/Dev] [日期] [✅/❌/N/A] 18 使用者手冊/教育訓練已更新 [PM/BA] [日期] [✅/❌/N/A] 19 維運文件(SOP/Runbook)已更新 [SRE/DevOps] [日期] [✅/❌/N/A] 20 內部上線通知已發送 [PM] [日期] [✅/❌/N/A] 21 外部用戶公告已發送(如需要) [PM/行銷] [日期] [✅/❌/N/A] 22 客服/Help Desk 已知悉異動內容 [PM] [日期] [✅/❌/N/A] 3.4 監控與告警 # 檢核項目 負責人 完成日 狀態 備註 23 監控 Dashboard 已設定 [SRE] [日期] [✅/❌/N/A] 24 告警規則已設定並測試 [SRE] [日期] [✅/❌/N/A] 25 Log 收集已確認正常 [SRE] [日期] [✅/❌/N/A] 26 健康檢查端點已設定 [Dev/DevOps] [日期] [✅/❌/N/A] 4. 上線當日檢核 4.1 上線前(T - 30 min) # 檢核項目 負責人 時間 狀態 備註 27 War Room 成員全數到位 [RM] [HH:mm] [✅/❌] 28 溝通管道確認(Teams/Slack channel) [RM] [HH:mm] [✅/❌] 29 最終 Go/No-Go 確認 [PM + 各角色] [HH:mm] [✅/❌] 30 生產環境備份完成 [DBA/Infra] [HH:mm] [✅/❌] 4.2 上線執行中 # 步驟 負責人 預計時間 實際時間 狀態 備註 31 [開始維護公告/流量切離] [RM] [HH:mm] [✅/❌] 32 [DB Migration 執行] [DBA] [HH:mm] [✅/❌] 33 [應用程式部署] [DevOps] [HH:mm] [✅/❌] 34 [設定檔/環境變數更新] [DevOps] [HH:mm] [✅/❌] 35 [快速健康檢查] [DevOps] [HH:mm] [✅/❌] 36 [流量恢復/維護公告移除] [RM] [HH:mm] [✅/❌] 5. 上線後驗證檢核 5.1 即時驗證(T + 15 min) # 檢核項目 負責人 狀態 備註 37 Health Check / Liveness 正常 [DevOps] [✅/❌] 38 核心功能 Smoke Test 通過 [QA] [✅/❌] 39 Log 無 Error/Exception 異常暴增 [SRE] [✅/❌] 40 監控指標正常(CPU/Memory/TPS) [SRE] [✅/❌] 41 資料庫連線正常 [DBA] [✅/❌] 5.2 穩定觀察期(T + 1~4 hr) # 檢核項目 負責人 狀態 備註 42 錯誤率維持正常水位 [SRE] [✅/❌] 43 回應時間無惡化 [SRE] [✅/❌] 44 無使用者回報問題 [客服/PM] [✅/❌] 45 排程任務正常執行 [DevOps] [✅/❌] 6. 通訊與通知計畫 階段 通知對象 通知方式 內容重點 負責人 上線前 1 週 內部團隊 Email/Teams 上線時程與影響 PM 上線前 1 天 外部用戶 公告/Email 維護視窗通知 PM 上線開始 War Room 成員 Teams Channel Go 指令 RM 上線完成 全體利害關係人 Email 完成通知 PM 異常/回退 管理層 + 用戶 電話 + Email 狀況說明 PM/RM 7. 回退判定與流程 7.1 回退觸發條件 # 條件 判定者 優先級 1 核心功能 Smoke Test 失敗 QA + PM 立即回退 2 Error Rate > [N]% 持續 [N] 分鐘 SRE 立即回退 3 P95 回應時間 > [N]ms 持續 [N] 分鐘 SRE 評估回退 4 資料完整性問題 DBA 立即回退 5 安全性事件 AppSec 立即回退 7.2 回退步驟摘要 # 步驟 負責人 預估時間 1 宣告回退決定 RM/PM 即刻 2 [流量切離/維護模式] DevOps [N] min 3 [應用程式回退至前版] DevOps [N] min 4 [DB rollback(如有)] DBA [N] min 5 [驗證回退成功] QA [N] min 6 [恢復流量] DevOps [N] min 8. 簽核記錄 階段 角色 姓名 簽核日期 結果 Go/No-Go PM [姓名] [日期] [Go / No-Go] Go/No-Go Tech Lead [姓名] [日期] [Go / No-Go] Go/No-Go QA Lead [姓名] [日期] [Go / No-Go] 上線完成確認 RM [姓名] [日期] [成功 / 回退] 觀察期結束 SRE [姓名] [日期] [穩定 / 待觀察] 9. 附錄 9.1 War Room 聯絡人 角色 姓名 電話 備註 Release Manager [姓名] [電話] DBA [姓名] [電話] DevOps [姓名] [電話] Dev Lead [姓名] [電話] 9.2 相關文件連結 文件 連結 Release Note [link] 部署手冊 [link] 回退計畫 [link] 監控 Dashboard [link] 10. 審查與驗證 本節供審查者使用,也用來檢查 AI 依本範本產出的文件是否正確;對應《軟體開發標準程序教學手冊》v2.0 各章的「審查與驗證」。 ...

May 18, 2026 · 4 min · 809 words · Eric Cheng

事件報告與根因分析範本(Incident Report & RCA Template)

事件報告與根因分析範本(Incident Report & Root Cause Analysis) 參照標準:ITIL 4(Incident Management & Problem Management)/ ISO/IEC 20000-1:2018 / SRE Postmortem 文件用途:記錄生產環境事件、分析根本原因、制定改善行動,防止問題再次發生 適用階段:維運監控階段(Operations Phase)— Continuous Improvement 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 10.3、12.1 節 📋 章節目錄 事件摘要 時間軸 影響評估 根因分析 解決方案 改善行動計畫 經驗教訓 附錄 審查與驗證 1. 事件摘要 📝 範本 項目 內容 事件編號 INC-{YYYYMMDD}-{序號} 事件標題 {一句話描述事件} 嚴重等級 SEV1(Critical)/ SEV2(Major)/ SEV3(Minor)/ SEV4(Low) 事件狀態 調查中 / 已解決 / 已關閉 發生時間 {YYYY-MM-DD HH:MM} (UTC+8) 偵測時間 {YYYY-MM-DD HH:MM} 解決時間 {YYYY-MM-DD HH:MM} 事件持續時間 {N} 分鐘/小時 MTTD {偵測時間 - 發生時間} MTTR(恢復時間) {服務恢復時間 - 發生時間} 是否由部署造成 {是:部署 ID/commit SHA(計入 DORA 失敗部署復原時間與變更失敗率)/ 否} 是否為資安事件 {是:已通知資安單位,並判斷法定通報義務 / 否} 受影響系統 {系統/服務名稱} 受影響使用者 {人數/比例} 事件負責人 {Incident Commander} 報告撰寫者 {姓名} 報告日期 {YYYY-MM-DD} 📖 使用說明 嚴重等級定義: SEV1:核心業務完全中斷,影響全部使用者 SEV2:核心功能嚴重降級,影響大部分使用者 SEV3:非核心功能異常,影響部分使用者 SEV4:輕微異常,幾乎不影響使用者 MTTD(Mean Time To Detect):衡量監控能力 MTTR(Mean Time To Restore):從事件發生到服務恢復的時間,衡量恢復能力;若由部署造成,同時計入 DORA 的「失敗部署復原時間」 資安事件:涉及個資外洩或系統遭入侵時,另有法定通報義務與時限(資通安全管理法、個人資料保護法),必須依公司資安事件應變程序處理 事件報告需在事件解決後 3-5 個工作日 內完成 Blameless 原則:報告聚焦系統與流程改善,不歸咎個人 💡 範例 項目 內容 事件編號 INC-20260520-001 事件標題 HRMS 薪資查詢 API 持續回傳 500 Error 嚴重等級 SEV2(核心功能嚴重降級) 發生時間 2026-05-20 10:15 偵測時間 2026-05-20 10:18(Grafana 告警) 解決時間 2026-05-20 10:28(回滾完成) 事件持續時間 13 分鐘 MTTD 3 分鐘 MTTR(恢復時間) 13 分鐘(10:15 發生 → 10:28 恢復) 是否由部署造成 是(v2.1.0 部署造成;計入 DORA 變更失敗率與失敗部署復原時間) 是否為資安事件 否 受影響使用者 ~200 人(薪資查詢功能不可用) 事件負責人 張 SRE 2. 時間軸 📝 範本 時間 (UTC+8) 事件 執行者 備註 {HH:MM} {發生/偵測/行動/解決} {人員} {補充說明} 📖 使用說明 時間軸是事件報告最有價值的部分,需精確到分鐘 涵蓋:事件發生 → 偵測 → 通知 → 診斷 → 緩解 → 解決 → 驗證 資料來源:監控日誌、Slack 訊息時間戳、告警記錄 時間軸讓團隊復盤流程效率,找出可改善的環節 💡 範例 時間 (UTC+8) 事件 執行者 備註 10:12 v2.1.0 部署完成,新版上線 DevOps 林 K8s Green deployment 完成 10:15 薪資計算排程 CronJob 啟動(與 API 衝突) System 排程被新設定觸發 10:15 DB Lock 衝突開始,API 回應逾時 System PostgreSQL row-level lock 10:18 Grafana 告警:5xx rate > 5% Alert System #hrms-alerts 頻道 10:19 SRE 張確認告警,開始調查 SRE 張 檢查 Pod 日誌 10:21 確認問題:DB Lock contention SRE 張 pg_stat_activity 發現 lock wait 10:23 聯繫 Tech Lead 決策:啟動回滾 SRE 張 → Tech Lead 王 Slack 通訊 10:24 Tech Lead 確認回滾,授權執行 Tech Lead 王 10:25 開始執行回滾腳本 SRE 張 ./rollback-hrms-v2.1.0.sh 10:27 流量切換至 v2.0.3 完成 SRE 張 Blue deployment 10:28 健康檢查通過,冒煙測試通過 SRE 張 + QA 陳 服務恢復 10:30 通知團隊:服務已恢復 SRE 張 Slack + Email 10:45 通知受影響使用者:服務已恢復 PM 林 系統公告 3. 影響評估 📝 範本 3.1 業務影響 影響維度 評估 受影響功能 {功能清單} 受影響使用者數 {人數/比例} 收入損失 {金額/無法計量} 資料損失 {是/否,描述} SLA 違反 {是/否,影響 SLA 指標} 信譽影響 {高/中/低} 3.2 技術影響 影響維度 評估 受影響服務 {服務清單} 相依服務影響 {是否連鎖影響} 資料一致性 {是否受影響} 安全性影響 {是否有安全疑慮} 📖 使用說明 影響評估用於確認嚴重等級是否正確、作為改善優先級依據 業務影響由 PM/產品團隊提供;技術影響由工程團隊評估 SLA 違反需記錄,可能涉及客戶賠償或內部 KPI 💡 範例 3.1 業務影響 影響維度 評估 受影響功能 薪資查詢、薪資條下載 受影響使用者數 ~200 人(嘗試查詢薪資的員工) 收入損失 無直接收入損失(內部系統) 資料損失 無 SLA 違反 否(SLA 99.5% 月度,本月仍在 SLA 內) 信譽影響 低(事件持續 13 分鐘,非上班尖峰) 4. 根因分析 📝 範本 4.1 根本原因 Root Cause Statement: ...

May 18, 2026 · 5 min · 1011 words · Eric Cheng

回滾計畫範本(Rollback Plan Template)

回滾計畫範本(Rollback Plan) 參照標準:ITIL 4(Release and Deployment Management)/ ISO/IEC 20000-1:2018 文件用途:定義版本上線後若出現嚴重問題時的回復策略與操作步驟 適用階段:部署上線階段(Deployment Phase)— Change Enablement 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 8.3 節 📋 章節目錄 文件資訊 回滾觸發條件 回滾決策流程 回滾策略 回滾前準備 回滾執行步驟 資料庫回滾 回滾驗證 通知與溝通 回滾後行動 審查與驗證 1. 文件資訊 📝 範本 項目 內容 文件編號 RP-{專案代碼}-{版本}-{序號} 文件名稱 {系統名稱} v{x.x.x} 回滾計畫 版本 v{主版本}.{次版本} 對應發佈版本 v{x.x.x} 建立日期 {YYYY-MM-DD} 撰寫者 {DevOps/SRE 姓名} 審核者 {Tech Lead / SM} 回滾時間窗口 上線後 {N} 小時內 最大容許停機 {N} 分鐘 回滾方式 Blue-Green / Canary Rollback / 全量回滾 📖 使用說明 回滾計畫是部署計畫的必要附件,每次上線都需準備 回滾時間窗口:超過此時間,資料可能已累積,回滾成本大幅增加 回滾方式取決於部署架構: Blue-Green:切換流量至舊版(秒級) Canary Rollback:停止灰度,流量回到舊版(秒級) 全量回滾:重新部署舊版 Image(分鐘級) 💡 範例 項目 內容 文件編號 RP-HRM-v2.1.0-001 對應發佈版本 v2.1.0 回滾時間窗口 上線後 4 小時內 最大容許停機 5 分鐘 回滾方式 Blue-Green(K8s Service 切換) 2. 回滾觸發條件 📝 範本 2.1 自動觸發(需設定監控告警) 條件 ID 觸發條件 監控指標 閾值 RT-AUTO-{xxx} {條件描述} {指標} {閾值} 2.2 人工判斷觸發 條件 ID 觸發條件 判斷依據 決策者 RT-MANUAL-{xxx} {條件描述} {判斷依據} {角色} 📖 使用說明 自動觸發:由監控系統偵測到異常時自動發起(或告警後快速決策) 人工判斷:需要人為判斷的複雜情境 觸發條件需事先定義並經團隊共識,避免上線時臨時爭論 💡 範例 2.1 自動觸發 條件 ID 觸發條件 監控指標 閾值 RT-AUTO-001 API 錯誤率飆升 HTTP 5xx Rate > 5% 持續 3 分鐘 RT-AUTO-002 回應時間嚴重惡化 P95 Latency > 5s 持續 5 分鐘 RT-AUTO-003 核心服務健康檢查失敗 Health Check 連續 3 次失敗 RT-AUTO-004 資料庫連線耗盡 DB Connection Pool > 95% 使用率持續 2 分鐘 2.2 人工判斷觸發 條件 ID 觸發條件 判斷依據 決策者 RT-MANUAL-001 核心業務流程異常(薪資計算錯誤) 使用者回報 + 日誌確認 Tech Lead RT-MANUAL-002 資安事件(疑似資料洩露) 資安告警 + SOC 確認 資安主管 RT-MANUAL-003 資料損壞(不一致/遺失) DB 檢查確認 DBA + Tech Lead 3. 回滾決策流程 📝 範本 偵測異常 → 通知值班人員 → 初步評估(5 分鐘內) │ ├── 可快速修復(Hotfix) → 修復並部署 → 持續觀察 │ └── 無法快速修復 → 啟動回滾決策 │ ├── 決策者確認回滾 → 執行回滾 │ └── 暫時降級(Feature Flag) → 持續觀察 決策權限矩陣 情境 決策者 升級時機 {情境} {角色} {超過 N 分鐘未解決時升級} 📖 使用說明 決策流程需在 5-15 分鐘內完成,避免長時間討論 權限矩陣確保深夜/假日也有人可做決策 Feature Flag 降級是比全量回滾更輕量的選項(如果有準備的話) 💡 範例 決策權限矩陣 情境 決策者 升級時機 上班時間(09-18) Tech Lead → PM 10 分鐘未決定 → VP Engineering 下班/假日 值班 SRE → On-call Tech Lead 15 分鐘未回應 → VP Engineering 資安事件 資安主管(不論時段) 立即通知 CTO 4. 回滾策略 📝 範本 4.1 回滾方式比較 方式 停機時間 適用場景 風險 {方式} {時間} {場景} {風險} 4.2 本次採用策略 項目 說明 回滾方式 {Blue-Green / Canary / Rolling / 全量} 回滾目標版本 v{x.x.x} 預計停機時間 {N} 分鐘 資料庫回滾 是/否(需要/不需要) Feature Flag 是/否(可局部降級) 📖 使用說明 選擇回滾策略需考量:停機影響、資料安全、回復速度 Blue-Green 最快(秒級切換)但需雙倍資源 有 DB Schema 變更時回滾最複雜,需額外評估 若有 Feature Flag,優先考慮關閉新功能而非全量回滾 💡 範例 4.1 回滾方式比較 方式 停機時間 適用場景 風險 Blue-Green 切換 < 30s K8s Service selector 切換 新舊版 DB Schema 需相容 Canary 回滾 < 30s 灰度比例回 0% 僅灰度階段可用 K8s Rolling Rollback 2-5 min kubectl rollout undo 過程中有混合版本 全量回滾 + DB Restore 15-30 min DB Schema 不相容時 停機長、可能丟失資料 4.2 本次採用策略 項目 說明 回滾方式 Blue-Green(K8s 保留舊版 Deployment) 回滾目標版本 v2.0.3 預計停機時間 < 1 分鐘 資料庫回滾 否(DB Migration 向後相容) Feature Flag 是(可先關閉 WebSocket 推播功能) 5. 回滾前準備 📝 範本 5.1 準備清單(部署前完成) # 準備事項 負責人 狀態 1 {準備事項} {人員} ☐ 2 {準備事項} {人員} ☐ 5.2 環境快照 項目 備份位置 備份時間 保留期限 {項目} {位置} {時間} {期限} 📖 使用說明 回滾準備必須在部署「前」完成,而非出問題才做 資料庫快照是最重要的準備(資料不可逆) 確認舊版 Image 仍可取得、舊版設定仍可存取 💡 範例 5.1 準備清單 # 準備事項 負責人 狀態 1 資料庫全量備份(pg_dump) DBA ☑ 2 保留舊版 Deployment(hrms-blue, replicas=0) DevOps ☑ 3 確認舊版 Image 可拉取:hrms:v2.0.3 DevOps ☑ 4 備份 Kong 路由設定 DevOps ☑ 5 確認 Feature Flag 可遠端關閉 後端組 ☑ 6 值班人員確認聯絡方式 SM ☑ 5.2 環境快照 項目 備份位置 備份時間 保留期限 PostgreSQL Full Backup Azure Blob / hrm-backup/ 部署前 30 分鐘 7 天 Redis RDB Snapshot Azure Blob / redis-backup/ 部署前 30 分鐘 3 天 Kong Config Export Git repo / infra/kong/ 部署前 commit 永久 K8s Manifest (old) Git repo / k8s/ 部署前 Tag 永久 6. 回滾執行步驟 📝 範本 6.1 執行步驟(依序執行) 步驟 動作 命令/操作 預期結果 執行者 1 {動作} {命令} {預期} {人員} 2 {動作} {命令} {預期} {人員} 6.2 回滾腳本 #!/bin/bash # Rollback Script - {系統名稱} v{x.x.x} → v{x.x.x} # 使用方式:./rollback.sh {腳本內容} 📖 使用說明 步驟需足夠詳細,讓非撰寫者也能執行 回滾腳本需事前測試(在 Staging 環境驗證) 每個步驟標明預期結果,便於判斷是否正確執行 腳本優先於手動操作(減少人為失誤) 💡 範例 6.1 執行步驟 步驟 動作 命令/操作 預期結果 執行者 1 確認決策 Slack 記錄回滾決策 決策者確認 SM 2 關閉新功能 Feature Flag LaunchDarkly: payroll-scheduler=OFF, ws-notification=OFF Flag 生效 後端組 3 切換流量至舊版 kubectl patch svc hrms -p '{"spec":{"selector":{"version":"v2.0.3"}}}' 流量轉到 Blue DevOps 4 Scale up 舊版 kubectl scale deploy hrms-blue --replicas=3 3 Pod Running DevOps 5 驗證舊版健康 curl https://hrms.internal/health HTTP 200 + version=v2.0.3 DevOps 6 Scale down 新版 kubectl scale deploy hrms-green --replicas=0 0 Pod DevOps 7 更新 Kong 路由 移除 /ws 路由 WebSocket 端點移除 DevOps 8 驗證完整功能 執行冒煙測試腳本 All Pass QA 6.2 回滾腳本 #!/bin/bash # Rollback Script - HRMS v2.1.0 → v2.0.3 # 使用方式:./rollback-hrms-v2.1.0.sh set -euo pipefail echo "=== HRMS Rollback: v2.1.0 → v2.0.3 ===" echo "開始時間: $(date -Iseconds)" # Step 1: Scale up old version echo "[1/5] Scaling up v2.0.3 (Blue)..." kubectl scale deploy hrms-blue --replicas=3 -n hrms kubectl rollout status deploy/hrms-blue -n hrms --timeout=120s # Step 2: Switch traffic echo "[2/5] Switching Service to v2.0.3..." kubectl patch svc hrms-api -n hrms \ -p '{"spec":{"selector":{"version":"v2.0.3"}}}' # Step 3: Verify health echo "[3/5] Verifying health..." sleep 5 HEALTH=$(curl -s -o /dev/null -w "%{http_code}" https://hrms.internal/health) if [ "$HEALTH" != "200" ]; then echo "ERROR: Health check failed! Manual intervention required." exit 1 fi # Step 4: Scale down new version echo "[4/5] Scaling down v2.1.0 (Green)..." kubectl scale deploy hrms-green --replicas=0 -n hrms # Step 5: Remove WebSocket route echo "[5/5] Removing WebSocket route from Kong..." curl -s -X DELETE http://kong-admin:8001/routes/hrms-websocket echo "=== Rollback Complete: $(date -Iseconds) ===" echo "請執行冒煙測試驗證: ./smoke-test.sh" 7. 資料庫回滾 📝 範本 7.1 DB Migration 相容性評估 Migration 描述 向後相容 回滾方式 {Migration 名稱} {描述} 是/否 {回滾方式} 7.2 資料庫回滾步驟(若需要) 步驟 動作 命令 風險 1 {動作} {命令} {風險} 📖 使用說明 向後相容的 Migration:新增欄位/表 → 不需回滾(舊版忽略新欄位即可) 不相容的 Migration:刪除/重命名欄位 → 必須回滾 資料庫回滾最危險,可能造成資料遺失,需事先做好備份 原則:盡量設計向後相容的 Migration(Expand-Contract Pattern) 💡 範例 7.1 DB Migration 相容性評估 Migration 描述 向後相容 回滾方式 AddNotificationLogs 新增 notification_logs 表 ✅ 是 不需回滾(舊版不使用此表) AddSchedulerColumns payroll 表新增 3 個 nullable 欄位 ✅ 是 不需回滾(舊版忽略) ✅ 本版所有 Migration 均為向後相容,無需資料庫回滾 ...

May 18, 2026 · 6 min · 1266 words · Eric Cheng

標準作業程序範本(SOP Template)

標準作業程序範本(Standard Operating Procedure, SOP) 參照標準:ISO 9001:2015(Quality Management)/ ISO/IEC 20000-1:2018 / ITIL 4 文件用途:標準化維運操作流程,確保操作一致性、降低人為錯誤、加速新人上手 適用階段:維運監控階段(Operations Phase)— Operational Excellence 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 10.1、11.2 節 📋 章節目錄 文件資訊 目的與範圍 角色與職責 前置條件 操作步驟 驗證與確認 異常處理 安全注意事項 相關文件 變更歷史 審查與驗證 1. 文件資訊 📝 範本 項目 內容 文件編號 SOP-{類別代碼}-{序號} 文件名稱 {操作名稱} 標準作業程序 版本 v{主版本}.{次版本} 狀態 草稿 / 審核中 / 核定 / 作廢 建立日期 {YYYY-MM-DD} 生效日期 {YYYY-MM-DD} 下次審核日期 {YYYY-MM-DD}(至少每年) 撰寫者 {姓名/角色} 審核者 {姓名/角色} 核准者 {姓名/角色} 適用系統 {系統/服務名稱} 機密等級 一般 / 限閱 / 機密 📖 使用說明 SOP 編號慣例:SOP-{類別}-{流水號} 類別代碼範例:DEP(部署)、INC(事件處理)、BAK(備份)、MON(監控) 每份 SOP 需定期審核(ISO 9001 要求),避免過時 狀態管理:草稿 → 審核中 → 核定(可執行)→ 作廢(新版取代) 機密等級決定誰可以存取此 SOP 💡 範例 項目 內容 文件編號 SOP-BAK-001 文件名稱 HRMS 資料庫每日備份標準作業程序 版本 v2.0 生效日期 2026-05-01 下次審核日期 2027-05-01 適用系統 HRMS PostgreSQL 16 (Azure Database) 2. 目的與範圍 📝 範本 2.1 目的 {說明此 SOP 為何存在、解決什麼問題} ...

May 18, 2026 · 5 min · 977 words · Eric Cheng

版本發行說明範本(Release Notes Template)

版本發行說明範本(Release Notes) 參照標準:Keep a Changelog 1.1.0 / SemVer 2.0.0 / ISO/IEC/IEEE 12207:2026(Release Management) 文件用途:正式記錄每個版本的變更內容,供開發、維運、使用者了解版本差異 適用階段:部署上線階段(Deployment Phase)— Release Management 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 7.2、8.1 節 📋 章節目錄 文件資訊 版本摘要 新增功能(Added) 變更項目(Changed) 修復項目(Fixed) 棄用項目(Deprecated) 移除項目(Removed) 安全性修復(Security) 已知問題(Known Issues) 升級指南 相容性說明 審查與驗證 1. 文件資訊 📝 範本 項目 內容 產品名稱 {系統名稱} 版本號 v{MAJOR}.{MINOR}.{PATCH} 發佈日期 {YYYY-MM-DD} 版本類型 Major / Minor / Patch / Hotfix 發佈人 {Release Manager 姓名} Git Tag {tag name} Build Number #{build} 對應里程碑 {Sprint/Milestone 名稱} 📖 使用說明 版本號遵循 SemVer 2.0.0: MAJOR:不相容的 API 變更 MINOR:向後相容的新功能 PATCH:向後相容的 Bug 修復 每次正式發佈(含 Hotfix)都需要 Release Notes Git Tag 與 Build Number 確保可從 Release Notes 追溯到原始碼 💡 範例 項目 內容 產品名稱 人力資源管理系統(HRMS) 版本號 v2.1.0 發佈日期 2026-05-20 版本類型 Minor 發佈人 林 DevOps Git Tag v2.1.0 Build Number #489 對應里程碑 Sprint 12 2. 版本摘要 📝 範本 概述 {用 2-3 句話描述本版本的核心主題與重要變更} ...

May 18, 2026 · 5 min · 868 words · Eric Cheng

監控與告警設定文件範本(Monitoring & Alert Configuration Template)

監控與告警設定文件範本(Monitoring & Alert Configuration Template) 適用標準:Google SRE Workbook、ISO/IEC 20000-1:2018(Service Monitoring) 適用階段:維運階段(Operations Phase) 負責角色:SRE、DevOps Engineer、Tech Lead 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 10.2 節 📑 章節目錄 文件資訊 監控策略概要 SLI / SLO 定義 監控指標設計 告警規則定義 Dashboard 設計 告警通知與升級 日誌監控策略 維護與檢討機制 附錄 審查與驗證 📝 範本 1. 文件資訊 項目 內容 文件名稱 [系統名稱] 監控與告警設定文件 文件編號 [專案代碼]-MON-[版本號]-[日期] 版本 v[X.Y] 建立日期 [YYYY-MM-DD] 負責人 [SRE / DevOps] 審核者 [Tech Lead / SA] 2. 監控策略概要 2.1 監控架構 層級 工具 用途 Infrastructure [Prometheus / CloudWatch / Azure Monitor] 主機/容器/網路 Application [APM: Datadog / New Relic / OpenTelemetry] 應用效能 Business [Custom metrics / Analytics] 業務指標 Logging [ELK / Loki / Azure Log Analytics] 日誌分析 Tracing [Jaeger / Zipkin / OpenTelemetry] 分散式追蹤 2.2 監控原則 原則 說明 Four Golden Signals Latency, Traffic, Errors, Saturation USE Method Utilization, Saturation, Errors(基礎設施) RED Method Rate, Errors, Duration(服務) Alerting Philosophy Alert on symptoms, not causes 3. SLI / SLO 定義 3.1 服務層級指標(SLI) SLI 定義 量測方式 資料來源 Availability 成功回應比例 success_requests / total_requests [Load Balancer / App] Latency 回應時間分佈 P50, P95, P99 [APM / Prometheus histogram] Throughput 處理量 Requests per second [Metrics] Error Rate 錯誤回應比例 5xx_count / total_count [Ingress / App] 3.2 服務層級目標(SLO) 服務 SLO 指標 目標值 Error Budget (月) 量測視窗 [API Service] Availability ≥ 99.9% 43.2 min(30 天 × 0.1%) 30 days rolling [API Service] P95 Latency < [N]ms — 30 days rolling [Web Frontend] Availability ≥ 99.5% 3.6 hr 30 days rolling [Batch Job] Success Rate ≥ 99.0% — Per execution 4. 監控指標設計 4.1 基礎設施指標 以下為 Prometheus node_exporter 的實際指標名稱;使用率需以 PromQL 計算,不是直接輸出的指標: ...

May 18, 2026 · 6 min · 1265 words · Eric Cheng

系統退役計畫範本(System Retirement Plan Template)

系統退役計畫範本(System Retirement Plan Template) 適用標準:ISO/IEC/IEEE 15288:2023(System Life Cycle - Disposal Process) 適用階段:維運階段 — 退役處理(Operations — Retirement Phase) 負責角色:PM、SA、DBA、Infra、資安 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 2.1(退役階段) 節 📑 章節目錄 文件資訊 退役概要 影響分析 資料處置計畫 基礎設施釋放計畫 相依系統處理 溝通計畫 退役執行步驟 驗證與確認 風險與應變 附錄 審查與驗證 📝 範本 1. 文件資訊 項目 內容 文件名稱 [系統名稱] 退役計畫 文件編號 [專案代碼]-RTP-[版本號]-[日期] 版本 v[X.Y] 建立日期 [YYYY-MM-DD] 預計退役日 [YYYY-MM-DD] 負責人 [PM / SA] 審核者 [IT Director / CISO] 2. 退役概要 項目 內容 系統名稱 [退役系統名稱] 系統用途 [一句話描述系統功能] 上線日期 [YYYY-MM-DD] 服務年限 [N] 年 退役原因 [被取代 / 業務需求消失 / 技術不支援 / 成本效益] 替代系統 [新系統名稱] 或 [無] 影響用戶數 [N] 人 退役方式 [立即下線 / 漸進退場 / 唯讀保留期] 2.1 退役判定準則 準則 說明 是否滿足 替代系統已上線並穩定 [新系統 GAP 已關閉] [✅/❌] 使用者已完成遷移 [N]% 已切換至新系統 [✅/❌] 資料已完成遷移/封存 [全量遷移完成] [✅/❌] 相依系統已解耦 [所有介接已切換] [✅/❌] 法規保留要求已確認 [保留年限/方式已確定] [✅/❌] 3. 影響分析 3.1 利害關係人影響 利害關係人 影響描述 嚴重度 緩解措施 [內部使用者] [無法再使用舊系統] [Low] [已遷移至新系統] [外部合作夥伴] [API 中斷] [Medium] [提前通知 + 新 API 對接] [報表使用者] [歷史報表查詢] [Medium] [資料封存 + 查詢介面] 3.2 功能影響盤點 功能模組 狀態 替代方案 備註 [模組 A] 已遷移至新系統 [新系統模組 X] [模組 B] 功能廢除 無 [業務確認不再需要] [模組 C] 部分功能無替代 [Manual process / 新建] ⚠️ GAP 3.3 合規與法規要求 法規/政策 要求 資料保留期 處理方式 [個資法] 個人資料銷毀或去識別化 — [銷毀/去識別化] [商業法] 財務交易記錄保留 [N] 年 [封存至 Archive] [公司政策] [內部規範] [N] 年 [方式] 4. 資料處置計畫 4.1 資料分類與處置 資料類別 資料表/儲存 筆數 大小 處置方式 備註 已遷移資料 [tables] [N] [N]GB 驗證後刪除 遷移至新系統 法規保留資料 [tables] [N] [N]GB 封存至冷儲存 保留 [N] 年 個人資料 [tables] [N] [N]GB 去識別化/銷毀 依個資法 暫存/Log [tables] [N] [N]GB 直接刪除 無保留價值 附件/檔案 [storage] [N] [N]GB [遷移/封存/刪除] 4.2 資料封存規格 項目 內容 封存格式 [SQL dump / Parquet / CSV + Schema] 封存位置 [Cold Storage / Archive Vault] 加密方式 [AES-256 / 由保管庫管理] 存取方式 [申請制 / 限特定角色] 保留期限 [N] 年,到期後 [自動銷毀 / 覆審] 驗證方式 [Checksum / Restore test] 4.3 資料銷毀證明 銷毀項目 方式 執行日 執行人 驗證人 證明文件 [DB data] [TRUNCATE + VACUUM / Secure erase] [日期] [DBA] [資安] [存證編號] [File storage] [Secure delete / Disk wipe] [日期] [Infra] [資安] [存證編號] [Backup tapes] [Degauss / Physical destruction] [日期] [Infra] [資安] [存證編號] 5. 基礎設施釋放計畫 5.1 資源盤點 資源類型 名稱/ID 規格 月費 處置方式 預計釋放日 VM / 主機 [hostname/ID] [spec] $[N] [刪除/重新用途] [日期] Database [instance name] [spec] $[N] [刪除] [日期] Storage [bucket/share] [N]GB $[N] [資料移出後刪除] [日期] Load Balancer [name] — $[N] [刪除] [日期] DNS Record [domain] — — [刪除/轉向] [日期] TLS Certificate [CN] — — [不續約] [到期日] Monitoring [Dashboard/Alert] — — [刪除] [日期] 5.2 成本節約估計 項目 月費 年費 備註 計算資源 $[N] $[N] 儲存 $[N] $[N] 授權 (License) $[N] $[N] 維護合約 $[N] $[N] 合計節省 $[N] $[N] 6. 相依系統處理 6.1 上游系統(呼叫退役系統的系統) 來源系統 介接方式 呼叫頻率 處理方式 負責人 狀態 [System A] REST API [N] calls/day 切換至新系統 API [PM of A] [✅/❌] [System B] DB Link [N] queries/day 移除 DB Link [DBA] [✅/❌] 6.2 下游系統(退役系統呼叫的系統) 目標系統 介接方式 影響 處理方式 狀態 [System C] Event publish [訂閱者需取消] 通知訂閱者 [✅/❌] 6.3 共用元件 元件 共用者 可否移除 處理方式 [Shared DB] [系統列表] [否] [僅移除退役系統的 Schema] [Message Queue] [系統列表] [是/否] [移除 Topic / 保留] 7. 溝通計畫 時間點 對象 內容 方式 負責人 T - 90 天 所有使用者 退役預告 + 遷移指引 Email + 公告 PM T - 60 天 相依系統負責人 技術切換時程 會議 SA T - 30 天 所有使用者 最後提醒 + 進入唯讀期 Email + In-app PM T - 7 天 全體 最終通知 Email + Teams PM T day IT 團隊 執行退役 War Room RM T + 1 天 全體 退役完成通知 Email PM 8. 退役執行步驟 # 步驟 負責人 預估時間 前置條件 狀態 1 切換至唯讀模式 DevOps [N] min T-30d 通知完成 2 最終資料備份 DBA [N] hr 唯讀模式已啟用 3 驗證最終備份完整性 DBA [N] hr 備份完成 4 DNS 移除/轉向 Infra [N] min 5 停止應用程式服務 DevOps [N] min DNS 已處理 6 移除相依系統連線設定 SA/DevOps [N] hr 相依系統已切換 7 資料封存(法規保留) DBA [N] hr 備份驗證通過 8 資料銷毀(非保留資料) DBA/Infra [N] hr 封存完成 9 基礎設施釋放 Infra [N] hr 資料處置完成 10 監控/告警移除 SRE [N] min 服務已停止 11 文件更新(架構圖/CMDB) SA [N] hr 全部完成 12 退役完成確認 PM — 全部驗證通過 9. 驗證與確認 9.1 退役前驗證 # 驗證項目 方法 預期結果 狀態 1 新系統功能涵蓋率 UAT 驗收 100% 功能可替代 [✅/❌] 2 資料遷移完整性 Count + Sample 驗證 差異 = 0 [✅/❌] 3 相依系統已切換 連線測試 無對退役系統的呼叫 [✅/❌] 4 使用者已遷移 登入統計 活躍用戶 = 0 [✅/❌] 9.2 退役後驗證 # 驗證項目 方法 預期結果 狀態 1 舊系統不可存取 URL/IP 測試 Connection refused / 404 [✅/❌] 2 新系統運作正常 Smoke Test 全數通過 [✅/❌] 3 封存資料可存取 Restore 測試 資料完整可讀 [✅/❌] 4 無殘留資源 CMDB / Cloud Console 檢查 資源已清除 [✅/❌] 5 成本已停止計費 帳單確認 下月帳單減少 [✅/❌] 10. 風險與應變 # 風險 影響 機率 應變措施 1 使用者未完成遷移 業務中斷 Medium 延長唯讀期 + 人工協助 2 發現未識別的相依系統 相依系統異常 Medium 保留 DNS 轉向頁 30 天 3 法規保留期判定錯誤 合規風險 Low 法務覆審 + 寧可多保留 4 封存資料無法還原 資料遺失 Low 保留完整備份至驗證通過 5 退役後需要回溯查詢 業務查詢困難 Medium 建立簡易查詢介面 for 封存資料 11. 附錄 11.1 系統架構圖(退役前) [附上退役系統目前的架構圖,標示將移除的元件] ...

May 18, 2026 · 5 min · 931 words · Eric Cheng

資料遷移計畫範本(Data Migration Plan Template)

資料遷移計畫範本(Data Migration Plan Template) 適用標準:ISO/IEC 25024(資料品質)、DAMA DMBOK 2.0(Data Management) 適用階段:部署上線階段(Deployment Phase) 負責角色:DBA、Data Engineer、SA、PM 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 4.4、8.3 節 📑 章節目錄 文件資訊 遷移概要 來源與目標分析 遷移策略 資料映射規則 資料清洗與轉換規則 驗證策略 風險與應變 時程與里程碑 附錄 審查與驗證 📝 範本 1. 文件資訊 項目 內容 文件名稱 [系統名稱] 資料遷移計畫 文件編號 [專案代碼]-DMP-[版本號]-[日期] 版本 v[X.Y] 建立日期 [YYYY-MM-DD] 負責人 [DBA / Data Engineer] 審核者 [SA / PM] 2. 遷移概要 項目 內容 遷移類型 [全量遷移 / 增量遷移 / 混合式] 來源系統 [舊系統名稱 + 版本] 目標系統 [新系統名稱 + 版本] 遷移目的 [系統升級 / 平台轉換 / 整併 / 雲遷移] 資料量估計 [N] GB / [N] 筆記錄 停機視窗 [YYYY-MM-DD HH:mm ~ HH:mm] 遷移方式 [Big Bang / Phased / Parallel Run] 3. 來源與目標分析 3.1 來源系統 項目 內容 資料庫類型 [RDBMS: SQL Server / Oracle / PostgreSQL / NoSQL] 版本 [ver] Schema 數量 [N] Table 數量 [N] 總資料量 [N] GB 編碼 [UTF-8 / Big5 / …] 3.2 目標系統 項目 內容 資料庫類型 [RDBMS / NoSQL / Data Lake] 版本 [ver] Schema 設計 [New / Modified / Same] 字元編碼 [UTF-8] 3.3 遷移範圍 資料分類 資料表 筆數(估) 大小(估) 優先級 備註 Master Data [table list] [N] [N]MB P1 Transaction Data [table list] [N] [N]GB P1 Historical Data [table list] [N] [N]GB P2 Config/Lookup [table list] [N] [N]KB P1 Attachments/BLOB [storage] [N] [N]GB P2 3.4 排除範圍 資料類型 排除原因 [暫存資料/Log] [無業務價值] [超過 N 年的歷史資料] [封存處理] 4. 遷移策略 4.1 遷移方式比較 方式 說明 優點 缺點 適用場景 Big Bang 一次性全量搬遷 簡單明確 停機時間長 資料量小/可停機 Phased 分批搬遷 降低風險 需處理雙寫 資料可分割 Parallel Run 新舊並行 最安全 成本最高 核心業務系統 選定策略:[Big Bang / Phased / Parallel Run] ...

May 18, 2026 · 5 min · 1002 words · Eric Cheng

運維手冊範本(Runbook Template)

運維手冊範本(Runbook) 參照標準:ITIL 4 Service Operation / ISO/IEC 20000-1:2018 第 8.5 節「Service delivery」 文件用途:提供系統日常維運、告警處理、故障排除的標準化操作程序 適用階段:營運維護階段(Operations & Maintenance) 範本版本:v2.0(2026-10-06)|對應《軟體開發標準程序教學手冊》v2.0 第 10.2、10.3 節 📋 章節目錄 文件資訊 系統概述 常見操作程序 告警處理 故障排除決策樹 緊急聯絡人 SLA 與 SLO 維護窗口與排程作業 備份與還原 附錄 審查與驗證 1. 文件資訊 📝 範本 項目 內容 文件編號 RB-{專案代碼}-{序號} 文件名稱 {系統名稱} 運維手冊 版本 v{主版本}.{次版本} 建立日期 {YYYY-MM-DD} 最後更新 {YYYY-MM-DD} 維護者 {姓名/團隊} 適用環境 Production / Staging / All 版本歷程 版本 日期 修改人 修改內容 v1.0 {日期} {姓名} 初版 📖 使用說明 Runbook 為活文件,需隨系統變更持續更新 任何維運操作變更需同步更新本文件 建議每季審閱一次,確保內容與現況一致 💡 範例 項目 內容 文件編號 RB-HRM-001 文件名稱 HRMS 運維手冊 維護者 DevOps 團隊 — 周維運 適用環境 Production 2. 系統概述 📝 範本 2.1 系統架構 {架構圖 — 包含所有元件與連接關係} 2.2 元件清單 元件名稱 技術堆疊 部署位置 端點 用途 {元件} {技術} {位置} {URL/IP} {說明} 2.3 相依服務 外部服務 用途 端點 擁有者 SLA {服務} {用途} {端點} {團隊} {SLA} 2.4 存取方式 環境 入口 認證方式 備註 {環境} {URL/方式} {認證} {備註} 📖 使用說明 系統概述幫助值班人員快速了解系統全貌 元件清單需包含所有運行中的服務(含背景 Worker、排程任務等) 相依服務標明擁有者,出問題時知道找誰 💡 範例 2.2 元件清單 元件名稱 技術堆疊 部署位置 端點 用途 hrms-api .NET 8 Web API AKS hrms-prod ns https://hrms-api.internal:443 後端 API hrms-web React 18 + Nginx AKS hrms-prod ns https://hrms.company.com 前端 SPA hrms-worker .NET 8 Worker Service AKS hrms-prod ns N/A(內部處理) 背景排程任務 PostgreSQL v16 Azure DB for PostgreSQL hrms-db.postgres.database.azure.com:5432 主資料庫 Redis v7 Azure Cache for Redis hrms-cache.redis.cache.windows.net:6380 Session + Cache 3. 常見操作程序 📝 範本 3.1 {操作名稱} 項目 內容 操作目的 {為什麼要做} 執行頻率 手動觸發 / 每日 / 每週 / 每月 預估時間 {分鐘} 影響範圍 {影響說明} 所需權限 {權限} 步驟: ...

May 18, 2026 · 8 min · 1669 words · Eric Cheng