Beginner
30 minutes
How to 讓文件保持最新 with Eigent
運用程式碼變更與 PR 上下文，撰寫聚焦的文件更新—— 不需大幅重寫，也不會留下過時引用。
What you need
- Eigent 桌面應用程式
- 程式碼庫存取權（本機或已連結的 repo）
- 文件 repo 或已連結的文件系統
Best for
- 追蹤快速變動程式碼庫的開發者文件、README、runbook 與遷移說明
- 需要在頻繁程式碼變更時同步維護文件的團隊
- 根據合併後的 PR 撰寫發布說明或變更記錄的工程師
Starter Prompt
根據以下來源更新 [產品/功能] 文件： - [此 repo / 連結的 repo] 中已變更的原始碼檔案 - 提及已變更行為的現有文件頁面 - 我在下方提供的任何連結 issue、PR、release note 或公開參考資料 接著： - 辨識哪些內容是面向使用者的 - 只更新需要變更的文件 - 不要把未公開的路線圖、客戶私密資訊與僅供內部使用的上下文放進公開文件 - 保留現有文件結構、術語與交叉連結 - 執行與此次變更相符的文件檢查 在完成前，請摘要說明變更內容、你驗證了什麼，以及哪些主張無法從可信來源證實。
運作方式
- 提供需要撰寫文件的已變更原始碼檔案、分支、pull request 或 commit。
- 請 Eigent 搜尋現有文件中受影響的功能名稱、設定鍵、命令與範例。
- 只更新需要變更的文件——保留頁面結構、術語、交叉連結與 frontmatter。
- 執行格式化與文件檢查，接著請 Eigent 摘要說明每個面向使用者的主張背後的證據。
- 在發布前檢閱摘要，確認沒有內部資訊或未公開內容洩漏到公開文件中。
更多可嘗試的提示
- 這個 PR 變更的行為，哪些現有文件頁面有提到？
- 這次變更是否影響任何需要更新的公開 API 參數、預設值或 CLI 旗標？
- 為這次版本撰寫一則符合我們現有格式的變更記錄。
- 找出更新後文件中任何無法僅從原始碼證實的面向使用者主張。
如何使用
從你需要撰寫文件的變更開始——提供分支、PR 或 commit。請 Eigent 在起草任何內容前先搜尋現有文件，這樣它會更新正確的頁面，而不是撰寫重複現有內容的新頁面。將範圍保持精準：一則明確的說明或範例更新，通常比整頁重寫更好。若要讓這流程可重複執行，可以將工作流程儲存為技能，或請 Eigent 在每次發佈後依排程執行。
預期輸出
只包含面向使用者變更的更新文件檔案、已變更與已驗證內容的摘要，以及無法從可信來源確認、需要人工審查的主張清單。
限制
- 除非你明確提供，否則 Eigent 無法存取私人客戶資料、未公開的路線圖項目或內部 wiki。
- 文件正確性取決於原始碼註解與測試覆蓋的品質——未記錄的行為可能會被遺漏。
- 對於非常大型的文件站，將搜尋範圍限定在特定章節或功能區域，通常比搜尋整個站更有效率。
