跳轉到

Cortex 文檔地圖

台股量化交易與投資分析平台 —— 文件入口。「我想找 X,該看哪份、對應哪段 code」一頁查清。

文件分四層:規格(系統現在長怎樣)、ADR(為什麼這樣做)、 Roadmap(接下來做什麼)、維運(怎麼跑/還原/部署)。

🧭 我想找…

我想找… 看這份 對應 code
系統架構 / 模組劃分 / 技術棧 ARCHITECTURE.md ⚠️ core/, investment-agent/
LLM 抽象 / Agent framework / VRR / RAG CORE_SPEC.md ⚠️ core/llm, core/agent_framework, core/knowledge
個股分析 Agent / 技術指標 / 訊號 INVESTMENT_AGENT_SPEC.md ⚠️ investment-agent/backend/agents
每日 pipeline / 排程 / 爬蟲 DATA_PIPELINE_SPEC.md ⚠️ backend/scripts/scheduler.py, backend/scripts
DB schema / 欄位 / migration DATABASE_SCHEMA.md ⚠️ backend/database/models.py, database/migrations
API endpoint / 請求回應格式 / 互動測試 API_SPEC.md · api-reference.md · swagger.md backend/api/
回測引擎 / 規格與背景 BACKTEST_SPEC.md ⚠️ · BACKTEST_CONTEXT.md ⚠️ backend/services/coverage_backtest
籌碼 Recap(週/月)/ 前端整合 recap-architecture.md ⚠️ · recap-frontend-integration.md backend/services (recap)
ETF 日期契約(前端) integration/etf-date-contract-frontend.md
Release notes / 近期能力摘要 README.md#changelog repository history
部署 / 環境變數 / Docker DEPLOYMENT.md ⚠️ docker-compose.yml, investment-agent/.env
DB 還原 / SIT 部署(操作手冊) runbooks/db-restore.md · runbooks/sit-deploy.md .github/workflows
開發指南 / 開發流程 / 實作順序 DEVELOPMENT_GUIDE.md ⚠️
為什麼這樣設計(逐功能決策) adr/README.md
接下來要做什麼(規劃 / 排序) ROADMAP.md

⚠️ = 最後更新 ≤ 2026-04,可能未跟上近期開發,內容待查證(見下表 + follow-up)。

📅 文件現況(最後更新日,git log 為準)

文件 最後更新 現況
../README.md 2026-07-02 近期(含 v0.18.0 release candidate / v0.17.0 changelog)
API_SPEC.md 2026-06-03 近期
recap-frontend-integration.md 2026-06-13 近期
runbooks/sit-deploy.md 2026-06-14 近期
runbooks/db-restore.md 2026-06-13 近期
integration/etf-date-contract-frontend.md 2026-06-04 近期
DATABASE_SCHEMA.md 2026-04-28 ⚠️ 待查證
BACKTEST_CONTEXT.md 2026-04-28 ⚠️ 待查證
ARCHITECTURE.md 2026-04-24 ⚠️ 待查證
INVESTMENT_AGENT_SPEC.md 2026-04-24 ⚠️ 待查證
DATA_PIPELINE_SPEC.md 2026-04-24 ⚠️ 待查證
DEVELOPMENT_GUIDE.md 2026-04-24 ⚠️ 待查證(含過時的「4 週計劃」)
recap-architecture.md 2026-04-22 ⚠️ 待查證
BACKTEST_SPEC.md 2026-02-26 ⚠️ 待查證
CORE_SPEC.md 2026-02-03 ⚠️ 待查證
DEPLOYMENT.md 2026-02-03 ⚠️ 待查證

「待查證」不等於斷言過時 —— 只表示距上次更新已久、需人工確認是否仍準確。 這 10 份文件的查證追蹤於 follow-up #433

🗂️ 未納入此地圖的文件

  • db-column-inventory.zh-TW.md —— 目前是未追蹤(untracked)檔,不在 dev 分支,故不收入 nav;是否納入版控見 follow-up #435
  • Trading_Signal_system_refactor_Plan.mdsignal_algo_optimization_plan.md —— 草創期的舊計畫殘留,非現行文件,暫不收入 nav;去留評估見 follow-up #434不在本次擅自刪除
  • 原草創期 README 的「設計決策」段(為何 Meta-Agent/LangGraph/Gemini)於本次重寫移除,遷移為 ADR 追蹤於 follow-up #436(原文可由 git history 取回)。

維護約定

  • 新增 / 改 API → 同步 API_SPEC.md + docs/api-reference.md(OpenAPI)。
  • 有架構 / 資料模型 / 取捨決策的 PR → merge 前在 adr/ 補一篇。
  • 動到某子系統的 PR → 要嘛更新對應 spec、要嘛在 PR 註明「無需更新」。