优化cursor使用形式,增加项目文档过程管理,方便cursor生成代码
This commit is contained in:
1 parent
2f7e1a9c16
commit
65d2d71469
36 files changed
+8872
-1530
No files matched your search
+409
-199
@@ -12,182 +12,355 @@
|
||||
|
||||
## 1. 文档结构管理 (docs/)
|
||||
|
||||
### 文档目录组织
|
||||
### 🔴 文档目录组织(中文化架构)
|
||||
```
|
||||
docs/
|
||||
├── requirements/ # 需求文档
|
||||
│ ├── README.md # 需求管理说明
|
||||
│ └── [功能模块]/ # 具体功能需求文档
|
||||
├── design/ # 设计文档
|
||||
│ ├── README.md # 设计文档说明
|
||||
│ ├── database/ # 数据库设计
|
||||
│ │ ├── hzdyjs_xg.sql # 完整数据库模型
|
||||
│ │ ├── database_msg.md # 环境配置信息
|
||||
│ │ └── README.md # 数据库设计说明
|
||||
│ └── [模块设计]/ # 其他设计文档
|
||||
├── development/ # 开发文档
|
||||
│ ├── README.md # 开发指南
|
||||
│ └── API.md # API接口文档(完整的后端接口说明)
|
||||
├── testing/ # 测试文档
|
||||
│ └── README.md # 测试计划和用例
|
||||
├── deployment/ # 部署文档
|
||||
│ └── README.md # 部署指南
|
||||
├── middleware/ # 中间件配置文档
|
||||
│ ├── mysql-config.md # MySQL配置文档
|
||||
│ └── README.md # 中间件配置说明
|
||||
└── code-adjust-record.md # 代码调整记录
|
||||
├── 项目总览/ # 项目基本信息和架构概览
|
||||
│ ├── README.md # 项目总览主文档
|
||||
│ └── 项目总览模板.md # 项目总览标准模板
|
||||
├── 业务模块/ # 业务模块文档(为AI提供业务上下文)
|
||||
│ ├── README.md # 业务模块管理总览
|
||||
│ ├── 业务模块开发模板.md # 业务模块标准开发模板
|
||||
│ ├── hq-satisfaction-survey/ # 后勤满意度调查模块
|
||||
│ ├── hall-reservation/ # 报告厅预约模块
|
||||
│ ├── system-management/ # 系统管理模块
|
||||
│ └── user-management/ # 用户管理模块
|
||||
├── 变更管理/ # 变更管理中心
|
||||
│ ├── README.md # 变更管理流程和规范
|
||||
│ └── code-adjust-record.md # 代码调整记录
|
||||
├── 开发文档/ # 开发指南和技术规范
|
||||
│ ├── README.md # 开发文档总览
|
||||
│ ├── API.md # API接口完整文档
|
||||
│ └── API文档模板.md # API文档标准模板
|
||||
├── 设计文档/ # 设计文档
|
||||
│ ├── README.md # 设计文档说明
|
||||
│ └── database/ # 数据库设计
|
||||
│ ├── hzdyjs_xg.sql # 完整数据库模型
|
||||
│ ├── 01-workflow-module.sql # 工作流模块SQL
|
||||
│ ├── 02-code-generator-module.sql # 代码生成模块SQL
|
||||
│ ├── 03-logistics-module.sql # 后勤管理模块SQL
|
||||
│ ├── 04-job-scheduler-module.sql # 任务调度模块SQL
|
||||
│ ├── 05-system-management-module.sql # 系统管理模块SQL
|
||||
│ ├── 06-test-module.sql # 测试模块SQL
|
||||
│ ├── SQL文件说明.md # SQL文件拆分说明
|
||||
│ ├── mysql-database-standard.md # MySQL数据库建设规范
|
||||
│ ├── database_msg.md # 环境配置信息
|
||||
│ └── README.md # 数据库设计说明
|
||||
├── 需求文档/ # 需求文档
|
||||
│ ├── README.md # 需求管理说明
|
||||
│ ├── 后勤报告厅预约需求/ # 报告厅预约系统需求
|
||||
│ └── 后勤满意度调查需求/ # 满意度调查系统需求
|
||||
├── 测试文档/ # 测试文档
|
||||
│ └── README.md # 测试计划和用例
|
||||
├── 部署文档/ # 部署文档
|
||||
│ └── README.md # 部署指南
|
||||
├── 中间件配置/ # 中间件配置文档
|
||||
│ ├── README.md # 中间件配置说明
|
||||
│ └── mysql-config.md # MySQL配置文档
|
||||
├── 知识库/ # 知识库
|
||||
├── 报告文档/ # 报告文档
|
||||
├── structure-optimization-plan.md # 文档结构优化方案
|
||||
└── README.md # 文档体系总说明
|
||||
```
|
||||
|
||||
## 2. 代码调整记录管理
|
||||
### 🔴 重要文档说明
|
||||
- **工程本地启动指导.md** (项目根目录):包含完整的环境配置和启动指南
|
||||
- **技术要求更新**:Node.js 20.15.x+, npm 10.7.x+
|
||||
- **数据库环境**:支持本地安装或使用阿里云测试环境
|
||||
- **前端访问地址**:http://localhost (非3000端口)
|
||||
|
||||
### 📝 重要提醒:代码调整记录要求
|
||||
## 2. 🚨 强制性文档同步更新规则
|
||||
|
||||
**每次使用Cursor修改任何代码时,都必须在 `docs/code-adjust-record.md` 文件中记录调整信息。**
|
||||
### 📋 核心原则:代码与文档必须同步更新
|
||||
**⚠️ 超级重要:每次使用Cursor AI进行代码调整后,必须立即同步更新相应的项目文档!**
|
||||
|
||||
### 记录格式标准
|
||||
每次调整后请按以下格式记录:
|
||||
### 🔴 强制更新触发条件
|
||||
每次代码调整必须检查并更新以下文档:
|
||||
|
||||
#### 后端代码调整时的强制文档更新:
|
||||
- **✅ API接口变更**:
|
||||
- 必须立即更新 `docs/开发文档/API.md`
|
||||
- 新增接口:添加完整接口文档(地址、参数、响应、权限、示例)
|
||||
- 修改接口:更新参数说明、响应格式、错误码
|
||||
- 删除接口:标记为已废弃,说明替代方案
|
||||
- 权限变更:更新权限要求说明
|
||||
|
||||
- **✅ 数据库变更**:
|
||||
- 更新 `docs/设计文档/database/` 下的相关文档
|
||||
- 新增表:添加表结构说明和字段注释
|
||||
- 修改表:更新字段变更和索引调整
|
||||
- 数据迁移:记录迁移脚本和注意事项
|
||||
|
||||
- **✅ 业务逻辑变更**:
|
||||
- 更新对应 `docs/业务模块/[模块名称]/` 下的业务文档
|
||||
- 更新业务流程图和业务规则说明
|
||||
- 修改用户故事和功能需求
|
||||
|
||||
- **✅ 配置变更**:
|
||||
- 更新 `docs/中间件配置/` 下的配置文档
|
||||
- 更新 `docs/部署文档/` 下的部署说明
|
||||
|
||||
#### 前端代码调整时的强制文档更新:
|
||||
- **✅ 页面功能变更**:
|
||||
- 更新对应业务模块的用户操作文档
|
||||
- 更新UI设计规范文档
|
||||
|
||||
- **✅ API调用变更**:
|
||||
- 检查前端API调用是否与后端API文档一致
|
||||
- 更新API对接说明文档
|
||||
|
||||
- **✅ 组件变更**:
|
||||
- 更新组件使用说明和属性文档
|
||||
|
||||
#### 移动端代码调整时的强制文档更新:
|
||||
- **✅ 功能变更**:更新移动端功能说明文档
|
||||
- **✅ API对接变更**:更新移动端API调用文档
|
||||
- **✅ 用户流程变更**:更新用户操作指南
|
||||
|
||||
#### 📚 docs文档变更时的强制同步更新规则:
|
||||
**⚠️ 超级重要:每当docs/目录下的文档结构或重要内容发生变更时,必须立即同步更新.cursorrules文件!**
|
||||
|
||||
- **🔴 文档结构变更**:
|
||||
- 新增/删除目录:同步更新.cursorrules中的"文档目录组织"章节
|
||||
- 重命名目录:更新所有相关路径引用
|
||||
- 调整文档层级:更新文档结构说明
|
||||
|
||||
- **🔴 重要文档变更**:
|
||||
- 新增标准模板:在"文档模板体系"中添加说明
|
||||
- 更新开发规范:同步调整.cursorrules中对应的规范要求
|
||||
- 修改工作流程:更新"文档更新标准工作流程"
|
||||
|
||||
- **🔴 技术环境变更**:
|
||||
- 环境要求调整:更新.cursorrules中的技术栈规范
|
||||
- 配置信息变更:同步更新相关配置说明
|
||||
- 启动流程调整:更新开发指导相关内容
|
||||
|
||||
- **🔴 业务模块变更**:
|
||||
- 新增业务模块:在.cursorrules中添加模块说明
|
||||
- 模块架构调整:更新业务模块文档管理规范
|
||||
- API接口变更:确保.cursorrules中的API规范同步
|
||||
|
||||
**强制检查清单**:
|
||||
- [ ] .cursorrules中的文档目录结构是否与实际一致
|
||||
- [ ] 重要文档路径引用是否全部更新
|
||||
- [ ] 新增的开发规范是否已同步到.cursorrules
|
||||
- [ ] 技术要求和环境配置是否保持一致
|
||||
|
||||
### 🔄 文档更新标准工作流程
|
||||
|
||||
#### Cursor AI 辅助开发的文档更新流程:
|
||||
```
|
||||
1. **AI代码生成/修改完成**
|
||||
↓
|
||||
2. **立即检查文档更新需求**
|
||||
- 是否涉及API变更?
|
||||
- 是否涉及数据库变更?
|
||||
- 是否涉及业务逻辑变更?
|
||||
- 是否涉及配置变更?
|
||||
- 是否涉及docs文档结构变更?
|
||||
↓
|
||||
3. **立即更新相关文档**(不得延后!)
|
||||
- 使用标准模板格式
|
||||
- 确保信息准确完整
|
||||
- 添加真实示例
|
||||
↓
|
||||
4. **检查并更新.cursorrules文件**(重要!)
|
||||
- 如有docs文档结构变更,同步更新.cursorrules
|
||||
- 如有技术要求变更,同步更新技术栈规范
|
||||
- 如有开发流程变更,同步更新工作流程
|
||||
↓
|
||||
5. **记录变更日志**
|
||||
- 在 `docs/变更管理/code-adjust-record.md` 中记录
|
||||
- 标注已同步更新的文档列表
|
||||
- 标注是否已更新.cursorrules文件
|
||||
↓
|
||||
6. **验证文档准确性**
|
||||
- 确保文档与实际代码一致
|
||||
- 验证示例可以正常运行
|
||||
- 验证.cursorrules与实际项目状态一致
|
||||
↓
|
||||
7. **提交代码和文档变更**
|
||||
```
|
||||
|
||||
### 📝 变更记录标准格式
|
||||
|
||||
**每次代码调整都必须在 `docs/变更管理/code-adjust-record.md` 中按以下格式记录:**
|
||||
|
||||
```markdown
|
||||
## 调整记录 - YYYY-MM-DD HH:mm:ss
|
||||
|
||||
**调整时间**: YYYY-MM-DD HH:mm:ss
|
||||
**调整人**: [开发者姓名/Cursor AI辅助]
|
||||
**调整目的**: [简述调整原因和目标]
|
||||
**涉及文件**:
|
||||
- [具体的文件路径]
|
||||
**变更ID**: CHG-YYYYMMDD-001
|
||||
**变更时间**: YYYY-MM-DD HH:mm:ss
|
||||
**变更人员**: [开发者姓名/Cursor AI辅助]
|
||||
**变更类型**: 🆕新功能/🐛Bug修复/🔧重构优化/📚文档更新/⚙️配置调整
|
||||
**影响级别**: 🔴重大变更/🟡中等变更/🟢小变更
|
||||
|
||||
**调整内容详述**:
|
||||
1. 具体调整了哪些代码
|
||||
2. 修改了哪些功能
|
||||
3. 优化了哪些性能
|
||||
4. 修复了哪些问题
|
||||
### 📋 变更概述
|
||||
**变更目的**: [简述变更原因和目标,1-2句话]
|
||||
**影响范围**: [列出受影响的模块、功能或文件]
|
||||
|
||||
**技术细节**:
|
||||
- 使用的技术栈: [技术栈信息]
|
||||
- 遵循的设计规范: [设计规范]
|
||||
- 其他重要技术决策
|
||||
### 📁 涉及文件
|
||||
**后端文件**:
|
||||
- backend/[具体文件路径1]
|
||||
- backend/[具体文件路径2]
|
||||
|
||||
**测试验证**:
|
||||
- [ ] 功能测试通过
|
||||
- [ ] 代码规范检查通过
|
||||
- [ ] 类型检查通过
|
||||
- [ ] 兼容性测试通过
|
||||
**前端文件**:
|
||||
- web/[具体文件路径1]
|
||||
- web/[具体文件路径2]
|
||||
|
||||
**备注**: 其他需要说明的内容
|
||||
**配置文件**:
|
||||
- [配置文件路径]
|
||||
|
||||
### 🔧 变更内容详述
|
||||
**业务逻辑变更**:
|
||||
1. [具体业务逻辑的变更说明]
|
||||
2. [新增或修改的业务规则]
|
||||
|
||||
**技术实现变更**:
|
||||
1. [技术方案的调整说明]
|
||||
2. [代码结构的优化内容]
|
||||
|
||||
**接口变更**:
|
||||
- **新增接口**: [新增接口列表]
|
||||
- **修改接口**: [修改的接口及变更内容]
|
||||
- **废弃接口**: [废弃的接口及替代方案]
|
||||
|
||||
**数据库变更**:
|
||||
- **新增表**: [新增表及字段说明]
|
||||
- **修改表**: [表结构变更内容]
|
||||
- **数据迁移**: [数据迁移脚本或说明]
|
||||
|
||||
### 📖 文档同步更新记录
|
||||
**API文档**:
|
||||
- [ ] ✅ 已更新 docs/开发文档/API.md
|
||||
- [ ] ✅ 已更新模块API接口设计文档
|
||||
|
||||
**业务文档**:
|
||||
- [ ] ✅ 已更新业务模块文档
|
||||
- [ ] ✅ 已更新用户操作手册
|
||||
|
||||
**技术文档**:
|
||||
- [ ] ✅ 已更新数据库设计文档
|
||||
- [ ] ✅ 已更新架构设计文档
|
||||
|
||||
**其他文档**:
|
||||
- [ ] ✅ 已更新部署文档
|
||||
- [ ] ✅ 已更新配置文档
|
||||
|
||||
**规范文件**:
|
||||
- [ ] ✅ 已检查并同步更新.cursorrules文件
|
||||
- [ ] ✅ 已确认文档结构与.cursorrules一致
|
||||
|
||||
### 🧪 测试验证
|
||||
**功能测试**:
|
||||
- [ ] 单元测试通过
|
||||
- [ ] 集成测试通过
|
||||
- [ ] 功能验收测试通过
|
||||
|
||||
**文档验证**:
|
||||
- [ ] 文档内容与代码实现一致
|
||||
- [ ] 示例代码可以正常运行
|
||||
- [ ] 接口文档已验证准确性
|
||||
|
||||
### 📝 备注
|
||||
**已知问题**: [如有已知问题需要说明]
|
||||
**后续计划**: [后续的改进或扩展计划]
|
||||
**相关链接**: [相关的Issue、PR或文档链接]
|
||||
|
||||
---
|
||||
```
|
||||
|
||||
### 记录要求
|
||||
1. **及时性**: 每次代码调整完成后立即记录
|
||||
2. **完整性**: 包含所有必要信息字段
|
||||
3. **准确性**: 详细描述实际的调整内容
|
||||
4. **可追溯性**: 便于后续查看和维护
|
||||
## 3. 🔧 业务模块文档管理(为Cursor AI提供完整上下文)
|
||||
|
||||
### ⚠️ 强制要求
|
||||
**所有通过Cursor AI进行的代码调整都必须在 `docs/code-adjust-record.md` 中留下记录,这是项目管理的强制性要求。**
|
||||
### 业务模块文档标准结构
|
||||
每个业务模块都必须包含以下完整文档:
|
||||
|
||||
### 🔴 特别强调:API接口变更的强制性文档更新规则
|
||||
```
|
||||
业务模块/[模块名称]/
|
||||
├── README.md # 模块总览
|
||||
├── 需求分析/
|
||||
│ ├── 业务需求说明.md # 详细业务需求
|
||||
│ ├── 功能需求清单.md # 功能点清单
|
||||
│ ├── 非功能需求.md # 性能、安全要求
|
||||
│ └── 用户故事.md # 用户使用场景
|
||||
├── 技术设计/
|
||||
│ ├── 数据库设计.md # 表结构设计
|
||||
│ ├── API接口设计.md # 接口定义
|
||||
│ ├── 架构设计.md # 模块架构
|
||||
│ └── 技术选型.md # 技术决策说明
|
||||
├── 实现文档/
|
||||
│ ├── 后端实现说明.md # 后端代码结构
|
||||
│ ├── 前端实现说明.md # 前端代码结构
|
||||
│ ├── 关键业务逻辑.md # 核心算法逻辑
|
||||
│ └── 代码规范.md # 编码规范
|
||||
├── 测试文档/
|
||||
│ ├── 测试计划.md # 测试策略
|
||||
│ ├── 测试用例.md # 具体测试用例
|
||||
│ └── 测试报告.md # 测试结果
|
||||
└── 运维文档/
|
||||
├── 部署指南.md # 部署步骤
|
||||
├── 监控配置.md # 监控指标
|
||||
└── 故障处理.md # 常见问题
|
||||
```
|
||||
|
||||
**⚠️ 超级重要:任何API接口的新增、修改、删除操作都必须立即同步更新 `docs/development/API.md` 文档!**
|
||||
### 🤖 Cursor AI 开发提示词模板
|
||||
|
||||
#### API变更必须执行的步骤:
|
||||
1. **代码修改完成** → 2. **立即更新API.md文档** → 3. **记录代码调整日志** → 4. **验证文档准确性**
|
||||
#### 新功能开发提示词:
|
||||
```
|
||||
基于以下业务模块文档为 [功能名称] 开发代码:
|
||||
|
||||
#### API接口变更涉及的文档更新:
|
||||
- ✅ **新增API接口**:在API.md中添加完整的接口文档(地址、参数、响应、权限等)
|
||||
- ✅ **修改API接口**:更新API.md中对应接口的参数、响应格式、权限要求
|
||||
- ✅ **删除API接口**:在API.md中标记接口为已废弃,说明替代方案
|
||||
- ✅ **修改响应格式**:更新API.md中的响应示例和字段说明
|
||||
- ✅ **修改权限要求**:更新API.md中的权限要求说明
|
||||
业务上下文:docs/业务模块/[模块名称]/需求分析/
|
||||
技术规范:docs/业务模块/[模块名称]/技术设计/
|
||||
代码结构:docs/业务模块/[模块名称]/实现文档/
|
||||
API规范:docs/开发文档/API.md
|
||||
|
||||
## 3. 文档同步更新规则
|
||||
请确保:
|
||||
1. 遵循项目编码规范
|
||||
2. 使用标准的代码结构
|
||||
3. 添加完整的注释
|
||||
4. 生成单元测试代码
|
||||
5. 立即更新相关文档
|
||||
|
||||
### 📋 核心原则:代码与文档同步更新
|
||||
**⚠️ 重要规则:每次代码调整完成后,必须同步更新相应的项目文档,确保项目文档永远保持最新状态。**
|
||||
开发完成后请同步更新:
|
||||
- docs/开发文档/API.md(如涉及API)
|
||||
- docs/业务模块/[模块名称]/相关文档
|
||||
- docs/变更管理/code-adjust-record.md
|
||||
```
|
||||
|
||||
### 强制更新规则
|
||||
每次代码调整必须同步更新相关文档:
|
||||
- **API文档**: 接口变更时更新 `docs/development/API.md` 中的相关接口信息
|
||||
- **数据库文档**: 表结构变更时更新 `docs/design/database/` 下的所有相关文档
|
||||
- **配置文档**: 配置项变更时更新 `docs/middleware/` 下的配置说明
|
||||
- **部署文档**: 部署流程变更时更新 `docs/deployment/` 下的部署手册
|
||||
- **功能文档**: 新增功能时更新 `docs/requirements/` 下的需求文档
|
||||
- **设计文档**: 架构变更时更新 `docs/design/` 下的设计文档
|
||||
#### 文档更新提示词:
|
||||
```
|
||||
根据刚才的代码变更,请更新以下文档:
|
||||
|
||||
### 📝 文档同步更新清单
|
||||
每次代码调整后,请检查以下文档是否需要更新:
|
||||
变更内容:[具体变更说明]
|
||||
影响模块:[模块名称]
|
||||
|
||||
#### 前端代码调整时需更新的文档:
|
||||
- [ ] **组件文档**: 新增或修改组件时,更新组件使用说明
|
||||
- [ ] **页面功能文档**: 页面功能变更时,更新用户操作手册
|
||||
- [ ] **API对接文档**: 前端API调用变更时,更新接口对接说明
|
||||
- [ ] **UI设计文档**: 界面样式重大变更时,更新设计规范文档
|
||||
需要更新的文档:
|
||||
1. docs/开发文档/API.md - [具体更新内容]
|
||||
2. docs/业务模块/[模块名称]/[具体文档] - [具体更新内容]
|
||||
3. docs/设计文档/database/ - [如涉及数据库变更]
|
||||
|
||||
#### 后端代码调整时需更新的文档:
|
||||
- [ ] **API接口文档**: API接口变更时,必须更新 `docs/development/API.md` 中的相关接口信息,包括:
|
||||
- 新增接口:添加完整的接口说明、参数、响应示例
|
||||
- 修改接口:更新参数说明、响应格式、错误码
|
||||
- 删除接口:在文档中标记为已废弃,并说明替代方案
|
||||
- 权限变更:更新权限要求说明
|
||||
- [ ] **数据库文档**: 表结构变更时,更新数据库设计文档
|
||||
- [ ] **业务逻辑文档**: 业务规则变更时,更新业务流程文档
|
||||
- [ ] **配置文档**: 系统配置变更时,更新配置说明文档
|
||||
请使用标准的文档模板格式,确保信息准确完整。
|
||||
```
|
||||
|
||||
#### 移动端代码调整时需更新的文档:
|
||||
- [ ] **功能文档**: 移动端功能变更时,更新功能说明文档
|
||||
- [ ] **API对接文档**: 移动端API调用变更时,更新接口对接说明
|
||||
- [ ] **用户手册**: 用户操作流程变更时,更新操作指南
|
||||
## 4. 📚 API文档管理规范
|
||||
|
||||
### 🔄 文档更新工作流程
|
||||
|
||||
#### 标准流程:
|
||||
1. **代码调整完成** → 2. **立即更新相关文档** → 3. **记录代码调整日志** → 4. **验证文档完整性**
|
||||
|
||||
#### 🔴 API接口变更的特殊流程(强制性):
|
||||
1. **API代码开发完成**
|
||||
2. **立即更新 `docs/development/API.md`** (不得延后)
|
||||
3. **记录代码调整日志,标注API文档已更新**
|
||||
4. **验证API文档与实际接口的一致性**
|
||||
5. **提交代码和文档变更**
|
||||
|
||||
#### ⚠️ 重要原则:
|
||||
- **API变更 = 必须更新API.md文档**
|
||||
- **文档更新 = 代码开发的一部分,不是可选项**
|
||||
- **未更新文档 = 开发任务未完成**
|
||||
|
||||
### 版本管理
|
||||
- **文档版本**: 与代码版本保持同步
|
||||
- **变更记录**: 每次变更都要记录变更内容和原因
|
||||
- **向后兼容**: 接口变更需要考虑向后兼容性
|
||||
|
||||
## 4. API文档管理规范 (docs/development/API.md)
|
||||
|
||||
### 📄 API文档维护原则
|
||||
**⚠️ 重要规则:任何后端API接口的新增、修改、删除都必须同步更新 `docs/development/API.md` 文档。**
|
||||
|
||||
### API文档更新时机
|
||||
- **新增Controller**: 添加新的Controller时,必须在API.md中添加对应的接口说明
|
||||
- **新增接口方法**: 在现有Controller中添加新方法时,更新对应模块的接口列表
|
||||
- **修改接口参数**: 接口请求或响应参数变更时,更新参数说明表格
|
||||
- **修改权限要求**: 接口权限变更时,更新权限要求说明
|
||||
- **修改响应格式**: 响应数据结构变更时,更新响应示例
|
||||
- **接口废弃**: 接口不再使用时,在文档中标记为已废弃并说明替代方案
|
||||
### 🔴 强制性API文档更新规则
|
||||
**⚠️ 超级重要:任何API接口的新增、修改、删除都必须立即同步更新 `docs/开发文档/API.md` 文档!**
|
||||
|
||||
### API文档标准格式
|
||||
每个接口都必须包含以下信息:
|
||||
使用 `docs/开发文档/API文档模板.md` 中的标准格式:
|
||||
|
||||
```markdown
|
||||
#### 接口标题
|
||||
|
||||
**接口地址**: `HTTP方法 /接口路径`
|
||||
#### 接口名称
|
||||
|
||||
**接口地址**: `HTTP方法 /api/路径`
|
||||
**接口描述**: 接口功能的详细描述
|
||||
|
||||
**权限要求**: 权限代码或"需要登录"
|
||||
|
||||
**请求参数**:
|
||||
| 参数名 | 类型 | 必填 | 说明 |
|
||||
|--------|------|------|------|
|
||||
| 参数名 | 类型 | 必填 | 说明 | 示例值 |
|
||||
|--------|------|------|------|--------|
|
||||
| param1 | String | Y | 参数说明 | "example" |
|
||||
|
||||
**响应示例**:
|
||||
```json
|
||||
@@ -198,28 +371,21 @@ docs/
|
||||
}
|
||||
```
|
||||
|
||||
### API文档分类规范
|
||||
- **按业务模块分类**: 问卷管理、答题管理、题目管理等
|
||||
- **按功能分组**: 基础CRUD操作、业务逻辑操作、状态查询等
|
||||
- **统一命名规范**: 接口名称要与Controller方法名保持一致
|
||||
**错误码**:
|
||||
| 错误码 | 说明 | 解决方案 |
|
||||
|--------|------|----------|
|
||||
| 400001 | 参数错误 | 检查请求参数 |
|
||||
```
|
||||
|
||||
### API文档版本控制
|
||||
- **版本记录**: 在API.md底部维护版本更新记录
|
||||
- **变更说明**: 每次更新都要记录具体的变更内容
|
||||
- **兼容性说明**: 重大变更需要说明向后兼容性影响
|
||||
### 🚨 API变更强制检查清单
|
||||
|
||||
### ⚠️ 强制执行规则
|
||||
**所有通过Cursor AI进行的后端API开发都必须同时更新API文档,这是代码审查的强制性检查项。**
|
||||
|
||||
### 🚨 API文档更新检查清单
|
||||
|
||||
#### 当进行以下操作时,必须更新 `docs/development/API.md`:
|
||||
当进行以下操作时,必须更新 `docs/开发文档/API.md`:
|
||||
|
||||
**Controller层变更**:
|
||||
- [ ] 新增Controller类 → 在API.md中添加新的模块章节
|
||||
- [ ] 新增@RequestMapping方法 → 添加完整的接口文档
|
||||
- [ ] 修改@RequestMapping路径 → 更新接口地址
|
||||
- [ ] 修改HTTP方法(GET/POST/PUT/DELETE) → 更新接口方法
|
||||
- [ ] 修改HTTP方法 → 更新接口方法
|
||||
- [ ] 删除接口方法 → 标记为已废弃并说明替代方案
|
||||
|
||||
**参数和响应变更**:
|
||||
@@ -233,25 +399,34 @@ docs/
|
||||
- [ ] 修改权限代码 → 更新权限说明
|
||||
- [ ] 修改接口访问级别 → 更新权限要求说明
|
||||
|
||||
#### 强制性文档更新格式要求:
|
||||
```markdown
|
||||
#### 接口名称
|
||||
**接口地址**: `HTTP方法 /完整路径`
|
||||
**接口描述**: 清晰描述接口功能
|
||||
**权限要求**: 具体权限代码或"需要登录"
|
||||
**请求参数**: 完整参数表格
|
||||
**响应示例**: 真实的JSON响应示例
|
||||
**错误码**: 可能的错误情况
|
||||
**更新记录**: 接口变更历史
|
||||
```
|
||||
## 5. 📊 文档模板体系
|
||||
|
||||
### 🔴 违规检查机制
|
||||
- **代码审查时检查**:每次PR必须检查API文档是否同步更新
|
||||
- **自动化提醒**:接口变更后立即更新文档,不得延误
|
||||
- **文档版本控制**:API文档版本必须与代码版本保持一致
|
||||
### 已创建的标准模板:
|
||||
- **`docs/项目总览/项目总览模板.md`** - 项目基本信息模板
|
||||
- **`docs/业务模块/业务模块开发模板.md`** - 业务模块开发标准模板
|
||||
- **`docs/开发文档/API文档模板.md`** - API接口文档标准模板
|
||||
|
||||
### ⚠️ 重要提醒
|
||||
**不更新API文档的代码变更将被视为不完整的开发任务,必须补齐文档后才能认为任务完成!**
|
||||
### 模板使用规范:
|
||||
1. **新项目或模块开发时**:复制对应模板,替换占位符
|
||||
2. **文档更新时**:参考模板格式,保持结构一致
|
||||
3. **Cursor AI生成文档时**:使用模板作为格式参考
|
||||
|
||||
## 6. 🔍 文档质量控制
|
||||
|
||||
### 文档完整性检查清单:
|
||||
- [ ] 文档结构符合标准模板
|
||||
- [ ] 内容与实际代码实现一致
|
||||
- [ ] API文档包含完整示例
|
||||
- [ ] 业务逻辑描述清晰准确
|
||||
- [ ] 技术实现说明详细
|
||||
- [ ] 变更历史有完整记录
|
||||
- [ ] 所有占位符已替换为真实内容
|
||||
|
||||
### 文档准确性验证:
|
||||
- [ ] API接口示例可以正常调用
|
||||
- [ ] 数据库脚本可以成功执行
|
||||
- [ ] 配置文档与实际配置一致
|
||||
- [ ] 部署文档可以成功部署
|
||||
|
||||
---
|
||||
|
||||
@@ -267,6 +442,14 @@ docs/
|
||||
- **路由管理**: Vue Router 4
|
||||
- **HTTP客户端**: Axios
|
||||
- **代码风格**: ESLint + Prettier
|
||||
- **Node.js**: 20.15.x+ (推荐 20.15.0)
|
||||
- **npm**: 10.7.x+
|
||||
|
||||
### 环境要求
|
||||
- **开发环境**: 支持本地环境或阿里云测试环境
|
||||
- **数据库**: MySQL/Redis 支持本机安装或使用阿里云环境
|
||||
- **前端访问**: http://localhost (默认80端口)
|
||||
- **后端服务**: http://localhost:8080
|
||||
|
||||
## 2. Art Design Pro UI 规范
|
||||
|
||||
@@ -509,22 +692,46 @@ backend/
|
||||
- 常量: UPPER_SNAKE_CASE (如: MAX_RETRY_COUNT)
|
||||
- 包名: 全小写 (如: org.dromara.system)
|
||||
|
||||
### 数据库规范
|
||||
- **现有数据库模型**: 参考 `docs/design/database/hzdyjs_xg.sql` 中的完整表结构
|
||||
- **环境配置**: 开发环境数据库信息见 `docs/design/database/database_msg.md`
|
||||
- **主键设计**: 使用雪花ID (ASSIGN_ID),不使用数据库自增
|
||||
- **字段命名**: 下划线命名法 (如: user_name, create_time)
|
||||
- **基础字段**: 所有业务表必须包含以下字段
|
||||
```sql
|
||||
id BIGINT PRIMARY KEY,
|
||||
tenant_id VARCHAR(20), -- 租户ID (多租户)
|
||||
create_dept BIGINT, -- 创建部门
|
||||
create_by BIGINT, -- 创建人
|
||||
create_time DATETIME, -- 创建时间
|
||||
update_by BIGINT, -- 更新人
|
||||
update_time DATETIME, -- 更新时间
|
||||
deleted TINYINT DEFAULT 0 -- 逻辑删除标记
|
||||
```
|
||||
### 🔴 数据库规范(强制性)
|
||||
- **⚠️ 超级重要**: 所有数据库操作必须严格遵循 `docs/设计文档/database/mysql-database-standard.md` 规范
|
||||
- **现有数据库模型**: 参考 `docs/设计文档/database/hzdyjs_xg.sql` 中的完整表结构
|
||||
- **环境配置**: 开发环境数据库信息见 `docs/设计文档/database/database_msg.md`
|
||||
|
||||
#### 🚨 强制性核心规范
|
||||
1. **所有业务表必须包含标准基础字段**
|
||||
2. **统一使用雪花ID (bigint(20)) 作为主键**
|
||||
3. **强制使用逻辑删除,禁止物理删除**
|
||||
4. **所有表必须支持多租户**
|
||||
5. **完整的中文注释是必须的**
|
||||
6. **禁止使用数据库外键约束**,关联关系通过应用层维护
|
||||
|
||||
#### 🔴 强制性基础字段模板
|
||||
```sql
|
||||
-- 所有业务表必须包含以下字段(顺序和类型必须完全一致)
|
||||
`id` bigint(20) NOT NULL COMMENT '主键ID',
|
||||
`tenant_id` varchar(20) NOT NULL DEFAULT '000000' COMMENT '租户编号',
|
||||
`create_dept` bigint(20) DEFAULT NULL COMMENT '创建部门',
|
||||
`create_by` bigint(20) DEFAULT NULL COMMENT '创建者',
|
||||
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
|
||||
`update_by` bigint(20) DEFAULT NULL COMMENT '更新者',
|
||||
`update_time` datetime DEFAULT NULL COMMENT '更新时间',
|
||||
`deleted` tinyint(1) DEFAULT 0 COMMENT '删除标志(0代表存在 1代表删除)',
|
||||
|
||||
-- 业务字段在此处添加
|
||||
|
||||
PRIMARY KEY (`id`) USING BTREE,
|
||||
KEY `idx_tenant_id` (`tenant_id`),
|
||||
KEY `idx_deleted` (`deleted`),
|
||||
KEY `idx_create_time` (`create_time`)
|
||||
```
|
||||
|
||||
#### 🔴 AI开发强制要求
|
||||
当使用AI进行数据库开发时:
|
||||
1. **必须先阅读** `docs/设计文档/database/mysql-database-standard.md` 规范
|
||||
2. **必须使用标准模板**,不得随意修改基础字段
|
||||
3. **必须保持与现有表结构的一致性**
|
||||
4. **建表后必须立即更新** `hzdyjs_xg.sql` 文件
|
||||
5. **必须在变更记录中记录** 数据库变更
|
||||
|
||||
### API接口规范
|
||||
- **RESTful设计**: 遵循REST API设计原则
|
||||
@@ -550,13 +757,13 @@ backend/
|
||||
|
||||
#### 步骤2:立即更新API文档(强制性)
|
||||
**⚠️ 代码写完后立即执行,不得延后!**
|
||||
- 打开 `docs/development/API.md` 文件
|
||||
- 按照标准格式添加或更新接口文档
|
||||
- 打开 `docs/开发文档/API.md` 文件
|
||||
- 按照 `docs/开发文档/API文档模板.md` 的标准格式添加或更新接口文档
|
||||
- 包含完整的接口信息(地址、参数、响应、权限等)
|
||||
- 添加真实的请求和响应示例
|
||||
|
||||
#### 步骤3:记录代码调整日志
|
||||
- 在 `docs/code-adjust-record.md` 中记录本次变更
|
||||
- 在 `docs/变更管理/code-adjust-record.md` 中记录本次变更
|
||||
- 特别说明API接口的变更内容
|
||||
- 标注文档已同步更新
|
||||
|
||||
@@ -776,20 +983,23 @@ const request = (options) => {
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
## 🚨 重要提醒和强制要求
|
||||
|
||||
1. **严格遵循规范**: 所有开发必须按照本规范执行
|
||||
2. **代码调整记录**: 每次代码修改都必须在 `docs/code-adjust-record.md` 中记录
|
||||
3. **文档同步更新**: 代码变更必须同步更新相关文档
|
||||
4. **安全第一**: 所有功能开发都要考虑安全性
|
||||
5. **性能考虑**: 大数据量操作需要性能测试验证
|
||||
6. **团队协作**: 重要变更需要团队讨论和代码审查
|
||||
1. **📝 文档同步更新**:每次代码调整都必须同步更新相关文档,这是强制性要求
|
||||
2. **🔴 API文档管理**:API接口变更必须立即更新 `docs/开发文档/API.md` 文档
|
||||
3. **📋 变更记录**:每次调整都必须在 `docs/变更管理/code-adjust-record.md` 中记录
|
||||
4. **🎯 业务上下文**:充分利用 `docs/业务模块/` 下的文档为AI提供完整业务上下文
|
||||
5. **📚 模板使用**:使用标准文档模板,确保格式一致性
|
||||
6. **🔍 质量控制**:确保文档内容与代码实现完全一致
|
||||
7. **⚡ 实时性**:文档更新不得延后,必须与代码变更同步进行
|
||||
|
||||
## 参考资源
|
||||
|
||||
- **前端官方文档**: Vue 3、Element Plus、Vite
|
||||
- **后端官方文档**: Spring Boot、MyBatis-Plus、Sa-Token
|
||||
- **移动端官方文档**: uni-app、uView UI
|
||||
- **项目文档**: `docs/` 目录下的详细文档
|
||||
- **代码调整记录**: `docs/code-adjust-record.md`
|
||||
- **项目文档体系**:`docs/` 目录下的完整文档
|
||||
- **业务模块文档**:`docs/业务模块/` 各模块的详细文档
|
||||
- **开发文档**:`docs/开发文档/` 技术规范和API文档
|
||||
- **变更记录**:`docs/变更管理/code-adjust-record.md`
|
||||
- **标准模板**:各目录下的模板文件
|
||||
|
||||
**🎯 目标**:通过完善的文档管理体系,为Cursor AI提供准确的开发上下文,确保高质量的代码生成和文档同步更新!
|
||||
|
||||
Reference in new issue
Block a user