all-project/docs

高校智慧校园管理系统文档中心

📋 文档概述

本文档中心采用混合组织方式，既支持按项目阶段的全过程管理，又提供按业务模块的聚合视图，完整记录从项目需求到交付的全生命周期文档，同时为 Cursor AI 辅助开发提供完整的业务上下文。

🎯 文档组织理念

• 全过程管理：涵盖需求分析、系统设计、开发指南、测试规范、部署运维等各个阶段
• AI 辅助开发：便于 Cursor AI 快速理解业务上下文和技术细节
• 模块化管理：同一业务模块的文档聚合，便于查找和维护
• 变更追踪：完善的变更记录和版本管理体系

🏗️ 核心文档目录

📋 项目总览

新增核心目录 - 项目整体信息一目了然

• 项目基本信息和技术架构
• 团队组织和开发分工
• 项目时间线和目标 KPI
• 开发工具链和协作规范

📊 业务模块文档

新增核心目录 - 按业务模块聚合，为 AI 辅助开发提供完整上下文

• 🔐 用户管理模块
• 📊 后勤满意度调查模块
• 🏛️ 报告厅预约模块
• ⚙️ 系统管理模块

每个模块包含：requirements.md、design.md、api.md、database.md、test-cases.md

🎯 需求文档

保留并优化 - 项目需求相关文档，明确项目功能和业务规则

🏗️ 设计文档

保留并优化 - 系统架构、数据库设计、接口设计等

• 系统架构设计和技术选型
• 数据库设计文档（含现有的 hzdyjs_xg.sql）
• API 接口设计规范
• UI 设计和安全设计文档

💻 开发文档

保留并优化 - 为开发人员和 AI 辅助提供详细开发指南

• 开发环境搭建和 IDE 配置
• 编码规范和 Git 工作流
• 完整 API 文档（开发文档/API.md）
• 代码模板和集成指南

🧪 测试文档

保留并优化 - 确保项目质量和稳定性

• 测试策略和测试计划
• 功能、性能、安全测试用例
• 测试数据和测试报告
• 自动化测试规范

🚀 部署文档

保留并优化 - 指导项目的部署和运维

• 环境配置（开发、测试、生产）
• 容器化部署和 CI/CD 流水线
• 基础设施和监控配置
• 运维手册和故障排除

⚙️ 中间件配置

保留并扩展 - 中间件配置文档和最佳实践

• 数据库配置（MySQL、Redis 等）
• Web 服务器和消息队列配置
• 监控组件配置
• SSL 证书和网络配置

📝 变更管理

新增重要目录 - 完善的变更追踪体系

• 📝 代码调整记录（已迁移）
• 📊 需求变更记录
• 🗄️ 数据库变更记录
• 🔌 API 变更记录
• 🚀 部署变更记录

📚 知识库

新增知识管理 - 积累项目经验和最佳实践

• 编码、安全、性能最佳实践
• 项目回顾和技术决策记录
• 外部资源和常见问题解答

📊 报告文档

新增项目管理 - 定期的项目报告和质量报告

• 项目进度和里程碑报告
• 代码质量和测试覆盖率报告
• 发布说明和部署报告

🔧 技术栈概览

后端技术栈

• 框架: Spring Boot 3.4.6
• Java: JDK 17/21
• ORM: MyBatis-Plus 3.5.12
• 权限: Sa-Token 1.42.0 + JWT
• 缓存: Redis + Redisson 3.45.1
• 数据库: MySQL/Oracle/PostgreSQL/SQLServer
• 任务调度: SnailJob 1.5.0
• 工作流: Warm-Flow 1.7.3

前端技术栈

• 框架: Vue 3 + TypeScript
• UI 组件: Element Plus
• 构建工具: Vite
• 状态管理: Pinia

部署技术栈

• 容器化: Docker + Docker Compose
• 编排: Kubernetes
• 反向代理: Nginx
• 监控: Prometheus + Grafana
• 日志: ELK Stack

📖 快速导航

🚀 新手入门

1. 环境搭建: 开发环境搭建指南
2. 项目启动: 快速开始
3. 开发规范: 开发规范和指南

💼 业务开发

1. 需求分析: 需求文档
2. 数据库设计: 数据库设计文档
3. 接口开发: API 接口设计
4. 前端开发: 前端开发指南

🎯 双重导航体系

📋 按项目阶段导航

传统软件开发生命周期视图

需求分析 → 系统设计 → 开发实施 → 测试验证 → 部署上线
需求文档 → 设计文档 → 开发文档 → 测试文档 → 部署文档

📊 按业务模块导航

业务领域驱动视图，便于 AI 理解业务上下文

用户管理 ← → 后勤满意度调查 ← → 报告厅预约 ← → 系统管理
完整的模块文档：需求+设计+API+数据库+测试

📖 快速导航指南

🚀 新手入门

1. 了解项目：项目总览
2. 环境搭建：开发环境搭建
3. 开发规范：编码规范

💼 AI 辅助开发

1. 业务理解：查看 业务模块文档 了解完整业务上下文
2. 接口开发：参考 API 文档 和模块 API 设计
3. 代码生成：使用模块的 database.md 和 api.md 生成代码
4. 变更记录：在 变更管理 中记录所有调整

🔧 运维部署

1. 部署方案：部署文档
2. 环境配置：中间件配置
3. 监控告警：监控配置

🧪 质量保证

1. 测试规范：测试文档
2. 代码质量：开发规范
3. 变更追踪：变更管理

📋 重要开发规范

🔴 强制性要求

• API 变更必须同步更新文档：任何 API 接口的新增、修改、删除都必须立即更新 开发文档/API.md
• 代码调整必须记录：每次代码变更都必须在 变更管理/code-adjust-record.md 中记录
• 模块文档必须维护：业务模块的变更必须同步更新对应模块文档

🔒 安全规范

• 所有接口必须进行权限校验（Sa-Token）
• 敏感数据必须加密存储
• 遵循多租户数据隔离规范

📊 数据库规范

• 使用雪花 ID 作为主键（ASSIGN_ID）
• 所有业务表包含基础字段（id、tenant_id、create_by 等）
• 遵循下划线命名法

🌐 接口规范

• 遵循 RESTful API 设计原则
• 统一响应格式（code、msg、data）
• 完整的参数校验和异常处理

📞 技术支持

🔗 官方资源

• 官方文档: https://plus-doc.dromara.org
• 源码仓库: https://gitee.com/dromara/RuoYi-Vue-Plus
• 问题反馈: https://gitee.com/dromara/RuoYi-Vue-Plus/issues

📝 文档贡献

• 发现文档错误或缺失，请及时更新
• 新功能开发完成后，必须更新相关文档
• 重要经验和最佳实践，建议添加到相应文档中

📈 文档维护

• 文档版本与代码版本保持同步
• 定期 review 文档内容的准确性
• 过期文档及时标记或删除

🎯 版本信息

• 项目版本: RuoYi-Vue-Plus 5.4.0
• 文档版本: v1.0
• 最后更新: 2025 年 1 月
• 维护团队: 技术开发团队

---

注意: 本文档中心会随着项目的发展持续更新，请及时关注最新版本。如有任何问题或建议，欢迎通过 Issue 或技术群进行反馈。