AI协作开发流程规范

# AI协作开发流程规范
> 本规范适用于AI辅助下的团队协作开发,尤其适合大型/多模块/高频上下文切换的项目,旨在最大程度减少代码遗忘、历史混淆、重复编辑、交叉影响等问题,提升开发效率和代码质量。
---
## 1. 任务拆解与分工
- 每个开发任务需拆解为**最小可交付单元**(如单一功能、单一接口、单一配置等)。
- 明确每个任务的**目标文件/模块/接口**,并在任务描述中列出。
- 任务分配前,AI需输出"本次开发涉及的文件和依赖列表",由开发者确认。
## 2. 开发前的准备
- **回顾历史**:开发前,AI需总结当前模块/文件的功能、依赖、最近变更点。
- **依赖确认**:如需修改多个文件,AI需输出依赖关系和可能影响的功能点。
- **文档同步**:确保相关文档(如接口文档、配置说明)为最新。
## 3. 代码开发与提交
- **聚焦单一功能点**:每次只开发/修改一个小功能点,开发完立即 commit。
- **代码注释**:每次修改需在代码关键处添加注释,说明变更原因和影响范围。
- **变更日志**:每次重要变更需同步更新 CHANGELOG.md 或 docs/变更记录.md。
- **自动化文档**:如有接口/配置/依赖变更,AI需自动生成/更新相关文档(如Swagger、配置说明等)。
## 4. 代码管理与分支规范
- **强制使用 Git**,每个功能/修复/重构新建独立分支(如 feature/xxx、bugfix/xxx)。
- **PR审核**:每次合并需有人工或AI辅助代码审核,防止误操作。
- **分支命名规范**:统一命名,便于追踪和回溯。
## 5. 变更影响分析
- **开发后**,AI需输出"本次变更影响的所有文件和功能点",并自动补充到变更日志。
- **合并前**,AI自动检查"本次变更是否影响已完成的功能",并给出风险提示。
- **定期输出依赖快照**,便于后续对比和回溯。
## 6. 自动化测试与回归
- **单元测试**:每个模块/功能开发完成后,需编写对应的单元测试。
- **集成测试**:关键业务流程需有集成测试,防止交叉影响。
- **CI/CD集成**:合并前自动跑测试,测试不通过禁止合并。
## 7. 文档与配置同步
- **接口/配置变更**需同步更新文档,AI辅助自动生成。
- **配置文件集中管理**,变更时有据可查。
- **文档版本管理**,与代码保持一致。
## 8. 代码审查与定期回溯
- **定期代码审查**,发现重复、遗忘、冲突问题。
- **回溯机制**,通过 Git log、变更文档、自动化测试快速定位问题。
## 9. 工具与平台建议
- **依赖可视化工具**:如 PHPStan、phpmetrics、doctum,自动生成依赖关系图。
- **AI辅助开发平台**:如 GitHub Copilot、Cursor,提升上下文记忆。
- **项目管理工具**:如 Jira、Trello,任务拆分细致,进度透明。
## 10. 典型AI协作开发流程示例
1. 任务分配 → AI输出影响文件/依赖 → 开发前回顾 → 聚焦单一功能开发 → 代码注释/文档同步 → commit → AI输出变更影响 → PR审核 → 自动化测试 → 合并 → 变更日志/文档同步
---
**本规范可根据团队实际情况持续优化。建议每次迭代后复盘,及时补充和完善。**

Jeffer.Z.Gustav

This is my note-taking platform. Welcome to visit. I will put some recorded notes here in daily life. You can see some fragments of my thinking and notes.