內部專案文檔協作
應用文檔站是開發團隊的專案文檔網站,供人類與 AI 共同閱讀、討論及確認成果,不對外開放。框架的公開指南站可介紹這套方法論;各應用的需求、設計、進度與審閱內容則由該專案的內部文檔站提供。
文件與過程成果
由人類或 AI 產生、需要團隊閱讀的專案文件,都應有網站入口。涵蓋 Roadmap、Feature List、Epic、User Story、SBE、API 規格、資料/領域模型、設計決策、ADR、測試、維運、Sprint 進度、follow-ups,以及需求來源與會議紀錄。草稿與過程成果也適用,頁面應顯示目前狀態。
正式文件仍在其原定目錄維護,網站導航與 AI 索引指向同一份來源。人類本輪需要閱讀或確認的原始材料與附件,須能透過本站瀏覽或下載完整內容;只提供說明、來源路徑或無法開啟的受控定位不足以完成展示。原件留在原定來源,必要時提供固定展示副本。網站入口不改變文件的版本生命週期、保存期限或原本的確認條件。
團隊內部使用及所需素材可供團隊存取是既定工作前提,不另設讀者範圍或存取控制核對關卡,也不要求另建受控網站。部署方式、環境及交付範圍由人類決定;AI 先完成本站瀏覽入口與本輪內容核對。
AI 請人確認文件
- 先備妥本輪完整文件及必要附件,保留草稿、未決事項與上下文。
- 在正確的 docs 模組更新展示,核對實際頁面及附件是本輪內容。靜態服務須重建;HTTP 200 或首頁 fallback 不能證明文件已更新。
- 提供可用的本機或團隊內部 URL、來源檔案路徑、本輪版本及待確認命題,再請人確認。
- 取得明示確認後,依原流程將結論寫回文件或決策/驗收紀錄。修改內容後重新展示,依原流程確認新版。
一般需求澄清仍可在對話進行。已授權的進度或待辦更新執行後提供網站連結,不另增加審批;唯讀查詢仍唯讀。僅在對話呈現的分析不被強制存成文件;選擇匯出後才依該流程提供網站入口。UAT 的應用操作、Claude Design 與 Storybook 的互動繼續使用原工具,相關文件與確認紀錄由文檔站瀏覽。
審閱與交付
AI 與人類交換的文件放在 docs 模組,由網站直接呈現,不再另做展示副本(交換文件規格):
| 交換 | 給人讀的文件 | 證據與附件 | 網站 |
|---|---|---|---|
| Peer review 簡報 | docs/exchanges/reviews/{id}/brief.md | static/exchanges/reviews/{id}/evidence/ | 只在審閱預覽(start:docs-only)出現 |
Sprint 交付紀錄(/work) | docs/exchanges/work/{id}/ | static/exchanges/work/{id}/evidence/ | 隨標準站台呈現 |
交換頁在「審閱與交付」分類下,頁尾自動列出附件(檔案、大小、雜湊與發布版本)。簡報以 pathname:/// 連結證據,證據目錄只放被引用的檔案。
審閱簡報與證據不提交(gitignored),只在共享工作樹與審閱預覽中;交付紀錄則隨 git 追蹤。審閱期間每次更新後以 docs.py publish 計算 revision、核對審閱預覽已編譯該版本,再提供頁面連結。審閱者的確認寫明 revision;之後實質內容、成果、證據或呈現改變就是新版本,需要重新確認。通過且結論已寫入 ADR、rules、正式文檔或 follow-up 後,docs.py close 刪除交換目錄;持久的是寫入 ADR、rules、正式文檔或 follow-up 的結論。
標準建置在編譯前排除審閱交換,建置結束後再刪除 preview-only 輸出並掃描洩漏;部署前不需另外移出審閱內容。P1 前已開始的審閱仍在 .claude/peer-review/,沿舊做法到結案。
網站可瀏覽與 peer review 通過是兩個不同狀態;作者不能因建置成功或完成展示就替審閱者填入通過結論。
例:報表製作
| 階段 | 網站提供的內容 | 確認與保存 |
|---|---|---|
| 理解原樣張 | 原樣張、忠實還原、差異與理解對照 | 記錄還原理解;受控原件依既有保存位置維護 |
| 設計樣板 | 本輪 HTML+CSS 樣板、各資料情境與必要資產 | 記錄人類採用的樣板版本 |
| 實作驗收 | 本輪 PDF、對照結果及驗證證據入口 | 獨立記錄 PDF 接受,不沿用樣板確認 |
詳見報表規格指南。原始樣張、完整還原對照、採用版面及全部 PDF 案例直接由同一內部專案文檔站提供。原件保存、展示副本及版控各依原契約管理;部署核對與版面確認分開,無須先核對部署讀者或建立另一個 Docusaurus instance。
服務與網址
本機預覽的綁定位址沿用該專案 docs 模組的預設啟動設定。沿用可服務本輪內容的站台,啟動新服務前檢查埠,不停止其他專案的服務。文檔變更優先採 docs-only 建置,避免不必要的 Javadoc/API 同步。
啟動後檢查實際 listener 位址,CLI 顯示的 URL 不等於綁定位址,再核對頁面內容。
URL 依實際 origin、baseUrl、docs instance 與 Docusaurus permalink 解析,包含 slug、README/index 與數字前綴處理。配置中的域名可作一般引用,但未驗證的網址不可當成人類確認入口。
AI 執行契約的單一來源為 workspace .claude/rules/m-skill-execution.md「專案文檔的人類瀏覽與確認入口」;網址解析見 m-doc-url.md,人審角色、結論與解鎖條件見 m-peer-review.md。本指南提供團隊閱讀說明,不新增另一套確認狀態或證據 schema。