# 项目文档

## 概述

本文档目录包含了锡林郭勒盟智慧养殖数字化管理平台的所有相关文档。

## 文档列表

### 1. 架构文档
- [系统架构文档](./design/ARCHITECTURE.md) - 系统整体架构设计，包含技术栈、系统架构图、前端系统架构、后端系统架构、用户权限管理架构、大屏可视化系统架构、系统集成架构、性能优化策略和部署架构
- [开发计划文档](./design/DEVELOPMENT_PLAN.md) - 项目开发计划和时间安排

### 2. 需求文档
- [系统需求文档](./requirements/SYSTEM_REQUIREMENTS.md) - 系统非功能性需求
- [养殖管理系统需求文档](./requirements/FARMING_MANAGEMENT_REQUIREMENTS.md) - 养殖管理系统的功能性需求
- [金融服务系统需求文档](./requirements/FINANCIAL_SERVICES_REQUIREMENTS.md) - 金融服务系统的功能性需求
- [政府监管系统需求文档](./requirements/GOVERNMENT_SUPERVISION_REQUIREMENTS.md) - 政府监管系统的功能性需求
- [市场交易系统需求文档](./requirements/MARKET_TRADING_REQUIREMENTS.md) - 市场交易系统的功能性需求
- [商城管理系统需求文档](./requirements/MALL_MANAGEMENT_REQUIREMENTS.md) - 商城管理系统的功能性需求
- [数据中台系统需求文档](./requirements/DATA_PLATFORM_REQUIREMENTS.md) - 数据中台系统的功能性需求
- [AI能力系统需求文档](./requirements/AI_CAPABILITIES_REQUIREMENTS.md) - AI能力系统的功能性需求
- [官网需求文档](./requirements/WEBSITE_REQUIREMENTS.md) - 官网的功能性需求
- [大屏可视化系统需求文档](./requirements/dashboard_requirements.md) - 大屏可视化系统的功能性需求
- [系统集成需求文档](./requirements/SYSTEM_INTEGRATION_REQUIREMENTS.md) - 系统集成需求
- 微信小程序需求文档:
  - [养殖户小程序需求文档](./requirements/farming_app_requirements.md) - 养殖户小程序的功能性需求
  - [金融服务小程序需求文档](./requirements/finance_app_requirements.md) - 金融服务小程序的功能性需求
  - [政府监管小程序需求文档](./requirements/gov_app_requirements.md) - 政府监管小程序的功能性需求
  - [市场交易小程序需求文档](./requirements/trading_app_requirements.md) - 市场交易小程序的功能性需求
  - [数据中台小程序需求文档](./requirements/data_platform_app_requirements.md) - 数据中台小程序的功能性需求
  - [AI能力小程序需求文档](./requirements/ai_app_requirements.md) - AI能力小程序的功能性需求
  - [牛肉商城小程序需求文档](./requirements/mall_app_requirements.md) - 牛肉商城小程序的功能性需求

### 3. 设计文档
- [养殖管理API](./design/api/farming.md) - 养殖管理相关接口
- [金融服务API](./design/api/finance.md) - 金融服务相关接口
- [政府监管API](./design/api/government.md) - 政府监管相关接口
- [市场交易API](./design/api/trade.md) - 市场交易相关接口
- [数据中台API](./design/api/data-platform.md) - 数据中台相关接口
- [用户中心API](./design/api/user-center.md) - 用户中心相关接口
- [官网API](./design/api/website.md) - 官网相关接口
- [大屏可视化API](./design/api/dashboard.md) - 大屏可视化相关接口
- 微信小程序API:
  - [养殖户小程序API](./design/api/miniprograms/farming-app.md) - 养殖户小程序相关接口
  - [政务人员小程序API](./design/api/miniprograms/gov-app.md) - 政务人员小程序相关接口
  - [商户小程序API](./design/api/miniprograms/merchant-app.md) - 商户小程序相关接口
  - [普通用户小程序API](./design/api/miniprograms/user-app.md) - 普通用户小程序相关接口

### 4. 技术文档
- 数据库设计文档 (位于[backend-java/services/farming-service/src/main/resources/sql](file:///Users/ainongkeji/code/vue/xlxumu/backend-java/services/farming-service/src/main/resources/sql)目录)
- 前端组件文档 (各前端项目中)
- 部署文档 ([deployment/README.md](file:///Users/ainongkeji/code/vue/xlxumu/deployment/README.md))

### 5. 各系统详细开发计划
- [养殖管理系统开发计划](./development_plans/farming_management_development_plan.md) - 养殖管理系统的详细开发计划
- [银行监管系统开发计划](./development_plans/bank_supervision_development_plan.md) - 银行监管系统的详细开发计划
- [保险监管系统开发计划](./development_plans/insurance_supervision_development_plan.md) - 保险监管系统的详细开发计划
- [政府监管平台开发计划](./development_plans/government_platform_development_plan.md) - 政府监管平台的详细开发计划
- [活牛交易系统开发计划](./development_plans/cattle_trading_development_plan.md) - 活牛交易系统的详细开发计划
- [商城管理系统开发计划](./development_plans/mall_management_development_plan.md) - 商城管理系统的详细开发计划
- [官网开发计划](./development_plans/website_development_plan.md) - 官网的详细开发计划
- [后端API服务开发计划](./development_plans/backend_api_development_plan.md) - 后端API服务的详细开发计划
- [大屏可视化系统开发计划](./development_plans/dashboard_development_plan.md) - 大屏可视化系统的详细开发计划

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

### 7. 用户文档
- 用户手册 (待编写)
- 管理员手册 (待编写)
- 操作指南 (待编写)

### 8. 其他文档
- 测试报告 (待编写)
- 项目总结报告 (待编写)

## 文档维护

所有文档应保持最新状态，与代码实现保持一致。当功能发生变化时，应及时更新相关文档。

## 贡献指南

如果您需要更新文档，请遵循以下步骤：
1. Fork项目仓库
2. 创建新的文档分支
3. 进行文档修改
4. 提交Pull Request