pali-me

同步文件 (Sync Documentation) 是一項工程自動化工具，旨在確保專案文件能隨程式碼庫演進保持準確且相關。透過利用 Git 差異 (diffs) 和提交記錄 (commit logs)，此代理能識別具體的修改內容，例如資料庫結構更新、測試套件調整或架構變更，並將其對應至 /docs 目錄中的適當文件。此流程能有效緩解在快節奏開發環境中常見的文件滯後問題，因為功能實作往往快於手動更新文件。此工具適用於希望在無需手動追蹤的情況下執行嚴格文件標準的軟體工程師、技術主管與文件維護者。

• 自動檢查分支專屬的 Git 差異，以檢測程式碼庫中的結構性與功能性變更。

• 將不同的程式碼區域（如 db/ 遷移、tests/ 設定或依賴項變更）映射至對應的 Markdown 文件。

• 透過分析最近的提交訊息來理解技術變更背後的邏輯，從而進行更具情境意識的更新。

• 透過驗證交叉引用並確保程式碼範例反映目前實作，來提升文件的一致性。

• 可透過 Makefile 指令或直接在 Claude Code 中呼叫，無縫整合至開發者工作流程中，以便快速進行文件維護。

• 此工具預設專案具有標準目錄結構，文件存放在專屬的 /docs 資料夾中。

• 輸入條件包括一個帶有待處理變更的活躍 Git 分支，以及準備好進行更新的文件檔案。

• 輸出內容包括自動化提交或建議，這些提交會以簡潔的解釋和更新後的程式碼範例來修改文件檔案。

• 使用者應審查更新內容，以確保術語對齊並確認版本編號或日期已正確遞增。

• 最適合使用 Jest、React Testing Library 等標準測試框架，以及如 Maestro 進行端對端 (E2E) 測試的專案。