70 lines
3.6 KiB
Markdown
70 lines
3.6 KiB
Markdown
# Quickstart: REV-006 催缴与通知事件设计收口
|
||
|
||
## 1. 使用目标
|
||
|
||
本 quickstart 用于指导评审者或文档维护者快速完成 `REV-006` 的正式文档收口验证，不用于验证 backend 运行功能。
|
||
|
||
## 2. 建议执行顺序
|
||
|
||
1. 打开 [spec.md](/Volumes/Dpan/github/fujian_water_biz_doc/specs/006-reminder-event-design/spec.md)，确认范围、四态状态和治理结论。
|
||
2. 对照 [plan.md](/Volumes/Dpan/github/fujian_water_biz_doc/specs/006-reminder-event-design/plan.md)，确认本轮只修改既有主文档与管理台账。
|
||
3. 对照 [data-model.md](/Volumes/Dpan/github/fujian_water_biz_doc/specs/006-reminder-event-design/data-model.md)，检查催缴候选对象、任务、结果和处置引用的最小字段是否齐全。
|
||
4. 对照 `contracts/if-rev-013.md` 与 `contracts/if-ext-008.md`，确认 `SYS-002` / `SYS-010` 分工、输入输出和失败语义一致。
|
||
|
||
## 3. 正式文档修订检查点
|
||
|
||
- `12_REV_Detailed.md`
|
||
- 是否写清催缴对象来源、策略分组、频控和四态状态
|
||
- 是否明确停复水/工单只作为联动边界和追溯引用
|
||
- `03_Interface_Design.md`
|
||
- 是否统一 `IF-REV-013` 为正式业务接口编号
|
||
- 是否区分 `IF-REV-013` 与 `IF-EXT-008` 的责任边界
|
||
- `15_SYS002_Requirement_Breakdown.md`
|
||
- 是否保持 `SYS002-REQ-011` 为“未见实现”
|
||
- 是否明确“文档已收口，backend 未见明确实现骨架”
|
||
- `01_Project_Progress.md` / `03_Task_Checklist.md`
|
||
- 是否登记本轮文档收口与验证动作
|
||
|
||
## 4. 最小验证命令
|
||
|
||
```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/00_Management/15_SYS002_Requirement_Breakdown.md
|
||
make check-links
|
||
make validate-mermaid
|
||
```
|
||
|
||
## 5. 完成判定
|
||
|
||
满足以下条件即可进入 `/speckit.tasks`：
|
||
|
||
- `REV-006` 的业务规则、接口边界、历史查询和处置追溯口径已统一
|
||
- `SYS002-REQ-011` 的实现判断与后续研发切入点已写入治理台账
|
||
- 验证命令已纳入计划，且无新增平行正式稿
|
||
|
||
## 6. 2026-03-19 实施结果
|
||
|
||
### 已完成文档
|
||
|
||
- `docs/design/02_Detailed_Design/12_REV_Detailed.md`
|
||
- `docs/design/03_Technical_Design/03_Interface_Design.md`
|
||
- `docs/design/00_Management/15_SYS002_Requirement_Breakdown.md`
|
||
- `docs/design/00_Management/01_Project_Progress.md`
|
||
- `docs/design/00_Management/03_Task_Checklist.md`
|
||
|
||
### 验证结果
|
||
|
||
- `make validate-file FILE=docs/design/02_Detailed_Design/12_REV_Detailed.md`：通过，0 个问题
|
||
- `make validate-file FILE=docs/design/03_Technical_Design/03_Interface_Design.md`：通过，0 个问题
|
||
- `make validate-file FILE=docs/design/00_Management/15_SYS002_Requirement_Breakdown.md`：通过，0 个问题
|
||
- `make check-links`：通过，当前检查范围内未发现断链
|
||
- `make check-mermaid-file FILE=docs/design/02_Detailed_Design/12_REV_Detailed.md`：已确认目标文件存在 6 个 Mermaid 图表
|
||
- `make validate-mermaid`：已执行两次，但在当前环境下未返回最终结果；结合 Makefile 逻辑，该目标只校验仓库根目录 `*.md`，未直接覆盖本轮主要修改文件，后续如需全仓 Mermaid 终态结果，应单独排查该目标在当前环境中的阻塞原因
|
||
|
||
### 当前结论
|
||
|
||
- `REV-006` 已完成 implement 阶段的正式文档二次收口
|
||
- `SYS002-REQ-011` 继续维持“未见实现”，但 Speckit 工件链、正式文档口径与治理台账已对齐
|
||
- 当前剩余风险不是文档口径缺失，而是后续 backend 立项与 `make validate-mermaid` 全仓目标在本环境中的执行阻塞
|