在使用 DeepDocs 时需要注意以下几点：
- 初始文档要求：DeepDocs 不生成全新文档，需要项目已存在基础文档（可由 GitHub Copilot 等工具创建）。
- 跨仓库配置：如果文档和代码分属不同仓库，需将 DeepDocs 安装到两个仓库，但只需在代码仓库配置 deepdocs.yml。
- Format retention：DeepDocs 专注于内容更新而非格式重构，要确保原始文档有良好结构和格式。
- 审查机制：虽然 DeepDocs 能自动更新，但建议团队保留审查环节，通过 GitHub 的 pull request 机制确认变更。
- Markdown Support：目前主要支持 Markdown 格式文档，如需其他格式需额外处理。
DeepDocs 被设计为最小化配置和最大自动化，但适当的预先规划可以确保获得最佳使用体验。团队可以根据自身需求灵活调整配置，平衡自动化程度和控制精度。
This answer comes from the articleDeepDocs: the GitHub AI tool that automatically updates code documentationThe
May not be reproduced without permission:AI productivity tools " What are the do's and don'ts of using DeepDocs?
English 
简体中文 
日本語 
Deutsch 
Português do Brasil