Time Compass 文檔首頁¶
時程調度規劃系統:整合 Google Calendar、Google Tasks、Moodle,通過 AI 助理與網頁前端協助你規劃行程。
🚀 快速開始¶
我是新開發者,想快速上手¶
- 系統架構快速導覽 - 30 秒了解系統的各個主要部分
- 進 reference/ - 選一個感興趣的主題深入(DDD、OAuth、MCP 工具等)
- 需要操作指南?進 tutorial/ - Google OAuth 設定、驗證、測試等
我要實作某個功能¶
進 reference/README.md → 按主題選擇(DDD-ARCHITECTURE、ERROR-HANDLING、MCP-TOOLS、FRONTEND)
我要了解系統架構¶
- 系統架構快速導覽 - C1-C2 全景圖、容器設計
- 資料流圖 - 完整的資料轉換流水線
- Dev Mode 現況指南 -
MCP_DEV_MODE的實際切換點與測試影響 - Architecture Decision Records - 為什麼做了這些設計決策?
我想了解核心概念¶
進 explanation/ - Agent 能力、架構隱喻、開發歷程
📚 文檔組織¶
Level 1: 新手通道¶
| 位置 | 用途 | 讀者 |
|---|---|---|
| architecture/OVERVIEW.md | 系統快速導覽(C1-C2 全景) | 新開發者 |
| explanation/ | 概念、架構隱喻、開發故事 | 想理解背景的人 |
| tutorial/ | 操作步驟(Google OAuth 設定、驗證) | 需要具體步驟的人 |
| how-to/ | 工作指南(測試、環境設置) | 開發與維運的人 |
Level 2: 主題式技術深度(主軸)¶
| 主題 | 內容 | 適合誰 |
|---|---|---|
| DDD-ARCHITECTURE | 四層轉換模型(Raw → Internal → Read → TOON) | 要改資料模型的開發者 |
| ERROR-HANDLING | Railway-Oriented Programming 與 Result Monad | 要改錯誤處理的開發者 |
| MCP-TOOLS | 15 個工具實作手冊 | 要新增 MCP 工具的開發者 |
| FRONTEND | 零框架設計、FullCalendar、時間軸縮放 | 要改前端的開發者 |
進入 reference/README.md 看完整主題清單。
Level 3: 決策與設計紀錄¶
| 位置 | 用途 |
|---|---|
| adr/ | 架構決策紀錄(為什麼選 MCP?為什麼是四層?) |
| architecture/ | 系統全景圖、資料流、開發模式架構 |
| poster/ | 團隊願景、策略敘述 |
💡 常見問題¶
Q: 我不知道從哪開始
A: 進 系統架構快速導覽,然後選一個感興趣的主題進 reference/。
Q: 我找不到某功能的文檔
A: 進 reference/README.md 選擇相關主題,文檔都聚焦在主題目錄內。
Q: 我想知道為什麼要這樣設計
A: 進 adr/ 看決策記錄,從 ADR-0001 開始讀。
📖 推薦閱讀路徑¶
路徑 A: 架構理解者¶
系統架構快速導覽 → architecture/data-flow.md → ADR 決策紀錄
路徑 B: 實作開發者¶
architecture/OVERVIEW.md → 選主題進 reference/ → 進代碼深入
路徑 C: 新手完整吸收¶
architecture/OVERVIEW.md → explanation/ → reference/ → adr/
版本與文檔維護¶
文檔架構決策: ADR-0010 文檔類資源統一架構
最後更新:2026-03-02