53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
---
|
|
trigger: model_decision
|
|
description: 生成需求文档的时候需要
|
|
---
|
|
|
|
# 需求文档编写规范
|
|
|
|
## 文档结构要求
|
|
|
|
必须且仅包含以下6个章节,顺序固定:
|
|
|
|
1. **功能模块划分**: 明确的模块结构和模块关系
|
|
2. **功能详细说明**: 每个功能的具体描述、业务规则、验收标准
|
|
3. **用户故事**: 从用户视角描述需求和期望价值
|
|
4. **数据需求**: 数据实体、字段定义、数据规则
|
|
5. **流程图**: 使用 PlantUml 语法实现,清晰展示业务流程和逻辑
|
|
6. **附录**: 业务术语表及其他补充说明
|
|
|
|
## 用户故事格式
|
|
|
|
采用标准用户故事格式:
|
|
|
|
```
|
|
作为 [用户角色]，我希望 [功能需求]，以便 [业务价值]
|
|
```
|
|
|
|
- **用户角色**: 明确的角色定义（如：普通用户、管理员、运营人员）
|
|
- **功能需求**: 具体的功能期望
|
|
- **业务价值**: 该功能带来的价值或解决的问题
|
|
|
|
## 附录要求
|
|
|
|
### 业务术语表
|
|
|
|
| 术语 | 定义 | 示例 |
|
|
|------|------|------|
|
|
| 术语名称 | 准确的业务定义 | 具体使用示例 |
|
|
|
|
|
|
## 需求描述要求
|
|
|
|
- **简洁**: 避免冗余和无关信息
|
|
- **聚焦**: 只描述业务需求,不涉及实现方案
|
|
- **明确无歧义**: 每个需求点都有准确定义,避免模糊表述
|
|
|
|
## 规则作用
|
|
|
|
保持需求文档的纯粹性,将需求分析与设计实现分离,通过流程图直观展示业务逻辑
|
|
|
|
## 规则重要性
|
|
|
|
确保需求文档聚焦业务价值和用户需求,便于需求评审、开发理解和后续变更管理
|