📚 知識庫系統 UML 圖表索引
此頁面提供了 專案知識庫系統的各種 UML 圖表的索引和快速導航,適合在任何AI 對話視窗。
🎯 UML 圖表總覽
知識庫系統包含多種 UML 圖表,幫助 AI Agent 和開發者理解系統架構和運作機制。
📊 可用圖表清單
-
知識庫系統架構圖 (完整版)
🔒 永久記憶
包含系統總覽、決策流程、任務生命週期、保護機制、AI協作、品質保證等完整架構圖
建立日期: 2025-10-21 | 維護者: Claude Code (Sonnet 4.5)
-
知識庫系統可視化 (舊版)
包含任務清單結構優化和修復機制的視覺化表示
最後更新: 2025-10-20
🔍 快速導航
| 圖表類型 |
說明 |
連結 |
| 系統架構總覽 |
完整分層架構,包含使用者層、腳本工具層、知識儲存層 |
查看 |
| 決策記錄流程 |
從識別問題到完成決策記錄的完整流程 |
查看 |
| 任務狀態生命週期 |
任務從建立到完成的狀態轉換圖 |
查看 |
| 永久記憶保護機制 |
永久記憶檔案的自動保護流程 |
查看 |
| AI協作流程 |
不同AI工具之間的知識交接和協作 |
查看 |
| 品質保證流程 |
AI工具完成任務後的品質檢查流程 |
查看 |
📦 舊版圖表 (2025-10-20)
以下為舊版知識庫系統可視化內容,已被新版架構圖取代,但保留供參考。
知識庫系統整體架構
這是一個高層次的架構圖,展示了知識庫系統的主要組成部分及其互動關係。已更新以反映任務清單結構優化和修復機制。
graph TD
subgraph AI Tools & Users
A[人類開發者] -->|貢獻/查詢| KB
B[Claude Code] -->|協作/管理| KB
C[Cursor] -->|協作/設計| KB
D[其他AI工具] -->|貢獻/檢索| KB
end
subgraph Knowledge Base System
KB(知識庫核心)
KB -->|管理| S[自動化腳本]
KB -->|儲存/檢索| DCD[決策記錄]
KB -->|儲存/檢索| PCT[專案背景]
KB -->|儲存/檢索| TSM[任務狀態]
KB -->|儲存/檢索| AIC[AI協作記錄]
KB -->|索引| KNI[知識索引]
KB -->|使用| TMP[模板]
KB -->|規範| GOV[治理規範]
%% 新增修復任務相關組件
KB -->|執行| FR[修復任務]
FR -->|測試修復| TC[測試覆蓋修復]
FR -->|相容性修復| CP[跨平台相容性修復]
FR -->|指標調整| QI[品質指標調整]
FR -->|驗證完善| VV[驗證機制完善]
FR -->|審查強化| CR[代碼審查強化]
end
subgraph Data Storage
DCD[決策記錄] --> F1(Markdown檔案)
PCT[專案背景] --> F2(Markdown檔案)
TSM[任務狀態] --> F3(Markdown檔案/JSON)
AIC[AI協作記錄] --> F4(Markdown檔案)
KNI[知識索引] --> F5(JSON/文本檔案)
%% 新增修復任務檔案儲存
TC --> F6[測試覆蓋報告]
CP --> F7[相容性測試報告]
QI --> F8[品質指標記錄]
VV --> F9[驗證機制文件]
CR --> F10[審查機制記錄]
end
%% 修復任務執行流程
S -->|執行| FR
FR -->|執行| TC
FR -->|執行| CP
FR -->|執行| QI
FR -->|執行| VV
FR -->|執行| CR
%% 修復任務與現有組件的互動
TC -->|更新| TSM
CP -->|改善| S
QI -->|調整| TSM
VV -->|完善| TMP
CR -->|強化| GOV
說明:
- AI Tools & Users:包括人類開發者和各種AI工具(如Claude Code, Cursor),它們是知識庫的主要使用者和貢獻者。
- Knowledge Base System:知識庫的核心,負責管理和協調知識的儲存、檢索和維護。
- 自動化腳本 (S):執行各種操作,如建立決策、搜尋、更新任務狀態等。
- 決策記錄 (DCD):儲存專案的決策文件。
- 專案背景 (PCT):儲存專案的背景和脈絡資訊。
- 任務狀態 (TSM):追蹤專案任務的狀態。
- AI協作記錄 (AIC):記錄AI工具之間的協作過程。
- 知識索引 (KNI):提供快速搜尋和檢索知識的機制。
- 模板 (TMP):提供標準化的文件格式。
- 治理規範 (GOV):定義知識庫的使用和維護規則。
- 修復任務 (FR):執行系統優化和修復任務。
- 測試覆蓋修復 (TC):彌補測試覆蓋不足,建立自動化測試機制。
- 跨平台相容性修復 (CP):解決跨平台執行問題,確保環境適配。
- 品質指標調整 (QI):調整過於樂觀的指標,設定可達成目標。
- 驗證機制完善 (VV):建立具體的驗證方法和檢查步驟。
- 代碼審查強化 (CR):建立系統化的代碼品質檢查機制。
- Data Storage:知識庫的實際儲存介質,主要為Markdown檔案,部分可能為JSON或文本檔案。新增加了修復任務相關的報告和記錄檔案。
知識庫互動流程圖
這個流程圖展示了使用者或AI工具如何與知識庫進行互動,包括記錄決策、查詢資訊和執行修復任務。
graph TD
A[開始] --> B{使用者/AI工具需要知識庫服務?};
B -- 是 --> C{操作類型?};
C -- 記錄決策 --> D[呼叫 create-decision.sh 腳本];
D --> E[腳本建立新的決策 Markdown 檔案];
E --> F[決策檔案儲存於 decisions/ 目錄];
F --> G[更新知識索引 (若有)];
G --> H[完成記錄];
C -- 查詢知識 --> I[呼叫 search-knowledge.sh 腳本];
I --> J[腳本根據關鍵字搜尋知識庫檔案];
J --> K[返回搜尋結果];
K --> L[完成查詢];
C -- 更新任務狀態 --> M[呼叫 update-task-status.sh 腳本];
M --> N[腳本更新 task-management/ 中的任務狀態];
N --> O[完成更新];
C -- 執行修復任務 --> Q{修復任務類型?};
Q -- 測試覆蓋修復 --> R[執行 KB-FIX-001: 修復測試覆蓋不足問題];
R --> S[分析現有測試覆蓋率,建立自動化測試案例];
S --> T[測試覆蓋率提升至80%以上];
Q -- 跨平台修復 --> U[執行 KB-FIX-002: 解決跨平台相容性風險];
U --> V[建立相容性檢查腳本,修正Windows環境問題];
V --> W[所有腳本在三種平台正常執行];
Q -- 品質指標調整 --> X[執行 KB-FIX-003: 調整品質指標基準];
X --> Y[分析指標可達成性,設定現實目標];
Y --> Z[品質指標調整完成,建立監測機制];
Q -- 驗證機制完善 --> AA[執行 KB-FIX-004: 完善驗證機制];
AA --> AB[為驗收標準建立具體驗證方法];
AB --> AC[驗證機制完善,建立檢查清單];
Q -- 代碼審查強化 --> AD[執行 KB-FIX-005: 強化代碼審查機制];
AD --> AE[建立系統化審查機制和同行審查流程];
AE --> AF[代碼審查機制強化完成];
H --> P[結束];
L --> P;
O --> P;
T --> P;
W --> P;
Z --> P;
AC --> P;
AF --> P;
B -- 否 --> P;
說明:
- 流程從使用者/AI工具的需求開始。
- 根據操作類型(記錄決策、查詢知識、更新任務狀態、執行修復任務),呼叫相應的自動化腳本。
- 腳本執行具體操作,如建立檔案、搜尋內容、更新狀態或執行修復任務。
- 修復任務包含五種類型:
- 測試覆蓋修復:分析測試覆蓋率,建立自動化測試機制
- 跨平台相容性修復:解決多平台執行問題,建立相容性檢查機制
- 品質指標調整:設定可達成的品質目標,建立監測機制
- 驗證機制完善:建立具體驗證方法和檢查清單
- 代碼審查強化:建立系統化的審查機制和同行審查流程
- 所有操作完成後,流程結束。
知識庫核心組件UML類別圖
由於知識庫主要由Markdown檔案和Shell腳本組成,傳統的UML類別圖可能不完全適用於描述其「程式碼類別」結構。然而,我們可以將其抽象為「概念類別」,以展示其主要組成部分和它們之間的關係。
classDiagram
class KnowledgeBase {
+ name: String
+ description: String
+ decisions: List~Decision~
+ contexts: List~ProjectContext~
+ tasks: List~Task~
+ collaborations: List~AICollaboration~
+ index: KnowledgeIndex
+ templates: List~Template~
+ scripts: List~Script~
+ governance: Governance
+ addDecision(d: Decision): void
+ search(keyword: String): List~String~
+ updateTaskStatus(taskId: String, status: String): void
}
class Decision {
+ title: String
+ date: Date
+ participants: List~String~
+ relatedTasks: List~String~
+ tags: List~String~
+ problemStatement: String
+ optionsConsidered: List~String~
+ finalDecision: String
+ reason: String
+ implementationGuidance: String
+ followUp: String
+ filePath: String
}
class ProjectContext {
+ title: String
+ content: String
+ filePath: String
}
class Task {
+ taskId: String
+ description: String
+ status: String
+ filePath: String
}
class AICollaboration {
+ title: String
+ content: String
+ filePath: String
}
class KnowledgeIndex {
+ keywordToFileMap: Map~String, List~String~~
+ updateIndex(): void
+ getFilesForKeyword(keyword: String): List~String~
}
class Template {
+ name: String
+ content: String
+ filePath: String
}
class Script {
+ name: String
+ description: String
+ command: String
+ execute(): void
}
class Governance {
+ rules: String
+ filePath: String
}
class FixTask {
+ taskId: String
+ type: FixType
+ description: String
+ status: String
+ priority: String
+ assignee: String
+ estimatedHours: int
+ dependencies: List~String~
+ acceptanceCriteria: List~String~
+ filePath: String
+ execute(): void
+ validate(): boolean
}
class TestCoverageFix {
+ analysisReport: String
+ coverageTarget: double
+ automatedTestCases: List~String~
+ testDataRepository: String
+ mockEnvironment: String
+ integrationWorkflow: String
}
class CrossPlatformFix {
+ compatibilityScript: String
+ windowsPathFix: String
+ encodingEnhancement: String
+ multiPlatformTest: String
+ errorHandling: String
}
class QualityIndicatorFix {
+ currentMetrics: Map~String, double~
+ achievableTargets: Map~String, double~
+ adjustmentStrategy: String
+ monitoringMechanism: String
+ continuousTracking: boolean
}
class ValidationFix {
+ verificationMethods: Map~String, String~
+ checklist: List~String~
+ automationScripts: List~String~
+ resultRecording: String
+ reportGeneration: String
}
class CodeReviewFix {
+ reviewChecklist: List~String~
+ peerReviewProcess: String
+ securityReview: String
+ qualityMonitoring: String
+ enterpriseStandards: boolean
}
KnowledgeBase "1" *-- "*" Decision : contains
KnowledgeBase "1" *-- "*" ProjectContext : contains
KnowledgeBase "1" *-- "*" Task : manages
KnowledgeBase "1" *-- "*" AICollaboration : contains
KnowledgeBase "1" *-- "1" KnowledgeIndex : uses
KnowledgeBase "1" *-- "*" Template : uses
KnowledgeBase "1" *-- "*" Script : executes
KnowledgeBase "1" *-- "1" Governance : adheres to
KnowledgeBase "1" *-- "*" FixTask : executes
Script "1" --> "*" Decision : operates on
Script "1" --> "*" Task : operates on
Script "1" --> "1" KnowledgeIndex : updates
%% 修復任務類別關係
FixTask <|-- TestCoverageFix : extends
FixTask <|-- CrossPlatformFix : extends
FixTask <|-- QualityIndicatorFix : extends
FixTask <|-- ValidationFix : extends
FixTask <|-- CodeReviewFix : extends
TestCoverageFix "1" --> "1" Task : updates
CrossPlatformFix "1" --> "1" Script : improves
QualityIndicatorFix "1" --> "1" Task : adjusts
ValidationFix "1" --> "1" Template : enhances
CodeReviewFix "1" --> "1" Governance : strengthens
說明:
- KnowledgeBase:代表整個知識庫系統,包含各種知識類型和管理功能。
- Decision:代表一個決策記錄,包含標題、日期、參與者、問題陳述、最終決定等屬性。
- ProjectContext:代表專案背景資訊。
- Task:代表一個任務,包含ID、描述和狀態。
- AICollaboration:代表AI協作記錄。
- KnowledgeIndex:知識索引,用於快速查找相關檔案。
- Template:各種文件模板。
- Script:自動化腳本,執行知識庫的各種操作。
- Governance:知識庫的治理規範。
- 修復任務相關類別:
- FixTask:修復任務的抽象基類,定義修復任務的基本屬性和操作。
- TestCoverageFix:測試覆蓋修復任務,負責建立自動化測試機制。
- CrossPlatformFix:跨平台相容性修復任務,解決多平台執行問題。
- QualityIndicatorFix:品質指標調整任務,設定可達成的品質目標。
- ValidationFix:驗證機制完善任務,建立具體的驗證方法。
- CodeReviewFix:代碼審查強化任務,建立系統化的審查機制。