DeepDocs
DeepDocs 是什么？
DeepDocs 是一款 GitHub 原生 AI 代理，专为希望自动化技术文档与不断演进的代码库保持同步的开发团队设计。它通过自动扫描代码更改并更新相关文档（如 README、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 只会智能地更新您文档的相关部分。它会保留您现有的格式，并避免从头重写文件。
深度扫描和文档更新有什么区别？
深度扫描是 DeepDocs 的一项功能，可执行全仓库分析，一次性检测并修复过时的文档，可手动触发。文档更新是持续文档功能，在每次提交时触发，仅识别和更新受影响的文档。
DeepDocs 中如何消耗信用点？
DeepDocs 在深度扫描和文档更新过程中各消耗 1 个信用点。
像 Cursor 或 Copilot 这样的 AI 编码代理也能创建文档吗？
它们可以，但前提是您手动提示它们要更新什么。DeepDocs 的工作方式不同。它将持续文档引入您的工作流程，就像 CI/CD 取代了手动部署一样，DeepDocs 取代了手动文档更新。它还具有完整的代码到文档上下文，因此它知道哪些内容发生了变化以及哪些文档受到了影响，而无需提示。