147 lines
5.1 KiB
Markdown
147 lines
5.1 KiB
Markdown
<!-- 9774f234-db58-4d1d-a960-14f15586ebc9 -->
|
||
---
|
||
todos:
|
||
- id: "user-input"
|
||
content: "用户下一条消息提供:变更一句话、涉及仓库、原因、数据影响、优先级"
|
||
status: pending
|
||
- id: "draft-prd"
|
||
content: "按 docs/requirements 体例撰写变更 PRD(含变更前后对比表与验收标准)"
|
||
status: pending
|
||
- id: "index-link"
|
||
content: "若属已有需求体系,更新 README/父文档索引并链到新文档"
|
||
status: pending
|
||
- id: "user-review"
|
||
content: "根据用户反馈修订开放问题与验收项"
|
||
status: pending
|
||
isProject: false
|
||
---
|
||
# 协作撰写变更需求 PRD
|
||
|
||
## 可以做什么
|
||
|
||
可以帮你写**变更需求(Change Request)PRD**,结构对齐你仓库里已有规范,例如:
|
||
|
||
- 父文档:[docs/requirements/game_gateway_risk_prd_v_2.md](docs/requirements/game_gateway_risk_prd_v_2.md)
|
||
- 子需求:[docs/requirements/game_gateway/01_launch_session.md](docs/requirements/game_gateway/01_launch_session.md)
|
||
|
||
这些文档已包含:**目标与范围(In/Out scope)**、**依赖与边界**、**业务流程**、**数据表/接口**、**验收标准**——与你选择的「标准 PRD」一致。
|
||
|
||
---
|
||
|
||
## 当前阻塞:需要你补充变更说明
|
||
|
||
你已选择:**其它主题** + **变更需求** + **下一条消息文字说明**。在 Plan 模式下还缺少以下最小信息(建议下一条回复用 5~10 行写完):
|
||
|
||
| 必填 | 示例 |
|
||
|------|------|
|
||
| 变更一句话 | 「渠道创建时编号由运营手填改为系统生成」 |
|
||
| 涉及系统/仓库 | `slot-admin`、`slot-admin-vue`、`slot_wallet` 等 |
|
||
| 变更原因 | 运营误填、编号冲突、对接要求 |
|
||
| 是否影响线上数据 | 仅新数据 / 需迁移历史 |
|
||
| 期望上线时间或优先级 | P0 / 本迭代 / 可排期 |
|
||
|
||
可选但有助于写准:
|
||
|
||
- 相关页面或接口路径
|
||
- 已知约束(不能改表、必须兼容某厂商等)
|
||
- 是否需挂到现有父文档(如 Game Gateway 系列)
|
||
|
||
---
|
||
|
||
## 变更需求 PRD 文档结构(将按此产出)
|
||
|
||
在标准 PRD 基础上,**变更类**会额外突出「前后差异」,建议章节如下:
|
||
|
||
```mermaid
|
||
flowchart TB
|
||
input[你提供的变更说明]
|
||
code[可选:对照现有代码/表结构]
|
||
draft[撰写 PRD 初稿]
|
||
review[你确认/修订]
|
||
output[Markdown 落库或对话交付]
|
||
input --> code
|
||
code --> draft
|
||
draft --> review
|
||
review --> output
|
||
```
|
||
|
||
### 1. 文档元信息
|
||
|
||
- 标题、版本(如 V1.1-change)、日期、作者/评审人
|
||
- 关联父文档(若属于 Game Gateway 等已有体系)
|
||
|
||
### 2. 背景与变更动机
|
||
|
||
- 现状问题(As-Is)
|
||
- 变更目标(To-Be)
|
||
- 不做的范围(Out of scope)
|
||
|
||
### 3. 变更摘要(核心)
|
||
|
||
| 维度 | 变更前 | 变更后 |
|
||
|------|--------|--------|
|
||
| 业务规则 | … | … |
|
||
| 界面/交互 | … | … |
|
||
| 接口/字段 | … | … |
|
||
| 数据/缓存 | … | … |
|
||
|
||
### 4. 功能需求(按角色或模块)
|
||
|
||
- 管理端 / 用户端 / innerapi / 跨服务(slot_sdk)分项
|
||
- 每条需求:**描述 + 规则 + 异常/边界**
|
||
|
||
### 5. 接口与数据(如涉及)
|
||
|
||
- API 路径、请求/响应字段变更(新增/废弃/只读)
|
||
- 表字段、索引、Redis key、MQ(若有)
|
||
- 幂等、事务、兼容性说明
|
||
|
||
### 6. 非功能需求
|
||
|
||
- 性能、安全、日志、监控、回滚策略
|
||
|
||
### 7. 验收标准(可测试)
|
||
|
||
- Given / When / Then 或检查清单
|
||
- 回归范围(哪些旧功能不能坏)
|
||
|
||
### 8. 实施与发布建议(可选)
|
||
|
||
- 涉及仓库与大致文件(实施阶段再细化)
|
||
- 发布顺序、配置开关、数据迁移步骤
|
||
|
||
### 9. 风险与开放问题
|
||
|
||
- 待产品/技术确认项列表
|
||
|
||
---
|
||
|
||
## 撰写时我会怎么做(确认计划后执行)
|
||
|
||
1. **读你提供的变更说明**,必要时只读检索相关代码(Controller / Logic / Model / Vue),保证 PRD 与实现或意图一致。
|
||
2. **对齐仓库体例**:表格元信息、In/Out scope、mermaid/文本流程图,与 [01_launch_session.md](docs/requirements/game_gateway/01_launch_session.md) 风格一致。
|
||
3. **落盘位置**(默认,你可改):
|
||
- 独立变更:`docs/requirements/<模块>/<简短英文名>_change.md`
|
||
- 若属 Game Gateway 体系:在 [game_gateway/README.md](docs/requirements/game_gateway/README.md) 索引中增加一行,并链到父文档
|
||
4. **交付方式**:默认写入仓库;若你只希望对话里预览,说明「不要写文件」即可。
|
||
|
||
**不会**在未经你确认前修改业务代码;Plan 阶段仅产出文档。
|
||
|
||
---
|
||
|
||
## 与「反推 PRD」的区别
|
||
|
||
你选的是**变更需求**,不是从零或纯反推。若变更其实已部分落地(例如 [GameServerLogic.php](slot-admin/app/game/logic/GameServerLogic.php) 里渠道编号自动生成),可在 PRD 中标注 **「已实现 / 待实现」**,便于评审与补测。
|
||
|
||
---
|
||
|
||
## 你确认计划后的下一步
|
||
|
||
请在下一条消息直接粘贴变更说明(不必等再点选)。收到后我将:
|
||
|
||
1. 定文档标题与存放路径
|
||
2. 输出完整 PRD 初稿(Markdown)
|
||
3. 请你审阅「开放问题」与验收项,再按需修订一版
|
||
|
||
若变更属于 Game Gateway / 渠道 / 钱包等已有域,请点名,我会自动挂接对应父文档索引。
|