初始化 pay-bridge 项目:PRD、需求文档和项目框架
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
153
docs/requirements/templates/requirement-template.md
Normal file
153
docs/requirements/templates/requirement-template.md
Normal file
@@ -0,0 +1,153 @@
|
||||
# REQ-XXX: 需求标题
|
||||
|
||||
## 元信息
|
||||
|
||||
| 属性 | 值 |
|
||||
|-----|-----|
|
||||
| 编号 | REQ-XXX |
|
||||
| 类型 | 后端 / 前端 / 全栈 |
|
||||
| 状态 | 草稿 |
|
||||
| 模块 | - |
|
||||
| 优先级 | P2 |
|
||||
| 创建日期 | YYYY-MM-DD |
|
||||
| 负责人 | - |
|
||||
|
||||
## 生命周期
|
||||
|
||||
<!-- 需求状态流转:草稿 → 待评审 → 评审通过 → 开发中 → 测试中 → 已完成 -->
|
||||
|
||||
- [ ] 草稿(编写中)
|
||||
- [ ] 待评审
|
||||
- [ ] 评审通过
|
||||
- [ ] 开发中
|
||||
- [ ] 测试中
|
||||
- [ ] 已完成
|
||||
|
||||
---
|
||||
|
||||
## 一、需求描述
|
||||
|
||||
### 1.1 背景
|
||||
|
||||
简要说明需求产生的背景...
|
||||
|
||||
### 1.2 目标
|
||||
|
||||
本需求要实现的目标...
|
||||
|
||||
### 1.3 客户场景
|
||||
|
||||
> 记录客户提出的原始业务场景和诉求
|
||||
|
||||
- **场景1**:客户描述...
|
||||
- **场景2**:客户描述...
|
||||
|
||||
### 1.4 价值
|
||||
|
||||
实现后带来的业务价值...
|
||||
|
||||
---
|
||||
|
||||
## 二、功能清单
|
||||
|
||||
> 列出所有功能点,开发完成后勾选
|
||||
|
||||
- [ ] **功能点1**:描述...
|
||||
- [ ] **功能点2**:描述...
|
||||
- [ ] **功能点3**:描述...
|
||||
|
||||
---
|
||||
|
||||
## 三、业务规则
|
||||
|
||||
| 规则 | 说明 |
|
||||
|-----|------|
|
||||
| 规则1 | 详细说明 |
|
||||
| 规则2 | 详细说明 |
|
||||
|
||||
---
|
||||
|
||||
## 四、使用场景
|
||||
|
||||
### 场景1:XXX
|
||||
|
||||
- **角色**:XXX
|
||||
- **前置条件**:XXX
|
||||
- **基本流程**:
|
||||
1. 用户操作... → 系统响应...
|
||||
2. 用户操作... → 系统响应...
|
||||
3. 用户操作... → 系统响应...
|
||||
- **异常流程**:
|
||||
- 条件A → 预期结果
|
||||
- 条件B → 预期结果
|
||||
|
||||
### 场景2:XXX
|
||||
|
||||
- **角色**:XXX
|
||||
- **前置条件**:XXX
|
||||
- **基本流程**:
|
||||
1. ...
|
||||
- **异常流程**:
|
||||
- ...
|
||||
|
||||
---
|
||||
|
||||
## 五、API 设计
|
||||
|
||||
> 列出需要新增或修改的接口,仅描述业务语义,不涉及实现细节
|
||||
|
||||
| 接口名称 | 方法 | 路径 | 说明 |
|
||||
|---------|------|------|------|
|
||||
| 创建XXX | POST | /api/v1/xxx | 描述... |
|
||||
| 查询XXX列表 | GET | /api/v1/xxx | 描述... |
|
||||
| 更新XXX | PUT | /api/v1/xxx/:id | 描述... |
|
||||
| 删除XXX | DELETE | /api/v1/xxx/:id | 描述... |
|
||||
|
||||
---
|
||||
|
||||
## 六、测试要点
|
||||
|
||||
- [ ] 测试点1:描述测试场景和预期结果
|
||||
- [ ] 测试点2:描述测试场景和预期结果
|
||||
|
||||
---
|
||||
|
||||
## 七、评审记录
|
||||
|
||||
| 日期 | 评审人 | 结论 | 意见 |
|
||||
|-----|-------|------|------|
|
||||
| - | - | - | - |
|
||||
|
||||
---
|
||||
|
||||
## 八、变更记录
|
||||
|
||||
| 日期 | 变更内容 | 影响范围 |
|
||||
|-----|---------|---------|
|
||||
| YYYY-MM-DD | 初始版本 | - |
|
||||
|
||||
---
|
||||
|
||||
## 九、关联信息
|
||||
|
||||
- **关联需求**:REQ-XXX(前端/后端对应需求)
|
||||
- **相关文档**:链接
|
||||
- **协作说明**:描述前后端协作要点
|
||||
|
||||
---
|
||||
|
||||
## 十、实现方案
|
||||
|
||||
> 本章节在 `/req:dev` 阶段由 AI 分析代码后自动生成,创建需求时无需填写。
|
||||
|
||||
### 10.1 数据模型
|
||||
|
||||
_开发阶段填充_
|
||||
|
||||
### 10.2 文件改动清单
|
||||
|
||||
_开发阶段填充_
|
||||
|
||||
### 10.3 实现步骤
|
||||
|
||||
_开发阶段填充_
|
||||
Reference in New Issue
Block a user