這一頁是所有說明文件的入口:先確認你要讀哪幾份(做功能的主線是共用的),再依職能找到該從哪一份開始。 · 技術版總索引(Markdown,在 repo 內閱讀):docs/README.md · 專案本身的說明:根目錄 README
ChipK 協作旅程 · 文件索引

先找對門,
再開始讀

做功能的主線只有一份,不分平台;其餘依你的角色與目標平台加讀。文件不少,但你通常只需要其中一兩份——這頁幫你在一分鐘內找到它。

設計師 PM RD 與 AI

先讀哪份:不是二選一

不管你的目標是 Web、iOS 還是 Android,做一個新功能都讀同一份主線——設計系統、token、Prototype、蓋章、7 份交接文件全部共用。只有階段 3 的實作 skill 依平台分流

目標是 App 的人,主線照讀不跳過,另外再加讀 native 那兩份(元件層的交接包與規格)。不是換一份讀,是多讀一份。

主線 · 所有人都要讀

product-feature.html

白話旅程版:6 個停靠站、三個確認點、角色備忘卡,另有兩個看倉庫的工具(Coverage Analyzer 與 Component Timeline)。給 PM、主管、第一次接觸的人。

技術版正本product-feature.md——4 個階段、6 支 skill、3 個閘門,含每階段的輸入/輸出/地雷。RD 與 AI 執行時看這份。web 與 native 共用:階段 3 的兩支實作 skill 差在哪,也寫在這裡。

目標是 App 才加讀

native-app.html

白話旅程版:從零件目錄到「寄包裹」給工程端的四站旅程,附一張表看完整趟與 native 小辭典。給設計師。

工程向展開native-design-contracts.html——包裹裡那份規格長什麼樣、既有原生元件怎麼接、要和工程師定下哪六件事。
契約正本design-system/HANDOFF_PROTOCOL.md(在 repo 內閱讀)。

階段 3 怎麼分流:web 用 /frontend-product-implementation,iOS/Android 用 /native-product-implementation——兩支讀同一包交接文件,差異寫在 product-feature.md 的〈階段 3〉。接真實資料是兩者共同的第三棒 /production-data-integration

依職能:我該先看什麼

每一份都可以獨立讀完。先讀粗體那份,其餘等用到再翻。

設計師

PM

RD 與 AI

聽到不懂的詞?所有人都適用的 名詞對照表

這個資料夾裡有什麼

docs/workflows/ 放的是協作管線:一份共用主線、兩份 native 專屬,加上這頁索引。

其他入口

不在這個資料夾,但你遲早會用到。

維護這些文件時的三條規矩。

正本只有一份。product-feature.mdproduct-feature.html 是同一條管線的兩個深度,事實變更以 .md 為正本,改完要同步 .html;Native 的契約正本是 design-system/HANDOFF_PROTOCOL.md

版面詞彙不要各自發明。這裡的 HTML 共用 workflow-docs.css 與同一套 class(.hero.stops.station.say.seal-note.gate-card.memo…),新增區塊先找現有的——這些頁面會被並排投影給同一群人看,長得不一樣會被當成不同專案。CSS 檔頂端有完整詞彙表。

刻意單一淺色主題。不跟隨系統深色,因為它們會被投影、列印、截圖給非工程夥伴看。