You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.4 KiB
38 lines
1.4 KiB
1 month ago
|
---
|
||
|
|
description: 全系统业务建模文档（Docs/Key）必须随功能落地实时同步更新
|
||
|
|
alwaysApply: true
|
||
|
|
---
|
||
|
|
|
||
|
|
# 业务建模文档实时更新
|
||
|
|
|
||
|
|
## 文档位置
|
||
|
|
|
||
|
|
- 主文档：`Docs/Key/biz-model-system.md`（全系统业务分析建模）
|
||
|
|
- 变更记录：`Docs/Key/biz-model-changelog.md`
|
||
|
|
- 单功能 PRD：仍放 `docs/Plan/prd-*.md`，细节写 PRD，主文档写域模型与贯通关系
|
||
|
|
|
||
|
|
## 何时必须更新
|
||
|
|
|
||
|
|
在用户确认方案并完成功能实现后，**同一轮任务内**同步更新建模文档，不要等用户再提醒。
|
||
|
|
|
||
|
|
满足任一即更新：
|
||
|
|
|
||
|
|
1. 新增/下线菜单、页面、一级或二级模块
|
||
|
|
2. 变更主流程、审批链、角色或权限点
|
||
|
|
3. 变更核心表字段、状态枚举、状态机
|
||
|
|
4. 模块成熟度变化（如从「前端壳」变为「已落地」）
|
||
|
|
5. 跨模块衔接关系变化
|
||
|
|
|
||
|
|
## 怎么更新
|
||
|
|
|
||
|
|
1. 改 `biz-model-system.md` 对应章节（分域模型 / 状态机 / 角色权限 / 代码对照 / 缺口）
|
||
|
|
2. 在 `biz-model-changelog.md` 追加一行：日期、变更摘要、涉及模块
|
||
|
|
3. 若有对应 PRD，同步改 PRD，并在回复里说明「改了建模文档哪几处 + PRD 哪几处」
|
||
|
|
4. 成熟度、状态枚举以**当前代码为准**，发现 PRD 滞后时一并纠正，避免文档互相打架
|
||
|
|
|
||
|
|
## 不要做的
|
||
|
|
|
||
|
|
- 不要把单页交互细节全部堆进建模文档（那些留在 PRD）
|
||
|
|
- 不要只改代码不改建模文档
|
||
|
|
- 不要删除历史 changelog 行
|