Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 3.27 KB

File metadata and controls

26 lines (21 loc) · 3.27 KB

FMP 文件地圖

根目錄 README 是產品入口;AI coding agent 的規則在 AGENTS.md,人類貢獻者適用同一套。

類型依 Diátaxis:操作指南(照步驟做一件事)、參考(查事實)、說明(理解為什麼)。

文件 類型 什麼時候讀 什麼變了要更新它
README 說明 想下載或快速了解 FMP 使用者可見功能、截圖、下載入口、專案定位
建置指南 操作指南 在本機編譯 Android / Windows 本機建置環境、工具鏈、打包前置條件
開發文件 說明 理解架構與主要模組;用 VM Service 查正在跑的 app 架構分層、Runtime 調試流程
建置與發布指南 操作指南、參考 發新版本、調整 CI 或 Release 流程 CI、產物命名、Release workflow、簽名 secrets、應用內更新資產
疑難排解 參考 看到像錯誤的建置或 runtime log,或遇到修不掉只能繞過的行為 新查明的噪音或已知行為
.trellis/spec/legacy/ 參考 用 Trellis 跑舊專案任務,或想知道舊專案某一層的程式碼照什麼模式寫(英文) 某層的寫法慣例變了;有閘門的規則改在 lib/AGENTS.md,spec 只連過去
.trellis/spec/app/ 參考 用 Trellis 跑 app/ 任務,或想知道新專案某一層照什麼模式寫(繁中) 某層的寫法慣例變了;有閘門的規則改在 app/AGENTS.md,spec 只連過去
adr/ 說明 想知道某個跨模組決定「當初為什麼這樣選」 新的跨模組決策(決定、理由、被否決的方案)
verify-legacy-on-device skill 操作指南 舊專案緊急修正改了使用者可見行為,要做強制的實機驗證 模擬器啟動方式、驗證流程、裝置端限制
audit/ 快照(凍結) 對照重寫前的現況、功能勾選與效能基準 只允許核查更正;切換 PR 刪除(ADR 0008、0026)

分工

  • 單一段程式碼的理由寫在它旁邊(dartdoc 或守著它的測試);只有程式碼查不到的跨檔契約與地雷才進 AGENTS.md。
  • 同一條規則只寫在一個地方,除非另一份文件確實有自己的讀者。
  • 語言:新文件一律繁體中文;根目錄 AGENTS.md 是地圖,英文;lib/AGENTS.md 與 .trellis/spec/legacy/ 描述舊專案,維持英文到切換 PR;app/ 的 spec 從 M1 起繁中;README 維持英/繁雙語。程式碼識別字、指令、檔名、log 字串、commit message 保留原文。
  • .claude/skills/ 放可被 Claude Code 直接叫用的專案 skill。.gitignore 另外追蹤 Trellis 的接線(.claude/ 下的 agents/、commands/、hooks/、settings.json);.claude/ 其餘內容、.trellis/workspace/(session 日誌)、.agents/ 與 .codex/ 是本機狀態。
  • 審查記錄不進 docs/。一輪審計的結論寫進它所描述的檔案、開成 issue,或留在 git 歷史。例外:docs/audit/ 在重寫期間凍結保留,切換 PR 刪除。