Wiki 内容组织

"拉了么"项目 Wiki 包含哪些内容

---

📋 内容清单

必备内容（核心章节）

待补充内容

请在这里列出"拉了么"项目 Wiki 的必备内容：

1. 项目概述

   • 项目简介
   • 技术栈
   • 核心功能
   • 业务流程图

2. 开发指南

   • 环境搭建
   • 项目结构
   • 开发规范
   • 工作流程

3. 数据模型

   • ER 图
   • 表结构说明
   • 字段含义

4. API 文档

   • 认证方式
   • 接口列表
   • 请求/响应示例

5. 业务规则

   • 订单状态流转
   • 优惠券规则
   • 配送规则

请补充实际的内容清单和说明。

进阶内容（锦上添花）

待补充内容

请在这里列出"拉了么"项目 Wiki 的进阶内容：

1. 决策记录

   • 重要的技术选型
   • 为什么选择这个方案
   • 备选方案和对比

2. 常见问题

   • 开发中遇到的坑
   • 如何解决
   • 避坑指南

3. 性能优化

   • 做了哪些优化
   • 效果如何
   • 测试数据

4. 部署文档

   • 部署步骤
   • 环境配置
   • 回滚方案

请补充实际的内容。

---

🎯 如何组织内容

按用户角色

待补充内容

请在这里说明"拉了么"项目如何按角色组织内容：

• 新人入门：快速了解项目
• 前端开发：前端相关的文档
• 后端开发：后端相关的文档
• 测试人员：测试用例、测试数据
• 产品经理：需求文档、原型图

请补充实际的分类方法。

按开发阶段

待补充内容

请在这里说明"拉了么"项目如何按阶段组织内容：

• 准备阶段：环境搭建、项目 clone
• 开发阶段：编码规范、API 文档
• 测试阶段：测试指南、Bug 排查
• 部署阶段：部署步骤、上线流程
• 维护阶段：监控、日志、常见问题

请补充实际的分类方法。

---

📝 具体内容示例

项目简介示例

待补充内容

请在这里给出"拉了么"项目简介的实际示例：

# 项目简介

## 项目背景
拉了么是一个外卖订餐平台...

## 核心功能
- 用户可以浏览附近商家
- 用户可以下单并支付
- 商家可以管理菜品和订单
- 配送员可以接单并配送

## 技术栈
- 前端：React + TypeScript + Vite
- 后端：Nest.js + Prisma + PostgreSQL
- 部署：Docker + Nginx

请补充实际的 Wiki 内容示例。

API 文档示例

待补充内容

请在这里给出 API 文档的实际示例：

# 用户登录 API

## 接口信息
- **路径**：POST /api/users/login
- **认证**：无需认证
- **限流**：10 次/分钟

## 请求体
{
  "phone": "13800138000",
  "password": "password123"
}

## 响应
成功：
{
  "code": 0,
  "data": {
    "user_id": "uuid",
    "token": "jwt_token",
    "expires_in": 7200
  }
}

失败：
{
  "code": 1001,
  "message": "手机号或密码错误"
}

请补充实际的 API 文档示例。

数据模型示例

待补充内容

请在这里给出数据模型文档的实际示例：

# User 表

## 表结构
| 字段 | 类型 | 说明 | 约束 |
|-----|------|------|------|
| id | UUID | 用户ID | PRIMARY KEY |
| phone | VARCHAR(20) | 手机号 | UNIQUE, NOT NULL |
| password_hash | VARCHAR(255) | 密码哈希 | NOT NULL |
| created_at | TIMESTAMP | 创建时间 | DEFAULT NOW() |

## 索引
- idx_phone: phone
- idx_created_at: created_at

## 关系
- User 1:N Order（一个用户有多个订单）
- User 1:N Coupon（一个用户有多张优惠券）

请补充实际的数据模型示例。

---

🔄 内容更新策略

更新频率

待补充内容

请在这里说明"拉了么"项目 Wiki 的更新策略：

• 代码变更后多久更新文档
• 谁负责更新
• 如何检查文档是否过时

更新流程

待补充内容

请在这里说明"拉了么"项目的文档更新流程：

1. 开发新功能
2. 更新相关文档
3. 代码审查时检查文档
4. 合并代码和文档
5. 定期回顾和优化

请补充实际的更新流程。

---

✅ 文档质量检查

检查清单

待补充内容

请在这里说明"拉了么"项目如何检查文档质量：

• [ ] 内容完整
• [ ] 代码示例可以运行
• [ ] 截图是最新的
• [ ] 链接有效
• [ ] 没有过时信息
• [ ] 语气一致
• [ ] 格式规范

请补充实际的检查标准。

---

下一步

Wiki 内容填充完成后，接下来要让 AI 学会使用这些内容。在下一节中，我们将详细介绍如何让 AI 使用 Wiki。

---

← 返回案例目录 | 继续学习：AI 协作实践 →