aiotagro/xlxumu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 重构API文档和系统架构文档，统一技术栈规范docs(architecture): 更新系统架构设计文档

Browse Source 
- 重新组织文档结构，优化标题层级
- 添加系统架构图，直观展示系统组成- 补充前端架构、后端架构、数据架构等详细内容
- 更新安全架构、部署架构、性能优化策略等章节
- 增加扩展性设计和高可用设计章节
- 总结系统架构设计特点和优势
This commit is contained in:
ylweng
2025-09-11 01:04:51 +08:00
parent 68c6c23f5a
commit f1273daeac
34 changed files with 1663 additions and 1713 deletions
Download Patch File Download Diff File Expand all files Collapse all files

189
docs/README.md
View File

@@ -1,91 +1,126 @@
# 项目文档
# xlxumu项目文档
## 概述
## 项目概述
本文档目录包含了锡林郭勒盟智慧养殖数字化管理平台的所有相关文档。
xlxumu是一个综合性的畜牧管理系统，旨在为畜牧业提供全面的数字化解决方案。该系统涵盖了从养殖管理、金融服务、政府监管到电商交易等各个环节，通过现代化的技术架构和用户友好的界面设计，提升畜牧业的管理效率和经济效益。
## 文档列表
## 文档结构
### 1. 架构文档
- [系统架构文档](./design/ARCHITECTURE.md) - 系统整体架构设计，包含技术栈、系统架构图、前端系统架构、后端系统架构、用户权限管理架构、大屏可视化系统架构、系统集成架构、性能优化策略和部署架构
- [开发计划文档](./design/DEVELOPMENT_PLAN.md) - 项目开发计划和时间安排
```
docs/
├── requirements/ # 需求文档
├── design/ # 设计文档
├── development_plans/ # 开发计划
├── API_DOCUMENTATION_STANDARD.md # API文档标准
├── API_DOCUMENTATION_CHECKLIST.md # API文档检查清单
├── DOCUMENTATION_MAINTENANCE_PROCESS.md # 文档维护流程
├── PROJECT_STRUCTURE.md # 项目结构说明
└── README.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) - 牛肉商城小程序的功能性需求
## 需求文档 (requirements/)
### 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) - 普通用户小程序相关接口
### 系统级需求
- [SYSTEM_REQUIREMENTS.md](requirements/SYSTEM_REQUIREMENTS.md) - 系统整体需求
- [SYSTEM_INTEGRATION_REQUIREMENTS.md](requirements/SYSTEM_INTEGRATION_REQUIREMENTS.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))
### 业务模块需求
- [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) - 养殖管理需求
### 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) - 大屏可视化系统的详细开发计划
### 小程序需求
- [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) - 仪表板需求
### 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) - 活牛交易小程序的详细开发计划
## 设计文档 (design/)
### 7. 用户文档
- 用户手册 (待编写)
- 管理员手册 (待编写)
- 操作指南 (待编写)
### 系统架构设计
- [ARCHITECTURE.md](design/ARCHITECTURE.md) - 系统架构设计
- [system_architecture.svg](design/system_architecture.svg) - 系统架构图
### 8. 其他文档
- 测试报告 (待编写)
- 项目总结报告 (待编写)
### 数据库设计
- [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 (服务注册中心)
## 文档维护
所有文档应保持最新状态，与代码实现保持一致。当功能发生变化时，应及时更新相关文档。
## 贡献指南
如果您需要更新文档，请遵循以下步骤：
1. Fork项目仓库
2. 创建新的文档分支
3. 进行文档修改
4. 提交Pull Request
请参考 [DOCUMENTATION_MAINTENANCE_PROCESS.md](DOCUMENTATION_MAINTENANCE_PROCESS.md) 了解文档维护流程和规范。