"拉了么"项目案例
真实项目实践:一个外卖订餐系统如何用 Wiki 管理上下文
项目简介
"拉了么"(英文名:Lamo)是一个外卖订餐系统,我们在开发过程中使用 VitePress 搭建了项目 Wiki,大大提升了开发效率和 AI 协作效果。
为什么选择这个项目作为案例?
- 真实项目:不是假设的案例,是实际运行的系统
- 典型场景:多人协作、复杂业务、频繁让 AI 帮忙
- 可复制:方法简单,任何项目都能用
本章节将详细介绍
- 项目背景和需求
- Wiki 的搭建过程
- Wiki 包含哪些内容
- 如何让 AI 使用 Wiki
- 实际效果和经验总结
"拉了么"项目信息
项目基本信息
- 项目类型:外卖订餐平台(类似美团外卖)
- 开发时间:2024 年 6 月 - 2024 年 12 月
- 团队规模:3 人(1 前端 + 1 后端 + 1 全栈)
- 技术栈:
- 前端:React + TypeScript + Vite
- 后端:Nest.js + Prisma + PostgreSQL
- Wiki:VitePress
核心功能
- 用户端:浏览商家、下单、支付、查看订单
- 商家端:菜品管理、订单管理、营业设置
- 配送员端:接单、配送、完成
- 管理后台:数据统计、用户管理、订单监控
项目亮点
完整的 Wiki 系统
- 用 VitePress 搭建
- 记录了项目的方方面面
- AI 可以随时读取
AI 深度参与开发
- 代码生成
- Bug 排查
- 文档生成
- 测试用例编写
高效的团队协作
- 所有人基于 Wiki 理解项目
- 新人 2 天上手
- 代码风格统一
学习目标
通过本章学习,你将掌握:
如何为一个项目搭建 Wiki
- VitePress 的安装和配置
- 文档结构设计
- 内容组织方法
Wiki 应该包含什么内容
- 哪些信息必须记录
- 如何组织这些内容
- 如何保持更新
如何让 AI 使用 Wiki
- 让 AI 读取本地 Wiki
- 在对话中引用 Wiki
- 提高 AI 建议的相关性
实际经验和避坑指南
- 哪些做法值得借鉴
- 哪些坑可以避免
- 如何持续维护
章节列表
- 项目概述 - 项目背景、需求、技术选型
- VitePress 搭建过程 - 如何搭建项目 Wiki
- Wiki 内容组织 - Wiki 包含哪些内容
- AI 协作实践 - 如何让 AI 使用 Wiki
- 经验总结 - 做得好的地方和可以改进的地方
💡 学习提示:这是一个真实项目的详细拆解。建议边学边思考:如果是我的项目,应该如何搭建 Wiki?