Beginner
30 minutes
How to 保持文件與最新狀態同步 with Eigent
利用程式碼變更同 PR 背景起草聚焦的文件更新—— 無需大幅改寫或保留過時參考。
What you need
- Eigent 桌面應用程式
- 程式碼庫存取（本地或已連結的 repo）
- 文件庫或已連結的文件系統
Best for
- 追蹤快速變動程式碼庫的開發者文件、README、runbook 同遷移說明
- 需要配合頻繁程式碼變更一齊維護文件的團隊
- 根據已合併 PR 撰寫發佈說明或變更紀錄的工程師
Starter Prompt
根據以下來源更新 [product/feature] 文件： - [this repo / linked repo] 中已變更的原始檔 - 提及已變更行為的現有文件頁面 - 我以下提供的任何連結 issue、PR、release note 或公開參考資料 然後： - 辨識哪些內容是面向使用者的 - 只更新需要變更的文件 - 公共文件中要避開未發佈的路線圖、私人客戶資料同只限內部的背景資訊 - 保留現有文件結構、術語同交叉連結 - 執行適合該變更的文件檢查 在定稿前，請總結變更內容、你已驗證的部分，以及任何無法從可信來源證實的聲明。
運作方式
- 提供需要寫入文件的變更原始檔、分支、pull request 或 commit。
- 要求 Eigent 搜尋現有文件中受影響的功能名稱、設定鍵、指令同範例。
- 只更新需要變更的文件——保留頁面結構、術語、交叉連結同 frontmatter。
- 執行格式化同文件檢查，然後要求 Eigent 總結每項面向使用者聲明背後的證據。
- 發佈前先審閱摘要，確認沒有將內部或未發佈內容洩漏到公開文件。
試試更多提示
- 這個 PR 變更的行為，有哪些現有文件頁面有提及？
- 這項變更會否影響任何需要更新的公開 API 參數、預設值或 CLI 旗標？
- 為今次發佈撰寫一則符合我哋現有格式的變更紀錄。
- 識別更新後文件中任何無法僅根據原始碼驗證的面向使用者聲明。
使用方法
從你需要寫入文件的變更開始——提供分支、PR 或 commit。請 Eigent 先搜尋現有文件，然後先起草內容，這樣它會更新正確頁面，而唔係寫出重複現有內容的新頁面。保持範圍狹窄：一則精確的說明或範例更新，通常比整頁重寫更好。為咗令流程可重複，你可以將工作流程儲存為技能，或者要求 Eigent 喺每次發佈後按排程執行。
預期輸出
只涵蓋面向使用者變更的更新文件檔案、一份已變更同已驗證內容的摘要，以及一份無法從可信來源確認、需要人工審閱的聲明清單。
限制
- 除非你明確提供，否則 Eigent 無法存取私人客戶資料、未發佈的路線圖項目或內部 wiki。
- 文件準確性取決於原始碼註解同測試覆蓋率的質素——未有文件記載的行為可能會被漏掉。
- 對於非常大型的文件網站，最好將搜尋範圍限定喺特定章節或功能區域，而唔係搜尋整個網站。
