00 總覽
00 閱讀地圖
把專案、問題類型、主文件與 repo README 收斂成同一張讀者地圖。
這份是 docs 專案的真正入口。它不替代各 repo README,也不替任何主文件補細節;它只幫你在 30 秒內決定下一份要讀哪裡。
敏感資料交付提醒:05 或 05-environment-variables 指本地私有交付檔 private/handoff-sensitive/environment-variables_環境變數與金鑰對照表.md。該檔含 env value / secret 線索,只做本地交付,不放進公開文件樹。
先選你的情境
| 你現在的狀態 | 閱讀順序 |
|---|---|
| 第一次接手,不知道範圍 | 這份 -> 服務總覽 -> 專案清單 -> 目標 repo README |
| 已經知道專案名 | 專案清單 -> 目標 repo README -> 下方 問題類型索引 |
| 交接要驗收 | 交接清單 -> 卡住的欄位對應主文件 |
| 網站或功能正在出事 | 事故分流 -> 目標 repo README -> 對應主文件 |
| 只想找 env / key / secret 線索 | 本地私有交付檔 private/handoff-sensitive/environment-variables_環境變數與金鑰對照表.md |
專案入口地圖
| 專案 | 第一站 | 常接著看的文件 | 注意事項 |
|---|---|---|---|
mahjong-system | repo README | 05、整合與 API、帳號權限、部署 | 不是品牌站;要分清會員、後台、桌台、LINE、JKOPay、外部 API |
zerozero | repo README | 05、整合與 API、帳號權限、部署 | 電商、會員、OAuth、CRM、金流與物流會互相牽動 |
matter | repo README | 05、部署、CMS 維運 | Next.js + Headless WordPress,共通更新策略看 04 |
tintron | repo README | 05、CMS 維運、整合與 API、部署 | 表單與 CMS 問題要分開判斷 |
gonna | repo README | 05、整合與 API、部署 | AI / LINE 導流相關 owner 與 billing 要特別確認 |
presotea | repo README | 05、整合與 API、部署 | 門市 API、CMS、表單與 rollback 邊界要分開查 |
xinyisheng | repo README | 05、CMS 維運 | 正式站與 CMS 權限還是交接重點 |
niceginger | repo README | 05、CMS 維運、部署 | 部落格、首頁內容與 deploy target 要分開驗證 |
hanpoo-ecommerce | repo README | 部署、05、帳號權限 | React + Vite,不要套用 Next.js + Headless WordPress 的假設 |
Chlitina-Refining | repo README | 靜態輸出指南、05、整合與 API | basePath、distDir、表單開關與公開 URL 互相影響 |
KindShare-Exocare | repo README | 靜態輸出指南、05 | assetPrefix 與 build 後路徑補寫是正式 build 鏈的一部分 |
matterkits | monorepo README | app README、部署 | root、Storybook、app1、app2 要分層看 |
matterkits/app1 | app README | 05、CMS 維運、部署 | 這個 app 才有 WordPress / WPGraphQL / 表單脈絡 |
matterkits/app2 | app README | 交接清單 | 目前先當骨架或低頻維護,不要預設有完整維運流程 |
問題類型索引
| 你要找的答案 | 單一入口 | 不要在哪裡找 |
|---|---|---|
| 專案怎麼跑、怎麼 build、程式資料流 | 各 repo README | 不要在 handoff 裡重拼技術細節 |
| 交接完成度、待補項、sign-off | 交接清單 | 不要在各主文件裡追狀態 |
| 專案名、repo 路徑、README 位置、技術輪廓 | 專案清單 | 不要從 03、08、15 倒著找 |
| 帳號、平台入口、2FA、billing、reset 能力 | 帳號權限 | 不要放在 repo README 或事故紀錄 |
| deploy、rollback、hosting、logs、owner 缺口 | 部署手冊 | 不要和 repo 實際指令混在一起 |
| env key、value、缺值症狀、secret 線索 | 本地私有交付檔 private/handoff-sensitive/environment-variables_環境變數與金鑰對照表.md | 不要寫進公開 docs |
| CMS 後台、內容發布、內容異常分流 | CMS 維運 | 不要在 deployment 或 integration 文件重貼 |
| 第三方整合、callback、whitelist、vendor、billing 影響 | 整合與 API | 不要在 env 文件裡展開管理責任 |
| 字型、scroll、animation、前端顯示差異 | 前端畫面與架構 | 不要先當成 deploy 或 CMS 事故 |
| 素材、備份來源、能不能還原 | 素材與備份 | 不要把 repo assets 當成完整備份 |
| 事故第一步要怎麼分流 | 事故分流 | 不要從所有文件逐份翻 |
| README 是否夠接手 | README 評估標準 | 不要把 handoff 當成 README 補丁 |
文件分工原則
| 文件類型 | 負責回答 | 不負責回答 |
|---|---|---|
repo README | 單一 repo 的啟動、build、deploy 指令、實作資料流、專案內排查 | 跨專案交接狀態、平台 owner、secret value |
| docs 主文件 | 跨專案治理、責任邊界、下一步該看哪裡 | 單一 repo 的完整技術細節 |
| 本地私有交付檔 | secret 線索、env value、缺值症狀 | 公開閱讀、雲端交付、一般導覽 |
如果 handoff 與 repo README 衝突:
| 衝突類型 | 以哪裡為準 |
|---|---|
| 實作、指令、程式行為、資料流 | repo README 與 code |
| 權限、owner、交接狀態、平台入口 | docs 主文件 |
| env value、secret、缺值症狀 | 本地私有交付檔 |