DeepDocs
DeepDocs 是什麼？
DeepDocs 是一款專為開發團隊設計的 GitHub 原生 AI 代理，旨在自動化技術文件與不斷演進的程式碼庫保持同步的過程。它透過自動掃描程式碼變更並更新相關文件，例如 READMEs、API 參考、SDK 指南和教學，解決了文件過時的常見問題。其核心價值主張是消除手動、耗時的文件更新工作，讓開發人員能夠專注於程式碼交付，同時確保文件保持準確和最新。它直接整合到 GitHub 工作流程中，提供智慧且隱私優先的更新。
如何使用 DeepDocs
使用者可以透過在 GitHub Marketplace 上將 DeepDocs 應用程式安裝到其儲存庫來開始使用。安裝後，他們需要在儲存庫根目錄的 deepdocs.yml 檔案中定義要追蹤的文件或資料夾，以配置 DeepDocs。提交此 YAML 檔案將觸發對任何過時文件的首次深度掃描和更新，並在單獨的分支中進行。隨後，所有未來的程式碼提交都將自動觸發持續的文件更新。DeepDocs 為個人或開源專案提供有限額度的免費方案，而包含更多額度和功能的「專業版」方案即將推出。
DeepDocs 的核心功能
持續文件更新
深度掃描
智慧更新
詳細報告
GitHub 原生
隱私優先
DeepDocs 的使用場景
當程式碼變更時自動更新 README 檔案。
使 API 參考文件與 API 程式碼修改保持同步。
確保 SDK 指南反映最新的函式庫版本和功能。
隨著底層程式碼的演進，保持教學內容的最新狀態。
為開發團隊消除手動文件更新的工作。
透過單次掃描確保整個儲存庫的文件準確性。
將文件更新無縫整合到現有的 GitHub 工作流程中。
提供由程式碼提交觸發的文件變更的清晰報告。
DeepDocs 的常見問題
DeepDocs 有什麼作用？
DeepDocs 是一款 GitHub 原生 AI 代理，能自動讓您的 API 文件、SDK 指南、教學等與您的程式碼庫保持同步。它會監聽程式碼變更，偵測過時文件，並在單獨的分支中進行更新，同時提供詳細報告。
DeepDocs 會從頭開始建立文件嗎？
DeepDocs 旨在維護現有文件，而非從頭開始生成。如果您是從零開始，GitHub Copilot、Cursor 等 AI 程式碼工具可以幫助您起草初始版本。一旦您的文件到位，DeepDocs 將使其與您的程式碼庫保持同步——每次提交都會自動更新。
我如何在我的儲存庫上設定 DeepDocs？
DeepDocs 可以透過 3 個簡單步驟設定：1. 從 GitHub Marketplace 安裝應用程式；2. 在 deepdocs.yml 檔案中指定您要追蹤的目標文件或資料夾；3. 在儲存庫根目錄提交該檔案以觸發深度掃描並更新任何損壞的文件。未來的提交將自動觸發文件更新。
DeepDocs 會修改我的文件結構或樣式嗎？
不會。DeepDocs 只會智慧地更新您文件的相關部分。它會保留您現有的格式，並避免從頭重寫檔案。
深度掃描（Deep Scan）和文件更新（Doc Update）有什麼區別？
深度掃描（Deep Scan）是 DeepDocs 的一項功能，可執行全儲存庫分析，一次性偵測並修復過時文件，可手動觸發。文件更新（Docs Update）是持續文件更新功能，在每次提交時觸發，僅識別和更新受影響的文件。
DeepDocs 中的點數是如何消耗的？
DeepDocs 在深度掃描和文件更新過程中各消耗 1 點數。
像 Cursor 或 Copilot 這樣的 AI 編碼代理不也能建立文件嗎？
它們可以，但僅限於您手動提示它們要更新什麼。DeepDocs 的工作方式不同。它將持續文件更新引入您的工作流程，就像 CI/CD 取代了手動部署一樣，DeepDocs 取代了手動文件更新。它還具備完整的程式碼到文件上下文，因此它知道哪些內容發生了變化以及哪些文件受到影響，無需提示。