AI 协作实践
如何让 AI 使用"拉了么"项目的 Wiki
🤖 AI 如何读取 Wiki
方式 1:手动引用
markdown
你:帮我写一个订单创建功能
请参考项目 Wiki:
- 技术栈:docs/overview/tech-stack.md
- 数据模型:docs/database/schema.md
- API 规范:docs/api/order-api.md
- 开发规范:docs/development/guidelines.md待补充内容
请在这里补充:
- 这种方式的效果如何
- 有什么优缺点
- 适用场景
方式 2:总结后告诉 AI
markdown
你:帮我写一个订单创建功能
项目信息:
- 后端框架:Nest.js + TypeORM
- 数据库:PostgreSQL
- 订单状态流转:pending → paid → preparing → delivering → completed
- 需要校验:库存、优惠券、配送地址
- 代码风格参考:src/modules/user 模块
详细文档见项目 Wiki(已上传)待补充内容
请在这里补充:
- 这种方式的效果如何
- 如何准备项目信息摘要
- 适用场景
方式 3:让 AI 自动读取(推荐)
前提:使用 Claude Code 或其他支持本地文件读取的工具
你:帮我写一个订单创建功能
AI:(自动读取项目 Wiki)
我看了你的 Wiki:
- 技术栈:Nest.js + Prisma
- 订单表结构:orders(主表)、order_items(明细)
- 业务规则:见 docs/business-rules.md
- 代码示例:见 docs/examples/order-service.md
我给你写一个符合项目规范的实现...待补充内容
请在这里补充:
- "拉了么"项目使用的 AI 工具
- 如何配置 AI 工具读取本地 Wiki
- 实际效果如何
📊 实际案例
案例 1:代码生成
任务:添加"优惠券查询"功能
待补充内容
请在这里补充完整的案例:
提示词:
帮我写一个查询用户可用优惠券的接口
参考 Wiki:
- 数据模型:docs/database/coupon.md
- API 规范:docs/api/user-api.md
- 业务规则:docs/business/coupon-rules.mdAI 的回答: (补充实际的 AI 回答)
效果:
- 生成的代码是否可以直接用
- 是否符合项目规范
- 节省了多少时间
案例 2:Bug 排查
问题:订单创建后库存没有扣减
待补充内容
请在这里补充完整的案例:
提示词:
订单创建后库存没有扣减,帮我排查
相关代码:
src/modules/order/order.service.ts
参考 Wiki:
- 数据模型:docs/database/inventory.md
- 业务规则:docs/business/inventory-rules.mdAI 的回答: (补充实际的 AI 回答)
效果:
- AI 是否快速定位问题
- 给出的解决方案是否正确
案例 3:新人上手
场景:新成员加入团队
待补充内容
请在这里补充:
传统方式:
- 老员工花 2 天时间讲解
- 口头传授,容易遗漏
使用 Wiki + AI:
- 新人阅读 Wiki
- 遇到问题问 AI
- AI 基于 Wiki 回答
效果:
- 上手时间从 2 天缩短到 X 小时
- 知识传承更完整
🎯 最佳实践
1. Wiki 结构要清晰
待补充内容
请在这里说明:
- 如何设计清晰的文档结构
- 文件命名规范
- 目录组织原则
2. 文档要详细但不冗余
待补充内容
请在这里说明:
- 哪些信息必须写
- 哪些信息可以省略
- 如何把握详细程度
3. 及时更新
待补充内容
请在这里说明:
- 如何保证文档与代码同步
- 更新频率如何
- 如何检查文档是否过时
4. 让团队都用起来
待补充内容
请在这里说明:
- 如何让团队成员习惯使用 Wiki
- 如何推广 AI + Wiki 的工作方式
- 团队接受度如何
📈 效果对比
有 Wiki vs 无 Wiki
| 对比项 | 无 Wiki | 有 Wiki |
|---|---|---|
| 新人上手 | X 天 | Y 天 |
| AI 准确率 | X% | Y% |
| 重复沟通 | 频繁 | 很少 |
| 代码一致性 | 较差 | 很好 |
待补充内容
请在这里补充"拉了么"项目的实际数据。
时间节省统计
待补充内容
请在这里补充:
- 使用 Wiki + AI 后,每个任务节省多少时间
- 举例说明(如:之前需要 2 小时,现在 30 分钟)
⚠️ 注意事项
1. Wiki 不是银弹
待补充内容
请在这里说明:
- Wiki 不能解决什么问题
- 哪些场景不适合用 Wiki
2. 仍然需要沟通
待补充内容
请在这里说明:
- Wiki 不能完全替代团队沟通
- 什么时候必须面对面讨论
3. 文档维护成本
待补充内容
请在这里说明:
- 维护 Wiki 需要多少时间
- 如何降低维护成本
下一步
在最后一节中,我们将总结"拉了么"项目的经验教训,以及可以改进的地方。