优化cursor使用形式,增加项目文档过程管理,方便cursor生成代码
This commit is contained in:
1 parent
2f7e1a9c16
commit
65d2d71469
36 files changed
+8872
-1530
No files matched your search
+137
-82
@@ -1,86 +1,112 @@
|
||||
# RuoYi-Vue-Plus 项目文档中心
|
||||
# 高校智慧校园管理系统文档中心
|
||||
|
||||
## 文档概述
|
||||
## 📋 文档概述
|
||||
|
||||
本文档中心包含了 RuoYi-Vue-Plus 项目的完整技术文档,涵盖需求分析、系统设计、开发指南、测试规范、部署运维等各个方面。
|
||||
本文档中心采用**混合组织方式**,既支持按项目阶段的全过程管理,又提供按业务模块的聚合视图,完整记录从项目需求到交付的全生命周期文档,同时为 Cursor AI 辅助开发提供完整的业务上下文。
|
||||
|
||||
## 📚 文档目录结构
|
||||
## 🎯 文档组织理念
|
||||
|
||||
### 🎯 [需求文档](requirements/)
|
||||
- **全过程管理**:涵盖需求分析、系统设计、开发指南、测试规范、部署运维等各个阶段
|
||||
- **AI 辅助开发**:便于 Cursor AI 快速理解业务上下文和技术细节
|
||||
- **模块化管理**:同一业务模块的文档聚合,便于查找和维护
|
||||
- **变更追踪**:完善的变更记录和版本管理体系
|
||||
|
||||
存放项目的需求相关文档,明确项目功能和业务规则。
|
||||
## 🏗️ 核心文档目录
|
||||
|
||||
**主要内容**:
|
||||
### 📋 [项目总览](项目总览/)
|
||||
|
||||
- 功能需求文档
|
||||
- 业务流程文档
|
||||
- 原型设计文档
|
||||
- 业务规则文档
|
||||
**新增核心目录** - 项目整体信息一目了然
|
||||
|
||||
**已有文档**:
|
||||
- 项目基本信息和技术架构
|
||||
- 团队组织和开发分工
|
||||
- 项目时间线和目标 KPI
|
||||
- 开发工具链和协作规范
|
||||
|
||||
- [后勤满意度调查系统需求说明](../需求文件夹/后勤满意度调查需求/高校后勤满意度调查系统需求说明.md)
|
||||
- [简化版报告厅预约系统设计说明](../需求文件夹/后勤报告厅预约需求/简化版报告厅预约系统设计说明.md)
|
||||
### 📊 [业务模块文档](业务模块/)
|
||||
|
||||
### 🏗️ [设计文档](design/)
|
||||
**新增核心目录** - 按业务模块聚合,为 AI 辅助开发提供完整上下文
|
||||
|
||||
存放项目的设计相关文档,包括系统架构、数据库设计、接口设计等。
|
||||
- 🔐 [用户管理模块](业务模块/user-management/)
|
||||
- 📊 [后勤满意度调查模块](业务模块/hq-satisfaction-survey/)
|
||||
- 🏛️ [报告厅预约模块](业务模块/hall-reservation/)
|
||||
- ⚙️ [系统管理模块](业务模块/system-management/)
|
||||
|
||||
**主要内容**:
|
||||
**每个模块包含**:requirements.md、design.md、api.md、database.md、test-cases.md
|
||||
|
||||
- 系统架构设计
|
||||
- 数据库设计文档
|
||||
- API 接口设计
|
||||
- 安全设计文档
|
||||
- 性能设计文档
|
||||
### 🎯 [需求文档](需求文档/)
|
||||
|
||||
### 💻 [开发文档](development/)
|
||||
**保留并优化** - 项目需求相关文档,明确项目功能和业务规则
|
||||
|
||||
存放项目的开发相关文档,为开发人员提供详细的开发指南。
|
||||
### 🏗️ [设计文档](设计文档/)
|
||||
|
||||
**主要内容**:
|
||||
**保留并优化** - 系统架构、数据库设计、接口设计等
|
||||
|
||||
- 开发环境搭建
|
||||
- 开发规范和指南
|
||||
- 代码样例和模板
|
||||
- 功能开发指南
|
||||
- 问题记录和解决方案
|
||||
- 系统架构设计和技术选型
|
||||
- 数据库设计文档(含现有的 hzdyjs_xg.sql)
|
||||
- API 接口设计规范
|
||||
- UI 设计和安全设计文档
|
||||
|
||||
### 🧪 [测试文档](testing/)
|
||||
### 💻 [开发文档](开发文档/)
|
||||
|
||||
存放项目的测试相关文档,确保项目质量和稳定性。
|
||||
**保留并优化** - 为开发人员和 AI 辅助提供详细开发指南
|
||||
|
||||
**主要内容**:
|
||||
- 开发环境搭建和 IDE 配置
|
||||
- 编码规范和 Git 工作流
|
||||
- 完整 API 文档(开发文档/API.md)
|
||||
- 代码模板和集成指南
|
||||
|
||||
- 测试计划文档
|
||||
- 测试用例文档
|
||||
- 测试报告
|
||||
- 自动化测试
|
||||
- 性能测试
|
||||
### 🧪 [测试文档](测试文档/)
|
||||
|
||||
### 🚀 [部署文档](deployment/)
|
||||
**保留并优化** - 确保项目质量和稳定性
|
||||
|
||||
存放项目的部署相关文档,指导项目的部署和运维。
|
||||
- 测试策略和测试计划
|
||||
- 功能、性能、安全测试用例
|
||||
- 测试数据和测试报告
|
||||
- 自动化测试规范
|
||||
|
||||
**主要内容**:
|
||||
### 🚀 [部署文档](部署文档/)
|
||||
|
||||
- 环境配置文档
|
||||
- 容器化部署
|
||||
- 自动化部署
|
||||
- 监控和告警
|
||||
- 运维手册
|
||||
**保留并优化** - 指导项目的部署和运维
|
||||
|
||||
### ⚙️ [中间件配置](middleware/)
|
||||
- 环境配置(开发、测试、生产)
|
||||
- 容器化部署和 CI/CD 流水线
|
||||
- 基础设施和监控配置
|
||||
- 运维手册和故障排除
|
||||
|
||||
存放项目使用的各种中间件配置文档和最佳实践。
|
||||
### ⚙️ [中间件配置](中间件配置/)
|
||||
|
||||
**主要内容**:
|
||||
**保留并扩展** - 中间件配置文档和最佳实践
|
||||
|
||||
- 数据库配置(MySQL、Redis 等)
|
||||
- 消息中间件配置
|
||||
- 反向代理和负载均衡
|
||||
- Web 服务器和消息队列配置
|
||||
- 监控组件配置
|
||||
- 存储服务配置
|
||||
- SSL 证书和网络配置
|
||||
|
||||
### 📝 [变更管理](变更管理/)
|
||||
|
||||
**新增重要目录** - 完善的变更追踪体系
|
||||
|
||||
- 📝 [代码调整记录](变更管理/code-adjust-record.md)(已迁移)
|
||||
- 📊 需求变更记录
|
||||
- 🗄️ 数据库变更记录
|
||||
- 🔌 API 变更记录
|
||||
- 🚀 部署变更记录
|
||||
|
||||
### 📚 [知识库](知识库/)
|
||||
|
||||
**新增知识管理** - 积累项目经验和最佳实践
|
||||
|
||||
- 编码、安全、性能最佳实践
|
||||
- 项目回顾和技术决策记录
|
||||
- 外部资源和常见问题解答
|
||||
|
||||
### 📊 [报告文档](报告文档/)
|
||||
|
||||
**新增项目管理** - 定期的项目报告和质量报告
|
||||
|
||||
- 项目进度和里程碑报告
|
||||
- 代码质量和测试覆盖率报告
|
||||
- 发布说明和部署报告
|
||||
|
||||
## 🔧 技术栈概览
|
||||
|
||||
@@ -114,61 +140,90 @@
|
||||
|
||||
### 🚀 新手入门
|
||||
|
||||
1. **环境搭建**: [开发环境搭建指南](development/README.md#开发环境搭建)
|
||||
2. **项目启动**: [快速开始](development/README.md#快速开始)
|
||||
3. **开发规范**: [开发规范和指南](development/README.md#开发规范和指南)
|
||||
1. **环境搭建**: [开发环境搭建指南](开发文档/README.md#开发环境搭建)
|
||||
2. **项目启动**: [快速开始](开发文档/README.md#快速开始)
|
||||
3. **开发规范**: [开发规范和指南](开发文档/README.md#开发规范和指南)
|
||||
|
||||
### 💼 业务开发
|
||||
|
||||
1. **需求分析**: [需求文档](requirements/README.md)
|
||||
2. **数据库设计**: [数据库设计文档](design/README.md#数据库设计文档)
|
||||
3. **接口开发**: [API 接口设计](design/README.md#接口设计文档)
|
||||
4. **前端开发**: [前端开发指南](development/README.md#功能开发指南)
|
||||
1. **需求分析**: [需求文档](需求文档/README.md)
|
||||
2. **数据库设计**: [数据库设计文档](设计文档/README.md#数据库设计文档)
|
||||
3. **接口开发**: [API 接口设计](设计文档/README.md#接口设计文档)
|
||||
4. **前端开发**: [前端开发指南](开发文档/README.md#功能开发指南)
|
||||
|
||||
### 🎯 双重导航体系
|
||||
|
||||
### 📋 按项目阶段导航
|
||||
|
||||
**传统软件开发生命周期视图**
|
||||
|
||||
```
|
||||
需求分析 → 系统设计 → 开发实施 → 测试验证 → 部署上线
|
||||
需求文档 → 设计文档 → 开发文档 → 测试文档 → 部署文档
|
||||
```
|
||||
|
||||
### 📊 按业务模块导航
|
||||
|
||||
**业务领域驱动视图,便于 AI 理解业务上下文**
|
||||
|
||||
```
|
||||
用户管理 ← → 后勤满意度调查 ← → 报告厅预约 ← → 系统管理
|
||||
完整的模块文档:需求+设计+API+数据库+测试
|
||||
```
|
||||
|
||||
## 📖 快速导航指南
|
||||
|
||||
### 🚀 新手入门
|
||||
|
||||
1. **了解项目**:[项目总览](项目总览/README.md)
|
||||
2. **环境搭建**:[开发环境搭建](开发文档/README.md#环境搭建)
|
||||
3. **开发规范**:[编码规范](开发文档/README.md#编码规范)
|
||||
|
||||
### 💼 AI 辅助开发
|
||||
|
||||
1. **业务理解**:查看 [业务模块文档](业务模块/) 了解完整业务上下文
|
||||
2. **接口开发**:参考 [API 文档](开发文档/API.md) 和模块 API 设计
|
||||
3. **代码生成**:使用模块的 database.md 和 api.md 生成代码
|
||||
4. **变更记录**:在 [变更管理](变更管理/) 中记录所有调整
|
||||
|
||||
### 🔧 运维部署
|
||||
|
||||
1. **部署方案**: [部署文档](deployment/README.md)
|
||||
2. **环境配置**: [中间件配置](middleware/README.md)
|
||||
3. **监控告警**: [监控配置](deployment/README.md#监控和告警)
|
||||
1. **部署方案**:[部署文档](部署文档/README.md)
|
||||
2. **环境配置**:[中间件配置](中间件配置/README.md)
|
||||
3. **监控告警**:[监控配置](部署文档/README.md#监控配置)
|
||||
|
||||
### 🧪 质量保证
|
||||
|
||||
1. **测试规范**: [测试文档](testing/README.md)
|
||||
2. **代码质量**: [开发规范](development/README.md#开发规范和指南)
|
||||
3. **性能优化**: [性能优化指南](development/README.md#性能优化指南)
|
||||
1. **测试规范**:[测试文档](测试文档/README.md)
|
||||
2. **代码质量**:[开发规范](开发文档/README.md#编码规范)
|
||||
3. **变更追踪**:[变更管理](变更管理/README.md)
|
||||
|
||||
## 📋 重要规范
|
||||
## 📋 重要开发规范
|
||||
|
||||
### 🔴 强制性要求
|
||||
|
||||
- **API 变更必须同步更新文档**:任何 API 接口的新增、修改、删除都必须立即更新 `开发文档/API.md`
|
||||
- **代码调整必须记录**:每次代码变更都必须在 `变更管理/code-adjust-record.md` 中记录
|
||||
- **模块文档必须维护**:业务模块的变更必须同步更新对应模块文档
|
||||
|
||||
### 🔒 安全规范
|
||||
|
||||
- 所有接口必须进行权限校验
|
||||
- 所有接口必须进行权限校验(Sa-Token)
|
||||
- 敏感数据必须加密存储
|
||||
- 生产环境密码定期更换
|
||||
- API 接口启用加解密传输
|
||||
- 遵循多租户数据隔离规范
|
||||
|
||||
### 📊 数据库规范
|
||||
|
||||
- 使用雪花 ID 作为主键
|
||||
- 使用雪花 ID 作为主键(ASSIGN_ID)
|
||||
- 所有业务表包含基础字段(id、tenant_id、create_by 等)
|
||||
- 多租户字段必须建索引
|
||||
- 遵循命名规范(下划线命名法)
|
||||
- 遵循下划线命名法
|
||||
|
||||
### 🌐 接口规范
|
||||
|
||||
- 遵循 RESTful API 设计原则
|
||||
- 统一响应格式(code、msg、data)
|
||||
- 使用 SpringDoc 自动生成文档
|
||||
- 完整的参数校验和异常处理
|
||||
|
||||
### 🔄 代码变更规则
|
||||
|
||||
**每次代码调整必须同步更新以下文档**:
|
||||
|
||||
- API 文档:接口变更时更新 OpenAPI 文档
|
||||
- 数据库文档:表结构变更时更新 DDL 和文档
|
||||
- 配置文档:配置项变更时更新配置说明
|
||||
- 部署文档:部署流程变更时更新部署手册
|
||||
|
||||
## 📞 技术支持
|
||||
|
||||
### 🔗 官方资源
|
||||
|
||||
Reference in new issue
Block a user