docs(requirements): 更新需求文档结构和用户故事格式规范
- 将文档章节从4个调整为6个,新增“用户故事”和“附录”章节 - 用户故事章节采用标准格式,明确用户角色、功能需求和业务价值 - 附录章节新增业务术语表,包含术语、定义和示例 - 调整原有章节顺序,确保文档结构清晰规范
This commit is contained in:
parent
f3a6d22da8
commit
8aafbec366
|
|
@ -7,12 +7,35 @@ description: 生成需求文档的时候需要
|
|||
|
||||
## 文档结构要求
|
||||
|
||||
必须且仅包含以下4个章节,顺序固定:
|
||||
必须且仅包含以下6个章节,顺序固定:
|
||||
|
||||
1. **功能模块划分**: 明确的模块结构和模块关系
|
||||
2. **功能详细说明**: 每个功能的具体描述、业务规则、验收标准
|
||||
3. **数据需求**: 数据实体、字段定义、数据规则
|
||||
4. **流程图**: 使用 PlantUml 语法实现,清晰展示业务流程和逻辑
|
||||
3. **用户故事**: 从用户视角描述需求和期望价值
|
||||
4. **数据需求**: 数据实体、字段定义、数据规则
|
||||
5. **流程图**: 使用 PlantUml 语法实现,清晰展示业务流程和逻辑
|
||||
6. **附录**: 业务术语表及其他补充说明
|
||||
|
||||
## 用户故事格式
|
||||
|
||||
采用标准用户故事格式:
|
||||
|
||||
```
|
||||
作为 [用户角色],我希望 [功能需求],以便 [业务价值]
|
||||
```
|
||||
|
||||
- **用户角色**: 明确的角色定义(如:普通用户、管理员、运营人员)
|
||||
- **功能需求**: 具体的功能期望
|
||||
- **业务价值**: 该功能带来的价值或解决的问题
|
||||
|
||||
## 附录要求
|
||||
|
||||
### 业务术语表
|
||||
|
||||
| 术语 | 定义 | 示例 |
|
||||
|------|------|------|
|
||||
| 术语名称 | 准确的业务定义 | 具体使用示例 |
|
||||
|
||||
|
||||
## 需求描述要求
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"plantuml.commandArgs": [
|
||||
|
||||
],
|
||||
"plantuml.server": "https://www.plantuml.com/plantuml"
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
1、确认每个接口的需求、业务逻辑、字段规则、相关数据表、状态流转、参数、返回值、状态码、错误信息是否正常
|
||||
|
||||
2、检查是否存在未处理的异常情况
|
||||
3、检查是否存在未处理的边界情况
|
||||
4、检查是否存在未处理的错误信息
|
||||
5、确保不会造成亏损
|
||||
6、确保对账单的准确性
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1 @@
|
|||
Subproject commit 58ca26af6747fbd1fe2ca358fa2311d22c7051f9
|
||||
Loading…
Reference in New Issue