优化cursor使用形式,增加项目文档过程管理,方便cursor生成代码
This commit is contained in:
1 parent
2f7e1a9c16
commit
65d2d71469
36 files changed
+8872
-1530
No files matched your search
@@ -0,0 +1,73 @@
|
||||
# 需求文档目录
|
||||
|
||||
## 目录说明
|
||||
|
||||
此目录用于存放项目的需求相关文档,包括:
|
||||
|
||||
## 1. 功能需求文档
|
||||
|
||||
`功能需求文档`:详细的功能需求描述,明确系统应该具备的功能
|
||||
|
||||
### 已有需求文档:
|
||||
|
||||
- **后勤满意度调查系统需求说明.md**:完整的满意度调查系统需求描述
|
||||
- **简化版报告厅预约系统设计说明.md**:报告厅预约系统的简化设计方案
|
||||
|
||||
## 2. 业务流程文档
|
||||
|
||||
`业务流程文档`:描述系统的业务流程和操作规范
|
||||
|
||||
### 待添加文档:
|
||||
|
||||
- 用户管理业务流程
|
||||
- 权限管理业务流程
|
||||
- 多租户管理业务流程
|
||||
- 工作流业务流程
|
||||
|
||||
## 3. 原型设计文档
|
||||
|
||||
`原型设计文档`:UI 原型和交互设计文档
|
||||
|
||||
### 目录结构:
|
||||
|
||||
- mockups/ - 原型设计文件
|
||||
- wireframes/ - 线框图
|
||||
- user-stories/ - 用户故事
|
||||
|
||||
## 4. 业务规则文档
|
||||
|
||||
`业务规则文档`:详细的业务规则和约束条件
|
||||
|
||||
### 待添加文档:
|
||||
|
||||
- 数据权限规则
|
||||
- 多租户规则
|
||||
- 审核流程规则
|
||||
|
||||
## 文档管理规范
|
||||
|
||||
### 文档命名规范
|
||||
|
||||
- 使用中文描述性名称
|
||||
- 按模块分组存放
|
||||
- 版本控制格式:v1.0、v1.1 等
|
||||
|
||||
### 文档内容规范
|
||||
|
||||
- 明确的需求描述
|
||||
- 详细的业务流程
|
||||
- 清晰的验收标准
|
||||
- 完整的用例描述
|
||||
|
||||
### 更新维护
|
||||
|
||||
- 需求变更时及时更新文档
|
||||
- 保留历史版本记录
|
||||
- 定期 review 文档内容
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. 所有需求变更必须更新相关文档
|
||||
2. 新功能开发前必须先编写需求文档
|
||||
3. 需求文档需要经过需求方确认
|
||||
4. 文档格式统一使用 Markdown
|
||||
Reference in new issue
Block a user