团队最佳实践
AgileBuilder 团队使用建议
概述
本文档总结 AgileBuilder 在团队中使用 的最佳实践,帮助团队高效地建立和维护模板体系。
模板管理
1. 从一类项目开始
不要一开始试图覆盖所有类型的项目。
建议:
- 先从团队最常见的一类项目起步
- 建立一个高频使用的模板
- 验证效果后再扩展到其他类型
示例:
第一个模板 → React 管理后台模板
↓
第二个模板 → React 前端应用模板(基于第一个的经验)
↓
第三个模板 → Node.js API 模板
2. 模板与规范一起维护
模板不是孤立文件集合,应该和文档一起维护。
建议:
- 每个模板配有使用文档
- 文档说明适用场景和限制
- 记录模板的变更历史
3. 明确的命名规范
模板命名:
{技术栈}-{类型}-{特性}
示例:react-admin-antd
vue-frontend-ts
node-api-express
变量命名:
使用驼峰命名或下划线命名
示例:projectName, useTypeScript, api_base_url
文档管理
1. 文档分层
第一层:索引文档(README)
↓
第二层:分类文档(规范、最佳实践)
↓
第三层:详细文档(具体规范内容)
2. 文档更新流程
1. 提出变更申请
2. 团队讨论确认
3. 文档更新
4. 审核通过
5. 通知相关人员
3. 文档与模板关联
在模板的 README.md.hbs 中引用相关规范文档:
## 使用本模板
请先阅读以下规范:
- [代码规范](../../docs/coding-standards.md)
- [API 规范](../../docs/api-spec.md)
AI 集成
1. 统一 AI 工作流
建议:
- 全团队使用统一的工作流
- 避免个人自定义导致不一致
- 定期review工作流效果
2. 规范优先于生成
顺序:
1. AI 先查询团队规范
2. 根据规范生成代码
3. 最后验证符合性
3. 监控 AI 生成质量
- 定期检查 AI 生成结果
- 根据问题调整规范或模板
- 建立反馈机制
团队协作
1. 指定负责人
每个重要模板/文档指定负责人:
| 资源 | 负责人 | 职责 |
|---|---|---|
| React 模板 | @张三 | 维护模板、更新依赖 |
| 代码规范 | @李四 | 更新规范、审核变更 |
2. 变更审核流程
成员提交 → 负责人审核 → 测试验证 → 合并发布
3. 定期回顾
- 每月回顾模板使用情况
- 根据反馈优化模板和文档
- 淘汰不再使用的模板
常见问题
Q: 模板太多难以管理怎么办?
建议:
- 使用标签分类
- 设置模板评分/点赞
- 定期清理低使用模板
Q: 成员不遵守规范怎么办?
建议:
- 完善规范文档
- 配置强制审核
- 通过 AI 工作流自动检查
Q: 如何让 AI 优先使用团队规范?
建议:
- 在工作流中强制先查询文档
- 定期更新文档确保时效性
- 监控生成结果质量