架構設計指引

系統架構設計指引 企業標準技術白皮書|版本 v2.0|2026-10-07 適用範圍:以 Java / Spring Boot 為後端、以 Web 前端為使用介面,部署在容器平台(Kubernetes)的企業應用系統,涵蓋架構治理、品質屬性、架構風格、整合、API、資料、效能、韌性、安全、可觀測性、部署平台與交付流程。 v2.0 全面改寫 v1.x:依 ISO/IEC/IEEE 42010:2022、ISO/IEC 25010:2023、OWASP Top 10:2025、NIST SP 800-207 等國際標準重新組織內容;每條規則都附有範例與「驗證方式」,每節結尾都有「🔍 審查與驗證」,讓審查者能判斷 AI 或同事產出的架構設計是否正確。範例均經工具實測(見 附錄 E)。 目錄 0. 文件資訊 0.1 文件目的與讀者 0.2 技術基準版本 0.3 規範等級與規則格式 0.4 與其他指引的關係 0.5 如何閱讀本指引 0.6 例外與豁免流程 1. 架構治理與國際標準 1.1 國際標準與參考框架 1.2 架構原則 1.3 技術選型與技術雷達 1.4 架構決策紀錄 (ADR) 1.5 架構文件:arc42 與 C4 模型 1.6 架構審查流程 1.7 架構適應度函數 (Fitness Functions) 2. 品質屬性與非功能需求 2.1 ISO/IEC 25010:2023 品質模型 2.2 非功能需求的量化 2.3 品質情境與取捨分析 2.4 SLI、SLO 與錯誤預算 2.5 成本與永續性目標 3. 架構風格與系統拆分 3.1 架構風格的選擇 3.2 模組化單體與 Spring Modulith 3.3 領域驅動設計:戰略設計 3.4 微服務拆分準則 3.5 演進式遷移:Strangler Fig 4. 整合與通訊 4.1 同步與非同步通訊的選擇 4.2 API Gateway 與 Kubernetes Gateway API 4.3 服務網格 (Service Mesh) 4.4 可靠的訊息傳遞:Outbox 與冪等 4.5 分散式交易與 Saga 4.6 事件與 API 契約 5. API 設計 5.1 API 優先與 OpenAPI 規格 5.2 資源與 URL 設計 5.3 HTTP 狀態碼 5.4 錯誤回應:RFC 9457 Problem Details 5.5 分頁、排序與過濾 5.6 API 版本管理與棄用 5.7 速率限制與請求保護 5.8 API 文件 6. 前端架構 6.1 渲染策略的選擇 6.2 BFF 與瀏覽器端的權杖安全 6.3 微前端 6.4 響應式設計與無障礙 6.5 多語系與時區 7. 後端分層架構 7.1 Clean Architecture 與六角形架構 7.2 分層規則與依賴方向 7.3 套件結構 7.4 架構測試的導入策略 7.5 依賴注入與組態 7.6 交易邊界 8. 資料架構 8.1 資料儲存選型 8.2 資料擁有權與存取 8.3 CQRS 與讀取模型 8.4 讀寫分離與資料分割 8.5 資料庫結構演進 8.6 資料分級與生命週期 8.7 多資料庫支援策略 9. 效能與擴展性 9.1 效能設計原則 9.2 快取策略 9.3 CDN 與靜態資源 9.4 非同步處理與 Virtual Threads 9.5 水平擴展與負載平衡 9.6 效能測試與容量規劃 10. 韌性、高可用與災難復原 10.1 韌性模式 10.2 高可用部署 10.3 健康檢查 10.4 災難復原:RTO 與 RPO 10.5 業務連續性規劃 10.6 混沌工程與故障演練 11. 安全架構 11.1 安全設計與威脅建模 11.2 零信任架構 11.3 身分驗證 11.4 授權與物件層級存取控制 11.5 OWASP Top 10:2025 與 API Security Top 10 對照 11.6 機密管理與資料保護 11.7 Web 安全標頭 11.8 軟體供應鏈安全 11.9 稽核日誌與例外處理 12. 可觀測性 12.1 可觀測性架構 12.2 分散式追蹤 12.3 日誌 12.4 指標與 SLO 告警 12.5 儀表板與值班 13. 容器與部署平台 13.1 容器映像 13.2 JVM 的容器設定 13.3 工作負載設定 13.4 組態與機密管理 13.5 GitOps 與環境推進 13.6 准入政策與 Pod Security 13.7 部署設定的自動驗證 14. 持續整合與交付 14.1 交付流程設計 14.2 CI 管線 14.3 測試策略 14.4 漸進式交付與功能旗標 14.5 交付績效指標(DORA) 15. 微服務治理 15.1 服務發現 15.2 組態管理 15.3 排程工作與分散式鎖 15.4 事件與主題治理 15.5 平台工程與黃金路徑 16. AI 輔助架構設計與審查 16.1 AI 在架構工作中的定位 16.2 讓 AI 依指引產出:提示與專案指示檔 16.3 審查 AI 產出的五個步驟 16.4 AI 常見錯誤速查表 16.5 AI 使用的資料治理 附錄 A 規則總表 A.1 依領域統計 A.2 驗證方式與範例覆蓋 A.3 規則清單 附錄 B 架構審查檢核表 B.1 概念與設計審查 B.2 實作審查(抽查) B.3 上線審查 B.4 對照雲端 Well-Architected 支柱 附錄 C 範本 C.1 ADR 範本(MADR 4.0) C.2 arc42 架構文件大綱 C.3 品質情境與非功能需求規格 C.4 威脅模型範本 附錄 D 參考標準與資源 D.1 國際標準 D.2 IETF 規格 D.3 安全標準 D.4 架構方法與框架 D.5 技術文件 D.6 企業內部相關指引 附錄 E 修訂紀錄與查證紀錄 E.1 版本紀錄 E.2 v1.x 章節去向對照 E.3 v1.x 主要更正 E.4 查證紀錄 E.5 待查項目 結語 0. 文件資訊 0.1 文件目的與讀者 本指引定義企業應用系統的架構決策標準:哪些事情必須這樣做、為什麼、做到什麼程度才算合格,以及如何驗證。它回答的是「系統應該長什麼樣子」,而不是「某一行程式碼怎麼寫」。程式碼層級的規範請見 程式寫作指引。 ...

October 31, 2025 · 131 min · 27770 words · Eric Cheng

業務需求收集範本

業務需求收集範本 Prompt 目標 協助 AI 理解如何進行系統性的業務需求收集,產生完整的業務需求文檔。 角色設定 你是一位資深業務分析師,具備豐富的需求收集經驗,能夠透過結構化的方法收集、分析和文檔化業務需求。 任務描述 請協助我完成 {專案名稱} 的業務需求收集工作。 專案背景資訊 專案名稱: {填入專案名稱} 專案類型: {填入專案類型,如:Web應用、移動應用、桌面應用等} 目標使用者: {填入目標使用者群體} 業務領域: {填入業務領域,如:電商、金融、教育等} 專案規模: {填入專案規模,如:小型、中型、大型} 具體要求 請按照以下結構產生業務需求文檔: 1. 專案概述 專案目標與願景 成功標準定義 專案範圍界定 主要限制條件 2. 利害關係人分析 識別所有利害關係人 分析各利害關係人的需求和期望 定義利害關係人的影響力和重要性 建立溝通策略 3. 業務流程分析 現有業務流程描述 問題點識別 改善機會分析 未來流程設計 4. 功能需求概述 核心功能列表 次要功能列表 可選功能列表 功能優先級排序 5. 業務規則 業務邏輯規則 驗證規則 計算規則 工作流程規則 6. 資料需求 主要資料實體 資料關係 資料品質要求 資料安全要求 輸出格式 請使用以下 Markdown 格式輸出: # {專案名稱} 業務需求文檔 ## 1. 專案概述 ### 1.1 專案目標與願景 [詳細描述] ### 1.2 成功標準 [具體的、可測量的成功標準] ### 1.3 專案範圍 [明確的範圍界定] ### 1.4 限制條件 [技術、時間、預算等限制] ## 2. 利害關係人分析 ### 2.1 利害關係人清單 | 角色 | 姓名/部門 | 需求/期望 | 影響力 | 重要性 | |------|----------|----------|--------|--------| | [角色] | [姓名] | [需求] | [高/中/低] | [高/中/低] | ### 2.2 溝通策略 [溝通方式和頻率] ## 3. 業務流程分析 ### 3.1 現有流程 [流程描述或流程圖] ### 3.2 問題分析 [問題點列表及影響分析] ### 3.3 改善建議 [具體改善方案] ## 4. 功能需求概述 ### 4.1 核心功能 - [功能1]: [描述] - [功能2]: [描述] ### 4.2 次要功能 - [功能1]: [描述] - [功能2]: [描述] ### 4.3 功能優先級 | 功能 | 優先級 | 理由 | |------|--------|------| | [功能] | [高/中/低] | [理由] | ## 5. 業務規則 ### 5.1 業務邏輯規則 - [規則1]: [描述] - [規則2]: [描述] ### 5.2 驗證規則 - [規則1]: [描述] - [規則2]: [描述] ## 6. 資料需求 ### 6.1 資料實體 - [實體1]: [屬性列表] - [實體2]: [屬性列表] ### 6.2 資料品質要求 - 準確性: [要求] - 完整性: [要求] - 一致性: [要求] 品質檢查清單 請確保產生的文檔包含以下要素: ...

October 31, 2025 · 2 min · 269 words · Eric Cheng

測試策略制定範本

測試策略制定範本 Prompt 目標 指導 AI 制定全面的軟體測試策略,涵蓋各種測試類型和測試方法。 角色設定 你是一位資深測試架構師和品質保證專家,具備豐富的測試策略規劃經驗,熟悉各種測試方法論和自動化測試框架。 任務描述 請協助我為 {專案名稱} 制定完整的測試策略。 專案測試背景 專案名稱: {填入專案名稱} 系統類型: {填入系統類型} 技術棧: {填入主要技術棧} 團隊規模: {填入開發團隊人數} 專案時程: {填入專案開發週期} 品質要求: {填入品質標準要求} 測試策略要求 請按照以下結構制定測試策略: 1. 測試目標和範圍 測試目標定義 測試範圍界定 品質標準設定 風險評估分析 2. 測試類型規劃 功能測試策略 非功能測試策略 安全測試策略 相容性測試策略 3. 測試層級設計 單元測試策略 整合測試策略 系統測試策略 驗收測試策略 4. 自動化測試規劃 自動化測試範圍 工具選型評估 框架架構設計 CI/CD 整合規劃 5. 測試環境規劃 測試環境需求 資料管理策略 環境配置管理 監控和維護計畫 6. 測試執行計畫 測試階段規劃 資源分配計畫 時程安排規劃 風險應對計畫 輸出格式 # {專案名稱} 測試策略文檔 ## 1. 測試概覽 ### 1.1 測試目標 **主要目標:** - 確保系統功能符合需求規格 - 驗證系統效能達到預期標準 - 保證系統安全性和穩定性 - 提升產品品質和使用者體驗 **品質目標:** - 功能覆蓋率: ≥ 95% - 程式碼覆蓋率: ≥ 80% - 缺陷逃逸率: ≤ 5% - 自動化測試比例: ≥ 70% ### 1.2 測試範圍 #### 包含範圍 - 所有核心業務功能 - 使用者介面和用戶體驗 - API 介面和資料交換 - 系統整合和第三方服務 - 安全性和權限控制 - 效能和可擴展性 #### 排除範圍 - 第三方組件內部邏輯 - 作業系統層級功能 - 網路基礎設施 - 瀏覽器內建功能 ### 1.3 品質標準 | 品質特性 | 標準 | 測量方法 | |----------|------|----------| | 功能性 | 95% 需求符合度 | 測試案例通過率 | | 可靠性 | 99.9% 系統可用性 | 系統監控數據 | | 效能 | 響應時間 < 2秒 | 效能測試報告 | | 易用性 | 8/10 使用者滿意度 | 使用者測試回饋 | | 安全性 | 0 高風險漏洞 | 安全掃描報告 | ## 2. 測試類型策略 ### 2.1 功能測試 #### 2.1.1 單元測試 **目標:** 驗證個別程式碼單元的正確性 **覆蓋率要求:** ≥ 80% **工具:** JUnit 5, Mockito, AssertJ **責任歸屬:** 開發人員 **測試重點:** - 業務邏輯正確性 - 邊界值處理 - 異常情況處理 - 資料驗證邏輯 #### 2.1.2 整合測試 **目標:** 驗證模組間介面和資料流 **類型:** - API 整合測試 - 資料庫整合測試 - 第三方服務整合測試 **工具:** TestContainers, WireMock, REST Assured #### 2.1.3 系統測試 **目標:** 驗證完整系統功能 **測試類型:** - 端對端功能測試 - 業務流程測試 - 使用案例驗證 **工具:** Selenium WebDriver, Cucumber ### 2.2 非功能測試 #### 2.2.1 效能測試 **測試類型:** - 負載測試: 正常負載下的系統表現 - 壓力測試: 超過正常負載的系統表現 - 容量測試: 系統處理能力上限 - 耐久性測試: 長時間運行的穩定性 **效能指標:** - 響應時間: 95% 請求 < 2秒 - 吞吐量: > 1000 TPS - 並發使用者: > 5000 - 資源使用率: CPU < 80%, Memory < 85% **工具:** JMeter, Gatling, K6 #### 2.2.2 安全測試 **測試範疇:** - 身份驗證和授權測試 - 輸入驗證和 SQL 注入防護 - 跨站腳本攻擊 (XSS) 防護 - 跨站請求偽造 (CSRF) 防護 - 敏感資料保護 **工具:** OWASP ZAP, Burp Suite, SonarQube Security #### 2.2.3 相容性測試 **瀏覽器相容性:** - Chrome (最新版本及前2版) - Firefox (最新版本及前2版) - Safari (最新版本及前1版) - Edge (最新版本及前2版) **作業系統相容性:** - Windows 10/11 - macOS (最新版本及前2版) - Ubuntu LTS **裝置相容性:** - 桌面電腦 (1920x1080 以上) - 平板電腦 (768x1024) - 手機 (375x667 以上) ## 3. 測試自動化策略 ### 3.1 自動化測試金字塔 ┌─────────────────┐ │ UI Tests │ ← 少量 (10%) │ (E2E Tests) │ ├─────────────────┤ │ Integration │ ← 中等 (30%) │ Tests │ ├─────────────────┤ │ Unit Tests │ ← 大量 (60%) │ │ └─────────────────┘ ### 3.2 自動化工具選型 #### 單元測試框架 **選擇:** JUnit 5 + Mockito **理由:** - 成熟穩定的 Java 測試框架 - 豐富的斷言和模擬功能 - 良好的 IDE 整合支援 - 活躍的社群和文檔 #### 整合測試工具 **API 測試:** REST Assured **資料庫測試:** TestContainers **模擬服務:** WireMock #### UI 自動化工具 **選擇:** Selenium WebDriver + Page Object Model **輔助工具:** WebDriverManager, Extent Reports ### 3.3 CI/CD 整合 #### 持續整合流程 程式碼提交 → 靜態分析 → 單元測試 → 建置 → 整合測試 → 部署測試環境 → E2E測試 → 產生報告 ...

October 31, 2025 · 5 min · 977 words · Eric Cheng

測試與品質保證指引

測試與品質保證指引 企業標準技術白皮書|版本 v2.0|2026-10-08 適用範圍:以 Java / Spring Boot 為後端、以 Web 前端為使用介面的企業應用系統,從需求到上線後的完整測試與品質保證活動。內容涵蓋 QA 治理、測試策略與流程、測試設計技術、單元/整合/API/契約/微服務/E2E/跨瀏覽器/無障礙/效能/安全測試、測試資料與環境、CI/CD 品質閘門、靜態測試、缺陷管理、品質指標、驗收與發布、AI 輔助測試與持續改進。 v2.0 全面改寫 v1(2025-08-27):依 ISO/IEC/IEEE 29119 系列、ISTQB CTFL 4.0.1、ISO/IEC 25010:2023、ISO/IEC 20246:2017、OWASP Top 10:2025、OWASP ASVS 5.0、WCAG 2.2、ISO/IEC TS 42119-2:2025 等國際標準重新組織內容。每條規則都附有範例與「驗證方式」,每節結尾都有「🔍 審查與驗證」,讓審查者能判斷 AI 或同事產出的測試是否正確。範例均經工具實測(見 附錄 F)。 目錄 0. 文件資訊 0.1 文件目的與讀者 0.2 技術基準版本 0.3 規範等級與規則格式 0.4 與其他指引的關係 0.5 如何使用本指引審查 AI 產出 0.6 例外與豁免 1. 品質保證治理與角色 1.1 品質保證、品質控制與測試 1.2 角色與責任 1.3 測試獨立性 1.4 品質目標與品質模型 2. 測試原則與策略 2.1 測試的七項原則 2.2 風險導向測試 2.3 測試層級與測試類型 2.4 測試組合:金字塔、獎盃與蜂巢 2.5 左移與右移 2.6 測試方法:TDD、BDD、ATDD 與探索式測試 3. 測試流程、計畫與監控 3.1 測試流程模型 3.2 測試計畫 3.3 進入、退出、暫停與恢復準則 3.4 測試估算 3.5 測試監控與控制 3.6 測試完成與測試完成報告 4. 測試設計技術 4.1 等價類劃分 4.2 邊界值分析 4.3 決策表 4.4 狀態轉移測試 4.5 組合測試與分類樹 4.6 白箱覆蓋與性質測試 4.7 經驗導向技術與探索式測試 4.8 選擇測試設計技術 5. 測試案例、追溯與 BDD 5.1 測試案例的結構 5.2 需求追溯 5.3 驗收條件與 BDD 5.4 關鍵字驅動測試 5.5 測試案例的維護 6. 單元測試 6.1 單元的範圍與 FIRST 原則 6.2 結構與命名 6.3 斷言 6.4 測試替身 6.5 參數化測試 6.6 測試的穩定性與隔離 7. 整合與元件測試 7.1 整合測試的範圍與分流 7.2 Spring Boot 4 的測試切片 7.3 以 Testcontainers 測試資料庫 7.4 以 WireMock 測試外部 HTTP 服務 7.5 測試資料的隔離與清理 8. API 與契約測試 8.1 API 測試的範圍 8.2 Web 層的驗證與錯誤格式測試 8.3 服務層級的 API 測試 8.4 消費者驅動的契約測試 8.5 API 規格的相容性檢查 9. 微服務、事件與韌性測試 9.1 微服務的測試策略 9.2 非同步訊息的測試 9.3 並行與資料一致性 9.4 韌性測試與混沌工程 10. 端到端與 UI 測試 10.1 E2E 測試的範圍 10.2 Playwright 的設定 10.3 定位器、斷言與等待 10.4 視覺回歸測試 11. 跨瀏覽器、行動與無障礙測試 11.1 支援矩陣 11.2 行動裝置與響應式測試 11.3 雲端測試服務 11.4 無障礙測試 12. 效能測試 12.1 效能測試的類型與時機 12.2 效能需求與工作負載模型 12.3 以 k6 撰寫負載測試 12.4 效能測試環境與執行 12.5 結果分析與報告 12.6 元件層級的基準測試與 JVM 設定 13. 安全測試 13.1 安全測試的類型與管線位置 13.2 依 OWASP Top 10:2025 規劃測試 13.3 認證與授權測試 13.4 注入與加密的驗證 13.5 濫用案例、安全記錄與滲透測試 14. 測試資料與隱私保護 14.1 測試資料策略 14.2 合成資料與 Test Data Builder 14.3 遮罩與去識別化 14.4 測試資料的生命週期與法規遵循 15. 測試環境與服務虛擬化 15.1 環境層級與一致性 15.2 以容器建立可重現的本機與 CI 環境 15.3 服務虛擬化 15.4 環境就緒與冒煙測試 16. 自動化架構與 CI/CD 品質閘門 16.1 測試自動化架構 16.2 流水線中的測試分層 16.3 品質閘門 16.4 不穩定測試的管理 16.5 執行效率 17. 靜態測試與審查 17.1 審查的類型與流程 17.2 需求的可測試性審查 17.3 程式碼審查 17.4 靜態分析 17.5 審查的量測與改進 18. 缺陷管理 18.1 缺陷生命週期 18.2 嚴重度與優先度 18.3 缺陷報告 18.4 分級會議 18.5 根本原因分析與缺陷預防 19. 品質量測與指標 19.1 指標的設計原則 19.2 覆蓋率與變異測試 19.3 缺陷相關指標 19.4 交付績效:DORA 指標 19.5 測試執行指標與報告 19.6 品質儀表板 20. 驗收、回歸與發布 20.1 驗收測試的種類 20.2 使用者驗收測試 20.3 回歸測試策略 20.4 發布就緒與上線後驗證 20.5 緊急修正 21. 其他非功能品質測試 21.1 可靠性與服務水準目標 21.2 災難復原與備份還原演練 21.3 相容性與升級測試 21.4 互動能力(可用性)測試 21.5 資料轉置與平行測試 21.6 可維護性與彈性 22. AI 輔助測試與 AI 系統測試 22.1 AI 在測試中的角色與風險 22.2 審查 AI 產生的測試 22.3 AI 輔助測試的治理 22.4 測試含有 AI 的系統 23. 成本效益、能力發展與持續改進 23.1 品質成本與測試投資 23.2 自動化的投資決策 23.3 測試流程改進 23.4 團隊協作與溝通 23.5 能力發展與新進成員 附錄 A 規則總表 A.1 依領域統計 A.2 驗證方式與範例覆蓋 A.3 規則清單 附錄 B 測試與品質審查檢核清單 B.1 需求可測試性檢核 B.2 測試策略與測試計畫檢核 B.3 測試程式審查檢核(含 AI 產出) B.4 發布就緒檢核 B.5 正式環境事件處理檢核 B.6 開發階段檢核 附錄 C 範本與工具 C.1 文件範本 C.2 本指引提供的設定與腳本 附錄 D 術語表 附錄 E 參考資料 E.1 國際標準與知識體系 E.2 安全、無障礙與法規 E.3 工具文件 附錄 F 修訂紀錄與查證紀錄 F.1 v1 與 v2 章節對照 F.2 v1 內容更正 F.3 查證紀錄 F.4 待查證與後續事項 F.5 版本紀錄 0. 文件資訊 0.1 文件目的與讀者 本指引是企業內部的測試與品質保證標準,目的有三: ...

October 31, 2025 · 136 min · 28863 words · Eric Cheng

物件導向分析與設計 (OOAD) 教學

物件導向分析與設計 (OOAD) 教學手冊 作者:系統架構師團隊 更新日期:2026 年 10 月 12 日 版本:v3.0 適用對象:新進開發同仁、資深工程師、技術主管、Code Reviewer 技術基準:OMG UML 2.5.1、ISO/IEC 25010:2023、Java 25、JUnit 6.1、ArchUnit 1.5、Mermaid 11 目錄 0. 文件資訊與使用方式 0.1 文件資訊 0.2 如何使用本手冊 0.3 指引條目的格式與編號 0.4 範例的驗證方式 1. 前言與學習目標 1.1 為什麼要學習 OOAD 1.2 學習目標 1.3 學習路徑與建議時數 1.4 前置知識與環境準備 1.5 本章自我檢核 2. 物件導向基礎概念 2.1 物件與類別 2.2 封裝 2.3 抽象 2.4 繼承與組合 2.5 多型 2.6 值物件、實體與相等性 2.7 介面與抽象類別 2.8 實務案例:學生管理模型 2.9 練習題 2.10 章節小結 3. 設計原則:SOLID、GRASP 與契約式設計 3.1 單一職責原則(SRP) 3.2 開放封閉原則(OCP) 3.3 里氏替換原則(LSP) 3.4 介面隔離原則(ISP) 3.5 依賴反轉原則(DIP) 3.6 GRASP:職責指派的九個模式 3.7 迪米特法則、KISS 與 YAGNI 3.8 契約式設計 3.9 以自動化測試守護設計原則 3.10 練習題 3.11 章節小結 4. OOAD 開發流程 4.1 流程概覽:迭代與增量 4.2 需求分析 4.3 領域分析與領域模型 4.4 Use Case 分析 4.5 強健性分析 4.6 架構設計 4.7 詳細設計:從系統事件到物件互動 4.8 實作:從設計到程式碼 4.9 測試與驗證 4.10 追溯性 4.11 練習題 4.12 章節小結 5. UML 2.5.1 建模實務 5.1 UML 簡介與標準現況 5.2 UML 2.5.1 的 14 種圖形 5.3 Use Case 圖 5.4 類別圖 5.5 物件圖 5.6 套件圖 5.7 循序圖 5.8 通訊圖 5.9 活動圖 5.10 狀態機圖 5.11 元件圖與部署圖 5.12 其他圖形 5.13 OCL 基礎 5.14 Mermaid、PlantUML 與 UML 標準記法的差異 5.15 UML 工具選型 5.16 建模最佳實務與圖形審查清單 5.17 練習題 5.18 章節小結 6. 專案實務:大學選課系統 6.1 專案背景與需求 6.2 Use Case 6.3 領域模型與詞彙表 6.4 架構設計 6.5 設計類別圖 6.6 關鍵循序圖 6.7 實作 6.8 測試 6.9 已知限制與演進方向 6.10 章節小結 7. 領域驅動設計(DDD)戰術模式與 OOAD 的銜接 7.1 通用語言與限界上下文 7.2 實體與值物件 7.3 聚合 7.4 領域服務與應用服務 7.5 儲存庫 7.6 工廠 7.7 領域事件 7.8 練習題 7.9 章節小結 8. 設計模式實務 8.1 GoF 模式分類 8.2 Strategy 模式 8.3 Observer 模式與事件通知 8.4 Factory Method 與靜態工廠方法 8.5 Template Method 與 Strategy 的選擇 8.6 Decorator 模式 8.7 Adapter 模式 8.8 State 模式 8.9 Singleton 的風險 8.10 審查模式的使用 8.11 練習題 8.12 章節小結 9. 常見錯誤與最佳實務 9.1 分析階段常見錯誤 9.2 設計階段常見錯誤 9.3 實作階段常見錯誤 9.4 程式碼可讀性 9.5 安全設計 9.6 效能考量 9.7 練習題 9.8 章節小結 10. AI 輔助 OOAD 的實務與審查 10.1 適用與不適用的情境 10.2 AI 輔助的 OOAD 流程 10.3 結構化提示 10.4 資料保護與合規 10.5 AI 產出的程式碼 10.6 練習題 10.7 章節小結 11. UML 認證(OCUP 2)準備 11.1 認證概述 11.2 Foundation 考試範圍 11.3 Intermediate 與 Advanced 考試範圍 11.4 重點知識整理 11.5 模擬題與解析 11.6 準備計畫 11.7 學習資源 11.8 章節小結 12. 能力評量與成長路徑 12.1 能力模型與評量量表 12.2 知識與技能自我檢核 12.3 實作評量 12.4 成長路徑 12.5 學習紀錄範本 12.6 章節小結 13. 專案交付與審查檢查清單 13.1 需求分析檢查清單 13.2 設計審查檢查清單 13.3 實作檢查清單 13.4 Code Review 檢查清單 13.5 專案交付檢查清單 13.6 章節小結 14. 延伸閱讀與參考資料 14.1 OOAD 與 UML 經典書籍 14.2 設計原則、模式與領域驅動設計 14.3 架構與軟體工程 14.4 國際標準與規格 14.5 線上資源與工具 14.6 本站相關教學與指引 14.7 結語 附錄 A 指引總表 附錄 B v2.1 至 v3.0 章節對照 附錄 C 修正紀錄 附錄 D 驗證紀錄 附錄 E 待確認事項 附錄 F 版本歷程 0. 文件資訊與使用方式 0.1 文件資訊 項目 內容 文件名稱 物件導向分析與設計 (OOAD) 教學手冊 版本 v3.0(全面改版,變更內容見附錄 B與附錄 C) 更新日期 2026-10-12 作者 系統架構師團隊 適用對象 新進開發同仁、資深工程師、技術主管、Code Reviewer 文件定位 企業內部技術白皮書等級的教學手冊:教會「怎麼做」,也教會「怎麼審查與驗證別人做得對不對」 本版技術基準(所有程式範例皆以此基準實際編譯與執行,結果見附錄 D): ...

October 31, 2025 · 115 min · 24461 words · Eric Cheng

程式寫作指引

程式寫作指引 企業標準技術白皮書|版本 v2.1|2026-10-06 適用範圍:Java / Spring Boot、TypeScript、HTML、CSS / Tailwind CSS、Vue、Angular、React、SQL 與 Stored Procedure(Oracle、SQL Server、PostgreSQL)之程式撰寫。 v2.1 為每條規則加上「驗證方式」與程式碼範例,並在每個規則小節提供「🔍 審查與驗證」,讓審查者能判斷 AI 或同事產出的程式碼是否符合規範;所有工具設定與宣稱都經過實測(見 附錄 D)。v2.1 的修正見 附錄 C.3,舊版(v1.x)各章去向見 附錄 C.2。 目錄 0. 文件資訊 0.1 文件目的與讀者 0.2 技術基準版本 0.3 規範等級定義 0.4 規範例外與豁免流程 0.5 與其他指引的關係 0.6 如何閱讀本指引 1. 前言與核心原則 1.1 為什麼需要程式寫作標準 1.2 七項核心原則 1.3 規範優先順序 2. 通用寫作原則 2.1 命名原則 2.2 函式與類別設計 2.3 SOLID 與常見設計守則 2.4 不可變性與副作用 2.5 魔術數字與設定外部化 2.6 檔案格式與 EditorConfig 2.7 程式碼異味速查 3. Java 寫作規範 3.1 原始檔結構與格式 3.2 命名規範 3.3 現代語言特性(Java 17–25) 3.4 var 使用界線 3.5 Null 處理與 JSpecify 3.6 集合、Stream 與 Lambda 3.7 金額、時間與字串 3.8 並行與 Virtual Threads 3.9 資源管理與例外 3.10 類別設計 3.11 實務注意事項 4. Spring Boot 程式碼慣例 4.1 Spring Boot 4 的重要變化 4.2 依賴注入 4.3 設定與 @ConfigurationProperties 4.4 Web 層:Controller、驗證與 ProblemDetail 4.5 HTTP 客戶端 4.6 API Versioning 4.7 交易管理 4.8 Spring Data JPA 寫法 4.9 實務注意事項 5. TypeScript 寫作規範 5.1 版本策略:TypeScript 6.0 與 7.0 5.2 tsconfig 標準設定 5.3 型別系統 5.4 Enum 與常數 5.5 命名規範 5.6 函式、非同步與錯誤處理 5.7 模組與匯入 5.8 新語言特性採用建議 5.9 實務注意事項 6. HTML 寫作規範 6.1 文件結構與格式 6.2 語意化標籤 6.3 表單 6.4 圖片與多媒體 6.5 無障礙(WCAG 2.2 AA)重點 6.6 安全相關屬性 7. CSS 與 Tailwind CSS 寫作規範 7.1 樣式方案選擇 7.2 CSS 撰寫規則 7.3 Tailwind CSS v4 設定(CSS-first) 7.4 Tailwind 使用規則 7.5 Tailwind v4 版本差異與遷移要點 8. Vue 3 寫作規範 8.1 基本原則與 API 選擇 8.2 命名與檔案(Style Guide A / B) 8.3 Props、Emits 與 v-model 8.4 樣板規則 8.5 響應式與 Composables 8.6 Pinia 狀態管理 8.7 樣式(Style Guide A / D) 8.8 Vue 實務注意事項 9. Angular 寫作規範 9.1 Angular 22 的重要變化 9.2 命名與專案結構 9.3 元件撰寫 9.4 樣板規則 9.5 Service、DI 與 HTTP 9.6 表單:Signal Forms 9.7 Angular 實務注意事項 10. React 寫作規範 10.1 Rules of React(必須遵守) 10.2 元件撰寫 10.3 Hooks 與 Effect 10.4 React Compiler 與記憶化 10.5 Server Components、Actions 與表單 10.6 狀態管理 10.7 React 19.x 新功能採用建議 10.8 React 實務注意事項 11. SQL 撰寫規範 11.1 格式規範 11.2 命名規範 11.3 參數化查詢與動態 SQL 11.4 查詢撰寫 11.5 分頁 11.6 NULL、型別與字元集 11.7 交易與鎖定 11.8 方言對照表 11.9 資料庫變更腳本(Migration) 12. Stored Procedure 撰寫規範 12.1 何時使用 Stored Procedure 12.2 命名與結構 12.3 錯誤處理與交易 12.4 安全與動態 SQL 12.5 效能 12.6 Oracle PL/SQL 標準範本 12.7 SQL Server T-SQL 標準範本 12.8 PostgreSQL PL/pgSQL 標準範本 12.9 SP 的測試與審查 13. 註解與文件 13.1 註解原則 13.2 JavaDoc 13.3 TSDoc / JSDoc 13.4 前端元件文件 13.5 API 文件(OpenAPI) 13.6 專案文件 14. 錯誤處理與日誌 14.1 例外設計(Java) 14.2 前端錯誤處理 14.3 日誌規範 14.4 可觀測性 15. 測試程式寫作 15.1 通用原則 15.2 Java 測試(JUnit 6) 15.3 前端測試(Vitest / Testing Library / Playwright) 16. 安全寫作要點 16.1 OWASP Top 10:2025 對照 16.2 秘密管理 16.3 注入攻擊防護 16.4 XSS 與輸出編碼 16.5 存取控制 16.6 認證與工作階段 16.7 加密 16.8 安全設定 16.9 軟體供應鏈 16.10 OWASP ASVS 5.0 對照 17. 效能寫作要點 17.1 後端(Java / Spring) 17.2 前端 17.3 資料庫 18. 版本控制與 Code Review 18.1 分支策略 18.2 Commit 規範(Conventional Commits) 18.3 Pull Request 規範 18.4 .gitignore 與儲存庫衛生 19. 工具鏈與自動化 19.1 工具總覽 19.2 Java 工具鏈 19.3 TypeScript / 前端工具鏈 19.4 SQL 工具鏈 19.5 Git Hooks 19.6 CI 品質門檻 20. AI 輔助開發寫作規範 20.1 基本立場 20.2 使用規範 20.3 專案指令檔 20.4 AI 產出的審查與風險 21. 檢查清單 21.1 通用(所有 PR) 21.2 Java / Spring Boot 21.3 前端(TypeScript / Vue / Angular / React) 21.4 HTML 與無障礙 21.5 SQL 與 Stored Procedure 附錄 A 規則速查表 A.1 依領域統計 A.2 規則索引 A.3 驗證方式與範例覆蓋統計 附錄 B 參考資源 B.1 官方風格指引與規範 B.2 安全 B.3 工具 B.4 同系列指引 附錄 C 版本紀錄 C.1 版本歷程 C.2 v1.x → v2.0 修正與去向對照 C.3 v2.0 → v2.1 修正 附錄 D 查證紀錄 D.1 查證範圍與方法 D.2 版本查證 D.3 範例實測結果 D.4 實測中發現並修正的問題 D.5 待確認項目 附錄 E 術語表 0. 文件資訊 0.1 文件目的與讀者 本指引是企業內部的程式撰寫標準(Coding Standard),用來回答「程式碼應該怎麼寫」。它不負責系統架構、部署流程或專案管理,那些主題由其他指引處理(見 0.5)。 ...

October 31, 2025 · 177 min · 37663 words · Eric Cheng

系統分析指引

專案系統分析指引 企業標準技術白皮書|版本 v3.0|2026-10-08 適用範圍:企業應用系統從「業務需求」到「系統分析文件(需求規格書 SRS 與系統分析文件 SAD)」的系統分析階段。內容涵蓋分析流程與國際標準、角色、需求擷取、需求撰寫品質、業務流程與業務規則、功能需求、資料與領域分析、行為建模、非功能需求、介面與整合需求、安全隱私與合規需求、使用者體驗與無障礙、國際化、需求驗證、優先級、追溯與變更管理、敏捷模式、AI 輔助分析,以及分析交付物與審查。 v3.0 全面改寫 v2.0:依 ISO/IEC/IEEE 29148:2018(並參考 2026 年進入 DIS 階段的新版草案)、IIBA BABOK Guide v3、IREB CPRE Foundation Level 3.x、ISO/IEC 25010:2023、ISO/IEC 25019:2023、OWASP ASVS 5.0、WCAG 2.2(ISO/IEC 40500:2025)與我國個資法、資安法等法規重新組織。每條規則都附有範例與「驗證方式」,每節結尾都有「🔍 審查與驗證」,讓審查者能判斷 AI 或同事產出的分析文件是否正確。範例均經工具實測(見 附錄 F)。訪談技巧請見 客戶需求訪談與分析技巧;分析完成後如何轉成設計,請見 系統設計指引。本文聚焦在「把需求分析到可以設計、可以測試、可以審查」。 目錄 0. 文件資訊 0.1 文件目的與讀者 0.2 參考標準與版本 0.3 規範等級與規則格式 0.4 與其他指引的關係 0.5 如何閱讀本指引 0.6 例外與豁免流程 1. 系統分析流程與國際標準 1.1 國際標準與分析流程 1.2 分析的進入與退出準則 1.3 分析產出物與資訊項目 1.4 分析計畫與裁適 1.5 系統範圍與脈絡 2. 角色與職責 2.1 分析團隊的角色 2.2 責任分派矩陣(RACI) 2.3 利害關係人識別與分析 3. 需求來源與需求擷取 3.1 需求來源與擷取技術的選擇 3.2 現行系統與資料分析 3.3 擷取紀錄與確認 4. 需求撰寫品質 4.1 良好需求的特性 4.2 需求句型:EARS 4.3 需求屬性與編號 4.4 模糊用語與常見缺陷 4.5 需求的驗證方法 5. 業務分析與流程建模 5.1 業務問題與目標 5.2 業務流程建模 5.3 業務規則與決策表 5.4 差距分析與轉換需求 6. 功能需求建模 6.1 使用案例 6.2 使用者故事與故事地圖 6.3 驗收條件與 Gherkin 6.4 系統功能清單 7. 資料與領域分析 7.1 詞彙表與通用語言 7.2 概念資料模型 7.3 資料字典與資料品質需求 7.4 事件風暴與領域事件 7.5 資料生命週期、保存與轉置範圍 8. 行為建模 8.1 活動圖與資料流程圖 8.2 狀態模型 8.3 系統循序圖 8.4 分析模型之間的一致性 9. 非功能需求 9.1 ISO/IEC 25010:2023 品質模型 9.2 品質情境 9.3 效能與容量需求 9.4 可用性、可靠性與營運持續需求 9.5 可維護性、彈性與營運需求 10. 介面與整合需求 10.1 介面清單 10.2 線上介面需求(API 與事件) 10.3 檔案與批次介面需求 10.4 介面協議與責任分工 11. 安全、隱私與合規需求 11.1 安全需求的來源與等級 11.2 濫用案例與威脅導出的需求 11.3 個人資料保護需求 11.4 法規與標準合規需求 11.5 稽核軌跡需求 12. 使用者體驗與無障礙需求 12.1 原型與畫面需求 12.2 無障礙需求 12.3 可用性需求與使用品質 12.4 訊息與使用者協助 13. 國際化與地區化需求 13.1 語系與文字 13.2 時區、日期、數字與幣別 13.3 字元、姓名與地址 14. 需求驗證與確認 14.1 驗證與確認的區別 14.2 需求審查 14.3 以原型、情境走查與測試案例確認需求 14.4 需求的核准與基準化 15. 優先級、範圍與估算 15.1 優先順序方法 15.2 範圍控管與版本規劃 15.3 估算的基礎 16. 需求追溯與變更管理 16.1 追溯矩陣 16.2 需求的版本控制 16.3 變更控制流程 16.4 需求健康度指標 17. 敏捷與混合模式下的系統分析 17.1 敏捷中的需求工程 17.2 產品待辦清單與就緒定義 17.3 混合模式:固定範圍合約與敏捷交付 18. AI 輔助系統分析與人工審查 18.1 AI 適合與不適合的分析工作 18.2 提示的輸入與脈絡 18.3 AI 產出的審查與查證 18.4 資料保護與 AI 治理 18.5 系統本身包含 AI 功能時的需求 19. 交付物與分析審查 19.1 交付清單 19.2 分析審查與結論 19.3 交接給設計與測試 19.4 上線後的效益確認 附錄 A 規則總表 A.1 依領域統計 A.2 驗證方式與範例覆蓋 A.3 規則清單 附錄 B 分析審查檢核清單 B.1 流程、範圍與角色 B.2 需求擷取與撰寫品質 B.3 業務、功能與資料 B.4 行為模型與一致性 B.5 非功能需求 B.6 介面、安全與合規 B.7 使用者體驗與國際化 B.8 驗證、優先級、追溯與交付 附錄 C 範本與檢查工具 C.1 SRS 範本 C.2 SAD 範本 C.3 使用案例規格範本 C.4 使用者故事與驗收條件範本 C.5 品質情境範本 C.6 介面需求範本 C.7 SRS 檢查工具 check_srs.py C.8 需求登錄與追溯檢查工具 check_trace.py C.9 需求變更申請單範本 附錄 D 名詞解釋 附錄 E 參考資料 E.1 國際標準 E.2 知識體系、規格與方法 E.3 我國法規與主管機關指引 E.4 本系列相關指引 附錄 F 修訂紀錄與查證紀錄 F.1 v2.0 與 v3.0 章節對照 F.2 v2.0 內容更正紀錄 F.3 查證紀錄 F.4 待確認事項 F.5 版本歷程 0. 文件資訊 0.1 文件目的與讀者 本指引定義系統分析階段的標準:從業務構想與利害關係人的需要出發,產出哪些分析成果、每項成果要做到什麼程度才算合格,以及審查者要如何驗證。它回答的是「系統必須做什麼、做到多好、受到哪些限制」,而不是「系統要怎麼做」。後者屬於架構與設計。 ...

October 31, 2025 · 98 min · 20823 words · Eric Cheng

系統分析階段標準文件目錄範例

System_Analysis_Phase/ ├── 01_SRS/ # 需求規格文件 │ ├── 01_前言.md │ ├── 02_整體描述.md │ ├── 03_功能性需求.md │ ├── 04_非功能性需求.md │ ├── 05_系統介面需求.md │ └── 附錄_名詞解釋_參考資料.md │ ├── 02_Use_Case/ # 使用案例文件 │ ├── 00_使用案例總覽圖.png │ ├── UC01_名稱_使用案例說明.md │ ├── UC02_名稱_使用案例說明.md │ ├── UCxx_…md │ ├── 使用案例活動圖/ # Activity Diagrams │ │ ├── UC01_活動圖.png │ │ └── UC02_活動圖.png │ └── 使用案例需求對應表.xlsx │ ├── 03_System_Model/ # 系統模型 (UML) │ ├── Object_Model/ # 物件模型 │ │ ├── 類別圖_ClassDiagram.png │ │ └── 物件圖_ObjectDiagram.png │ ├── Interaction_Model/ # 互動模型 │ │ ├── UC01_序列圖_Sequence.png │ │ ├── UC02_序列圖_Sequence.png │ │ └── 通訊圖_Communication.png │ ├── State_Model/ # 狀態模型 │ │ ├── ClassA_狀態圖.png │ │ └── ClassB_狀態圖.png │ └── Supplementary_Model/ # 補充模型 │ ├── 組件圖_Component.png │ └── 部署圖_Deployment.png │ ├── 04_Data_Model/ # 資料模型 │ ├── ER_Model.png │ ├── Class_Table_Mapping.xlsx │ └── Data_Dictionary.xlsx │ ├── 05_RTM/ # 需求追蹤矩陣 │ └── Requirement_Traceability_Matrix.xlsx │ ├── 06_Validation_Review/ # 驗證與審查 │ ├── 需求審查會議紀錄.md │ ├── 問題清單與解決狀態.xlsx │ └── 需求基線確認_Baseline_Approval.pdf │ └── README.md # 系統分析階段文件總覽

October 31, 2025 · 1 min · 158 words · Eric Cheng

系統分析階段標準範本清單

1️⃣ 需求規格文件 (SRS – Software Requirement Specification) 目錄建議: 前言 1.1 文件目的 1.2 系統範疇與邊界 1.3 定義、縮寫與名詞解釋 1.4 文件參考資料 整體描述 2.1 系統目標 2.2 系統使用者與利害關係人 2.3 作業環境 (硬體/軟體/網路/外部系統) 2.4 假設與限制 功能性需求 按使用案例或模組分項列出需求 非功能性需求 效能需求 (Response Time, Throughput) 安全性需求 (Authentication, Authorization, Audit) 可用性 / 擴充性需求 法規/合規性需求 系統介面需求 外部系統介接規格 API / 資料交換格式 2️⃣ 使用案例文件 (Use Case Specification) 目錄建議: 使用案例總覽 (Use Case Diagram) 使用案例清單 UC01:名稱、角色、前置條件、後置條件、主要流程、替代流程、例外情境 UC02 … 使用案例活動圖 (Activity Diagram) 用案例與需求對應表 (Traceability) 3️⃣ 系統模型文件 (UML Models) ...

October 31, 2025 · 1 min · 188 words · Eric Cheng

系統分析階段標準範本清單(OOA)

1️⃣ 需求規格文件 (SRS – Software Requirement Specification) 目錄: 01_SRS/ ├── 01_前言.md # 文件目的、系統範疇、名詞定義 ├── 02_整體描述.md # 系統目標、利害關係人、作業環境、限制 ├── 03_功能性需求.md # 按模組/使用案例列需求 ├── 04_非功能性需求.md # 效能、安全性、可用性、法規 ├── 05_系統介面需求.md # 外部系統介接、API、資料交換 └── 附錄_參考資料.md 2️⃣ 使用案例文件 (Use Case Specification) 目錄: 02_Use_Case/ ├── 00_使用案例總覽圖.png ├── UC01_名稱_說明.md # 前置條件、後置條件、主要/替代流程 ├── UC02_名稱_說明.md ├── UCxx_…md ├── 使用案例活動圖/ │ ├── UC01_活動圖.png │ └── UC02_活動圖.png └── 使用案例需求對應表.xlsx 3️⃣ 系統模型文件 (UML Models) 目錄: 03_System_Model/ ├── Object_Model/ # 物件模型 │ ├── 類別圖_ClassDiagram.png │ └── 物件圖_ObjectDiagram.png ├── Interaction_Model/ # 互動模型 │ ├── UC01_序列圖.png │ ├── UC02_序列圖.png │ └── 通訊圖_Communication.png ├── State_Model/ # 狀態模型 │ ├── ClassA_狀態圖.png │ └── ClassB_狀態圖.png └── Supplementary_Model/ # 補充模型 ├── 組件圖_Component.png └── 部署圖_Deployment.png ...

October 31, 2025 · 1 min · 185 words · Eric Cheng