# 团队模块文档

## 文档目录

### 1. 基础设计文档

- [设计概述](设计概述.md) - 模块的整体设计思路和架构
- [数据库设计](数据库设计.md) - 详细的数据库表结构和关系设计
- [模块接口](模块接口.md) - 模块对外提供的服务接口
- [枚举定义](枚举定义.md) - 模块中使用的所有枚举类型定义

### 2. 功能领域文档

- [推荐关系系统](推荐关系系统.md) - 推荐关系的建立、维护和查询
- [达人等级系统](达人等级系统.md) - 达人等级的计算、升级和权益
- [团队收益系统](团队收益系统.md) - 团队收益的计算、分配和记录
- [直间推收益机制](直间推收益机制.md) - 直间推播种收获贡献百分比农作物收益的实现机制

### 3. 开发与实现文档

- [开发指南](开发指南.md) - 模块开发的快速入门指南
- [事件系统](事件系统.md) - 模块的事件系统设计与实现
- [缓存策略](缓存策略.md) - 团队模块的缓存策略设计与实现

### 4. 模块集成文档

- [与Farm模块集成](与Farm模块集成.md) - 团队模块与农场模块的集成方案
- [与User模块集成](与User模块集成.md) - 团队模块与用户模块的集成方案
- [与GameItems模块集成](与GameItems模块集成.md) - 团队模块与物品模块的集成方案

## 文档更新记录

| 日期 | 文档 | 更新内容 |
|------|------|---------|
| 2023-05-10 | 全部文档 | 初始创建 |
| 2023-05-11 | 与Farm模块集成 | 添加团队模块与农场模块的集成方案 |
| 2023-05-11 | 枚举定义 | 添加团队模块的枚举类型定义 |
| 2023-05-12 | 推荐关系系统 | 更新为只保存直接上级关系 + 缓存策略的方案 |
| 2023-05-12 | 数据库设计 | 更新推荐关系表结构，添加推荐关系修改记录表 |
| 2023-05-12 | 缓存策略 | 添加团队模块的缓存策略设计与实现文档 |
| 2023-05-15 | 直间推收益机制 | 添加直间推播种收获贡献百分比农作物收益的实现机制文档 |
| 2023-05-15 | 与Farm模块集成 | 更新集成文档，强调直间推收益机制的实现 |
| 2023-05-15 | 数据库设计 | 更新团队收益记录表，添加relation_type字段区分直推和间推收益 |
| 2023-05-16 | 推荐关系系统 | 更新推荐关系系统文档，添加用户关系缓存表的设计与实现 |

## 文档规范

1. **命名规范**：文档文件名使用中文，以便于理解
2. **格式规范**：使用Markdown格式，遵循统一的标题层级
3. **内容规范**：每个文档应包含概述、正文和总结三部分
4. **示例规范**：代码示例应包含注释，使用```php标记

## 待完成文档

1. **与Task模块集成** - 团队模块与任务系统的集成方案
2. **测试指南** - 团队模块的测试方法和示例
3. **监控与告警** - 团队模块的监控指标和告警策略

## 联系方式

如有文档相关问题，请联系团队模块文档负责人。