使用Engineering的文档自动化功能需要遵循以下标准化流程：
- 代码库接入：在平台仪表板关联GitHub/GitLab仓库，系统会扫描代码结构。建议选择包含完整注释的成熟项目（至少80%注释覆盖率），平台能更好识别代码意图。
- 文档类型选择：平台支持多种文档输出：
- API documentation：自动解析函数/方法签名、参数说明和返回值
- 系统手册：基于模块注释生成整体架构说明
- Deployment Guide
：识别Dockerfile或CI/CD配置生成环境依赖说明
- 生成与校验：点击”生成文档”后，系统会：
- 提取代码中的docstring和特殊标记（如@param）
- 分析调用关系补充上下文
- 生成Markdown/HTML格式初稿
建议人工校验关键部分，特别是业务逻辑复杂的模块。
- 持续同步：开启”自动更新”后，当相关代码变更时，文档会通过PR方式提交更新，团队可设置审查规则确保文档质量。
最佳实践：在代码中使用标准化注释格式（如JavaDoc、Python Docstring），平台对Swagger/OpenAPI规范的识别精度可达95%以上。对于遗留系统，建议先运行平台的”文档健康度扫描”功能定位缺失注释的关键区域。
This answer comes from the articleEngineering: GitHub's automated code review, documentation and team reporting platformThe
May not be reproduced without permission:AI productivity tools " 如何通过Engineering进行自动化文档生成？
English 
简体中文 
日本語 
Deutsch 
Português do Brasil