3.7 KiB
3.7 KiB
Quickstart: SYS-009设计整合与实现对齐
1. 准备上下文
- 在
water-docs根目录确认当前分支为007-sys009-design-align。 - 阅读以下文件:
docs/design/00_Management/01_Project_Progress.mddocs/design/00_Management/02_Delivery_Standards.mddocs/design/00_Management/03_Task_Checklist.mddocs/design/01_Overview/03_Summary_Design.mddocs/design/02_Detailed_Design/12_REV_Detailed.mddocs/design/03_Technical_Design/01_Database_Design.mddocs/design/03_Technical_Design/03_Interface_Design.md
2. 固定代码基线
- 记录 backend 分支和 commit:
git -C ../water-backend rev-parse --abbrev-ref HEADgit -C ../water-backend rev-parse HEAD
- 如仅做范围说明,可记录 frontend 分支和 commit:
git -C ../water-frontend rev-parse --abbrev-ref HEADgit -C ../water-frontend rev-parse HEAD
- 将结果写入
baseline.md与final-verdict.md。
3. 收集对齐证据
- 核对外部设计来源:
/Users/tangweijie/github/water-bank-api-doc/营收系统缴费接口.md/Users/tangweijie/github/water-bank-api-doc/营收系统接口规范设计文档.md
- 核对 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
- 按“已实现 / 部分实现 / 文档先行”归档能力簇结论。
4. 更新正式文档
- 在
12_REV_Detailed.md补REV-003与REV-008的能力边界与成熟度说明。 - 在
03_Interface_Design.md补签约、解约、状态查询、取消送盘、对账文件规则等接口契约。 - 在
01_Database_Design.md补bk_*表族与外部能力簇的承接口径。 - 在
03_Summary_Design.md同步SYS-009范围摘要和外部接口表。
5. 生成与更新证据工件
- 更新或新增:
baseline.mdresearch.mddata-model.mdcontracts/*final-verdict.md
- 若本轮已完成正式文档修订,同步更新:
docs/design/00_Management/01_Project_Progress.mddocs/design/00_Management/03_Task_Checklist.md
6. 执行校验
make validate-file FILE=docs/design/02_Detailed_Design/12_REV_Detailed.mdmake validate-file FILE=docs/design/03_Technical_Design/03_Interface_Design.mdmake validate-file FILE=docs/design/03_Technical_Design/01_Database_Design.mdmake validate-file FILE=docs/design/01_Overview/03_Summary_Design.mdmake check-linksmake validate-mermaid
7. 形成最终结论
- 在
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.mdmake validate-file FILE=docs/design/03_Technical_Design/03_Interface_Design.mdmake validate-file FILE=docs/design/03_Technical_Design/01_Database_Design.mdmake validate-file FILE=docs/design/01_Overview/03_Summary_Design.md