2.0 KiB
2.0 KiB
文档完善计划
根据当前项目状态(官网已重构,其他模块待开发),我将完善核心文档以指导后续开发。
1. 更新现有文档
docs/官网需求文档.md- 更新技术栈描述:Vue 3 + Bootstrap 5 + ECharts。
- 更新功能模块描述:与当前重构后的页面保持一致。
2. 编写核心架构文档
docs/整个项目的架构文档.md(目前为空)- 定义总体技术架构:
- 官网:Vue 3 + Bootstrap 5 (已实现)
- 管理后台 (Admin):推荐 Vue 3 + Element Plus (适合后台复杂表单)
- 小程序 (Mini-program):推荐 Uni-app (跨平台,复用 Vue 技术栈)
- 后端服务 (Backend):推荐 Java Spring Boot (企业级稳健) 或 Node.js NestJS (全栈统一)
- 数据库:MySQL + Redis
- 基础设施:CentOS 10, Docker, Nginx
- 绘制简易架构图(文本描述)。
- 定义总体技术架构:
3. 编写项目总需求文档
docs/整个项目需求文档.md(目前为空)- 明确项目背景:云南肉牛产业数字化。
- 核心业务流:养殖 -> 交易 -> 金融 -> 监管。
- 角色定义:政府、企业、养殖户、访客。
4. 编写数据库设计文档(初稿)
docs/数据库设计文档.md(目前为空)- 设计核心ER图概念。
- 规划基础表结构:
users(用户/企业)cattle_info(牛只档案)transactions(交易记录)news(新闻资讯)
5. 编写部署文档
docs/部署文档.md(目前为空)- 规划服务器目录结构。
- 编写官网的构建与 Nginx 部署配置。
- 规划后端与数据库的 Docker 部署方案。
执行顺序
- 更新官网需求文档 (反映现状)。
- 撰写整个项目的架构文档 (确立基石)。
- 撰写整个项目需求文档 (明确范围)。
- 撰写数据库设计文档 (数据先行)。
- 撰写部署文档 (运维准备)。