58 lines
2.5 KiB
Markdown
58 lines
2.5 KiB
Markdown
# Quickstart: REV-006 催缴事件与通知协同设计
|
||
|
||
## 目标
|
||
|
||
本 quickstart 用于指导评审者和文档维护者快速完成 `REV-006` 设计补齐的检查，不涉及 backend 实施。
|
||
|
||
## 步骤 1：阅读规格与研究结论
|
||
|
||
1. 阅读 `spec.md`，确认三项澄清已固定：
|
||
- 停复水仅定义联动边界
|
||
- `REV-006` 使用独立接口编号 `IF-REV-013`
|
||
- 结果状态固定为四态
|
||
2. 阅读 `research.md`，确认所有关键设计决策已有依据和备选方案说明。
|
||
|
||
## 步骤 2：执行文档改动时的目标落点
|
||
|
||
1. 在 `docs/design/02_Detailed_Design/12_REV_Detailed.md` 补齐 `REV-006`：
|
||
- 任务生成规则
|
||
- 结果回写规则
|
||
- 停复水联动边界
|
||
- 历史查询最小保留集
|
||
2. 在 `docs/design/03_Technical_Design/03_Interface_Design.md`：
|
||
- 新增或替换 `IF-REV-013`
|
||
- 保留 `IF-EXT-008`
|
||
- 删除 `REV-006` 对 `IF-REV-009` 的错误引用
|
||
3. 在 `docs/design/03_Technical_Design/01_Database_Design.md`：
|
||
- 明确在线主模型和历史只读查询口径
|
||
4. 在治理台账中回写：
|
||
- `01_Project_Progress.md`
|
||
- `03_Task_Checklist.md`
|
||
|
||
## 步骤 3：建议校验命令
|
||
|
||
```bash
|
||
make validate-file FILE=docs/design/02_Detailed_Design/12_REV_Detailed.md
|
||
make validate-file FILE=docs/design/03_Technical_Design/03_Interface_Design.md
|
||
make validate-file FILE=docs/design/03_Technical_Design/01_Database_Design.md
|
||
make validate-file FILE=docs/design/00_Management/15_SYS002_Requirement_Breakdown.md
|
||
make validate-file FILE=docs/design/00_Management/01_Project_Progress.md
|
||
make validate-file FILE=docs/design/00_Management/03_Task_Checklist.md
|
||
make check-links
|
||
```
|
||
|
||
## 步骤 4：验收检查点
|
||
|
||
- `REV-006` 不再复用 `IF-REV-009`
|
||
- 正式文档中统一使用四态结果集
|
||
- 停复水只写联动边界，不扩写内部流程
|
||
- 历史“催缴记录 / 停水记录 / 预存短信”不被误写成新在线主表
|
||
- 台账和正式文档同步更新
|
||
|
||
## 步骤 5：本轮实现摘要
|
||
|
||
- 已完成 `12_REV_Detailed.md`、`03_Interface_Design.md`、`01_Database_Design.md`、`15_SYS002_Requirement_Breakdown.md`、`01_Project_Progress.md`、`03_Task_Checklist.md` 的正式文档回写。
|
||
- `REV-006` 的正式业务接口编号已固定为 `IF-REV-013`，`IF-REV-009` 继续保留给 `REV-005` 发票结果查询。
|
||
- 催缴结果已统一为 `PENDING`、`SUCCESS`、`FAIL`、`MANUAL_VERIFIED` 四态；数据库与历史查询口径同步收口。
|
||
- 已执行并通过全部单文件校验与 `make check-links`。
|