xlxumu/docs/README.md

# xlxumu项目文档

## 项目概述

xlxumu是一个综合性的畜牧管理系统，旨在为畜牧业提供全面的数字化解决方案。该系统涵盖了从养殖管理、金融服务、政府监管到电商交易等各个环节，通过现代化的技术架构和用户友好的界面设计，提升畜牧业的管理效率和经济效益。

## 文档结构

```
docs/
├── requirements/           # 需求文档
├── design/                # 设计文档
├── development_plans/     # 开发计划
├── API_DOCUMENTATION_STANDARD.md  # API文档标准
├── API_DOCUMENTATION_CHECKLIST.md # API文档检查清单
├── DOCUMENTATION_MAINTENANCE_PROCESS.md # 文档维护流程
├── PROJECT_STRUCTURE.md   # 项目结构说明
└── README.md              # 文档目录说明（当前文件）
```

## 需求文档 (requirements/)

### 系统级需求
- [SYSTEM_REQUIREMENTS.md](requirements/SYSTEM_REQUIREMENTS.md) - 系统整体需求
- [SYSTEM_INTEGRATION_REQUIREMENTS.md](requirements/SYSTEM_INTEGRATION_REQUIREMENTS.md) - 系统集成需求

### 业务模块需求
- [FARMING_MANAGEMENT_REQUIREMENTS.md](requirements/FARMING_MANAGEMENT_REQUIREMENTS.md) - 养殖管理需求
- [FINANCIAL_SERVICES_REQUIREMENTS.md](requirements/FINANCIAL_SERVICES_REQUIREMENTS.md) - 金融服务需求
- [GOVERNMENT_SUPERVISION_REQUIREMENTS.md](requirements/GOVERNMENT_SUPERVISION_REQUIREMENTS.md) - 政府监管需求
- [MARKET_TRADING_REQUIREMENTS.md](requirements/MARKET_TRADING_REQUIREMENTS.md) - 市场交易需求
- [MALL_MANAGEMENT_REQUIREMENTS.md](requirements/MALL_MANAGEMENT_REQUIREMENTS.md) - 商城管理需求
- [DATA_PLATFORM_REQUIREMENTS.md](requirements/DATA_PLATFORM_REQUIREMENTS.md) - 数据平台需求
- [AI_CAPABILITIES_REQUIREMENTS.md](requirements/AI_CAPABILITIES_REQUIREMENTS.md) - AI能力需求
- [WEBSITE_REQUIREMENTS.md](requirements/WEBSITE_REQUIREMENTS.md) - 官网需求
- [RAISING_MANAGEMENT_REQUIREMENTS.md](requirements/RAISING_MANAGEMENT_REQUIREMENTS.md) - 养殖管理需求

### 小程序需求
- [farming_app_requirements.md](requirements/farming_app_requirements.md) - 养殖管理小程序需求
- [finance_app_requirements.md](requirements/finance_app_requirements.md) - 金融小程序需求
- [gov_app_requirements.md](requirements/gov_app_requirements.md) - 政府监管小程序需求
- [trading_app_requirements.md](requirements/trading_app_requirements.md) - 交易小程序需求
- [mall_app_requirements.md](requirements/mall_app_requirements.md) - 商城小程序需求
- [data_platform_app_requirements.md](requirements/data_platform_app_requirements.md) - 数据平台小程序需求
- [ai_app_requirements.md](requirements/ai_app_requirements.md) - AI能力小程序需求
- [dashboard_requirements.md](requirements/dashboard_requirements.md) - 仪表板需求

## 设计文档 (design/)

### 系统架构设计
- [ARCHITECTURE.md](design/ARCHITECTURE.md) - 系统架构设计
- [system_architecture.svg](design/system_architecture.svg) - 系统架构图

### 数据库设计
- [database/README.md](design/database/README.md) - 数据库设计说明
- [database/DESIGN.md](design/database/DESIGN.md) - 数据库详细设计

### API设计
- [api/farming.md](design/api/farming.md) - 养殖管理API设计
- [api/finance.md](design/api/finance.md) - 金融服务API设计
- [api/government.md](design/api/government.md) - 政府监管API设计
- [api/trade.md](design/api/trade.md) - 交易管理API设计
- [api/data-platform.md](design/api/data-platform.md) - 数据平台API设计
- [api/user-center.md](design/api/user-center.md) - 用户中心API设计
- [api/dashboard.md](design/api/dashboard.md) - 仪表板API设计
- [api/website.md](design/api/website.md) - 官网API设计

### 小程序API设计
- [api/miniprograms/](design/api/miniprograms/) - 小程序API设计目录

## 开发计划 (development_plans/)

### 后端开发计划
- [backend_api_development_plan.md](development_plans/backend_api_development_plan.md) - 后端API开发计划

### 前端开发计划
- [dashboard_development_plan.md](development_plans/dashboard_development_plan.md) - 仪表板开发计划
- [farming_management_development_plan.md](development_plans/farming_management_development_plan.md) - 养殖管理开发计划
- [cattle_trading_development_plan.md](development_plans/cattle_trading_development_plan.md) - 牛只交易开发计划
- [mall_management_development_plan.md](development_plans/mall_management_development_plan.md) - 商城管理开发计划
- [bank_supervision_development_plan.md](development_plans/bank_supervision_development_plan.md) - 银行监管开发计划
- [insurance_supervision_development_plan.md](development_plans/insurance_supervision_development_plan.md) - 保险监管开发计划
- [government_platform_development_plan.md](development_plans/government_platform_development_plan.md) - 政府平台开发计划
- [website_development_plan.md](development_plans/website_development_plan.md) - 官网开发计划

### 小程序开发计划
- [farming_management_miniprogram_development_plan.md](development_plans/farming_management_miniprogram_development_plan.md) - 养殖管理小程序开发计划
- [cattle_trading_miniprogram_development_plan.md](development_plans/cattle_trading_miniprogram_development_plan.md) - 牛只交易小程序开发计划
- [beef_mall_miniprogram_development_plan.md](development_plans/beef_mall_miniprogram_development_plan.md) - 牛肉商城小程序开发计划
- [bank_supervision_miniprogram_development_plan.md](development_plans/bank_supervision_miniprogram_development_plan.md) - 银行监管小程序开发计划
- [insurance_supervision_miniprogram_development_plan.md](development_plans/insurance_supervision_miniprogram_development_plan.md) - 保险监管小程序开发计划

## 标准与规范

- [API_DOCUMENTATION_STANDARD.md](API_DOCUMENTATION_STANDARD.md) - API文档标准
- [API_DOCUMENTATION_CHECKLIST.md](API_DOCUMENTATION_CHECKLIST.md) - API文档检查清单
- [DOCUMENTATION_MAINTENANCE_PROCESS.md](DOCUMENTATION_MAINTENANCE_PROCESS.md) - 文档维护流程
- [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) - 项目结构说明

## 技术架构更新

随着项目的发展，我们新增了Java版本后端技术栈：

### Java后端技术栈
- Java 8+ + Spring Boot 2.7.x
- Spring Cloud 2021.x
- Maven 3.8.x
- MySQL 8.0

### 微服务架构
项目现在采用微服务架构，包含以下服务：
- farming-service (养殖管理服务)
- user-center-service (用户中心服务)
- finance-service (金融服务)
- government-service (政府监管服务)
- trade-service (交易管理服务)
- mall-service (商城管理服务)
- data-platform-service (数据平台服务)
- ai-service (AI能力服务)
- gateway (网关服务)
- config-server (配置服务器)
- registry (服务注册中心)

## 文档维护

请参考 [DOCUMENTATION_MAINTENANCE_PROCESS.md](DOCUMENTATION_MAINTENANCE_PROCESS.md) 了解文档维护流程和规范。