84 lines
3.7 KiB
Markdown
84 lines
3.7 KiB
Markdown
# Quickstart: SYS-009设计整合与实现对齐
|
||
|
||
## 1. 准备上下文
|
||
|
||
1. 在 `water-docs` 根目录确认当前分支为 `007-sys009-design-align`。
|
||
2. 阅读以下文件：
|
||
- `docs/design/00_Management/01_Project_Progress.md`
|
||
- `docs/design/00_Management/02_Delivery_Standards.md`
|
||
- `docs/design/00_Management/03_Task_Checklist.md`
|
||
- `docs/design/01_Overview/03_Summary_Design.md`
|
||
- `docs/design/02_Detailed_Design/12_REV_Detailed.md`
|
||
- `docs/design/03_Technical_Design/01_Database_Design.md`
|
||
- `docs/design/03_Technical_Design/03_Interface_Design.md`
|
||
|
||
## 2. 固定代码基线
|
||
|
||
1. 记录 backend 分支和 commit：
|
||
- `git -C ../water-backend rev-parse --abbrev-ref HEAD`
|
||
- `git -C ../water-backend rev-parse HEAD`
|
||
2. 如仅做范围说明，可记录 frontend 分支和 commit：
|
||
- `git -C ../water-frontend rev-parse --abbrev-ref HEAD`
|
||
- `git -C ../water-frontend rev-parse HEAD`
|
||
3. 将结果写入 `baseline.md` 与 `final-verdict.md`。
|
||
|
||
## 3. 收集对齐证据
|
||
|
||
1. 核对外部设计来源：
|
||
- `/Users/tangweijie/github/water-bank-api-doc/营收系统缴费接口.md`
|
||
- `/Users/tangweijie/github/water-bank-api-doc/营收系统接口规范设计文档.md`
|
||
2. 核对 backend 关键证据：
|
||
- `../water-backend/sw-business-bank/sw-business-bank-server/src/main/java/.../controller/app/payceb/PayCebController.java`
|
||
- `../water-backend/sw-business-bank/sw-business-bank-server/src/main/java/.../service/payceb/PayCebServiceImpl.java`
|
||
- `../water-backend/sw-business-bank/sw-business-bank-server/src/main/java/.../controller/app/bankwithholding/BankWithholdingController.java`
|
||
- `../water-backend/sw-business-bank/sw-business-bank-server/src/main/java/.../service/bankwithholding/BankWithholdingServiceImpl.java`
|
||
- `../water-backend/sw-business-bank/docs/建表sql.sql`
|
||
3. 按“已实现 / 部分实现 / 文档先行”归档能力簇结论。
|
||
|
||
## 4. 更新正式文档
|
||
|
||
1. 在 `12_REV_Detailed.md` 补 `REV-003` 与 `REV-008` 的能力边界与成熟度说明。
|
||
2. 在 `03_Interface_Design.md` 补签约、解约、状态查询、取消送盘、对账文件规则等接口契约。
|
||
3. 在 `01_Database_Design.md` 补 `bk_*` 表族与外部能力簇的承接口径。
|
||
4. 在 `03_Summary_Design.md` 同步 `SYS-009` 范围摘要和外部接口表。
|
||
|
||
## 5. 生成与更新证据工件
|
||
|
||
1. 更新或新增：
|
||
- `baseline.md`
|
||
- `research.md`
|
||
- `data-model.md`
|
||
- `contracts/*`
|
||
- `final-verdict.md`
|
||
2. 若本轮已完成正式文档修订，同步更新：
|
||
- `docs/design/00_Management/01_Project_Progress.md`
|
||
- `docs/design/00_Management/03_Task_Checklist.md`
|
||
|
||
## 6. 执行校验
|
||
|
||
1. `make validate-file FILE=docs/design/02_Detailed_Design/12_REV_Detailed.md`
|
||
2. `make validate-file FILE=docs/design/03_Technical_Design/03_Interface_Design.md`
|
||
3. `make validate-file FILE=docs/design/03_Technical_Design/01_Database_Design.md`
|
||
4. `make validate-file FILE=docs/design/01_Overview/03_Summary_Design.md`
|
||
5. `make check-links`
|
||
6. `make validate-mermaid`
|
||
|
||
## 7. 形成最终结论
|
||
|
||
1. 在 `final-verdict.md` 汇总：
|
||
- 本轮基线
|
||
- 已整合的能力簇
|
||
- 每个能力簇的成熟度结论
|
||
- 已更新的正式文档
|
||
- 已执行的校验
|
||
- 剩余未闭环项
|
||
|
||
## 8. 当前已执行结果
|
||
|
||
- 已完成 `12_REV_Detailed.md`、`03_Interface_Design.md`、`01_Database_Design.md`、`03_Summary_Design.md` 的 SYS-009 正式口径修订。
|
||
- 已完成以下单文件校验并通过：
|
||
- `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/01_Overview/03_Summary_Design.md`
|