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.
50 lines
3.0 KiB
50 lines
3.0 KiB
3 weeks ago
|
# bruno-sync 配置扩容 + 线索模块 API 文档生成
|
||
|
|
|
||
|
|
Type: task
|
||
|
|
Status: resolved
|
||
|
|
Depends on: 11, 12, 13
|
||
|
|
ADR: docs/adr/0023-lead-batch-operations-and-view-stats.md
|
||
|
|
|
||
|
|
## Question（实现目标）
|
||
|
|
|
||
|
|
把线索/规则/偏好模块纳入 bruno-sync 扫描，运行 bruno-sync skill 生成/更新 API 文档，并按页做逐页比对（原型 vs 已实现接口）收口。
|
||
|
|
|
||
|
|
## 交付物
|
||
|
|
|
||
|
|
### 配置
|
||
|
|
- `bruno-sync.config.json` 的 `scan.sourceRoots` 增补：
|
||
|
|
`crm-lead/src/main/java`、`crm-rule/src/main/java`、`crm-preference/src/main/java`
|
||
|
|
（当前仅 crm-auth、crm-file）。
|
||
|
|
|
||
|
|
### 文档生成
|
||
|
|
- 运行 bruno-sync skill（`C:\Users\luowj\.qoder\skills\bruno-sync\SKILL.md`）。
|
||
|
|
- `docsRepoPath` = `D:/code/crm-api-docs`（见 bruno-sync.local.json），urlPattern `/api/{module}/{resource}`，envelope code/success/message/data。
|
||
|
|
- 产物：线索四视图 page/detail/history/create/edit/delete/流转 + 新增 stats + 6 个 -batch；规则 pool page/detail/saveOrUpdate/delete + delete-batch；region；preference get/save。
|
||
|
|
|
||
|
|
### 逐页比对（收口）
|
||
|
|
- 对线索模块 15 页原型（`tmp/lead_pages.json` / `prototype-extract/`）逐页核对：每页所需接口是否已在文档中齐备。
|
||
|
|
- 输出比对结论到 `.scratch/clue-module/map.md`：G1–G5 已闭环；G6/G7/G8 维持 Out of scope（原型有按钮≠本期交付）。
|
||
|
|
|
||
|
|
## 验收
|
||
|
|
|
||
|
|
- 全模块先 `mvn -q compile` 通过（依赖 10/11/12/13 全 resolved）。
|
||
|
|
- 全 `*.java` 无 BOM 扫描通过。
|
||
|
|
- 文档生成无报错；线索/规则/偏好接口全部出现在文档。
|
||
|
|
- map.md 记录逐页比对结论与残留 Out-of-scope 项。
|
||
|
|
|
||
|
|
## Comments
|
||
|
|
|
||
|
|
## Answer
|
||
|
|
|
||
|
|
已交付：
|
||
|
|
- **配置扩容**：`bruno-sync.config.json` `scan.sourceRoots` 增补 `crm-lead/src/main/java`、`crm-rule/src/main/java`、`crm-preference/src/main/java`（原仅 crm-auth+crm-file）。
|
||
|
|
- **文档生成**（bruno-sync skill，docs 仓 `D:/code/crm-api-docs`，`grouping: tag`）：新增 **32 个 generated `.bru`**，沿仓内房屏风格（meta+method 块+docs 首行对账钥匙）：
|
||
|
|
- `线索管理/` ×23（page/detail/history/stats/create/edit/delete/claim/assign-pool/assign-user/feedback-draft/feedback-submit/convert/release/activate/follow/unfollow + 6 个 -batch）
|
||
|
|
- `线索规则-公海池配置/` ×5（page/detail/saveOrUpdate/delete/delete-batch）
|
||
|
|
- `线索规则-行政区划/` ×2（list/level）
|
||
|
|
- `列偏好/` ×2（get/save）
|
||
|
|
- 报告：新增 32 / 删除 0 / 跳过 0 / 无法识别 0 / 钥匙冲突 0 / 矛盾 0 / 表述差异 0。
|
||
|
|
- **逐页比对（收口）**：原型 15 页逐页核对写入 `map.md` 「## 逐页比对（ticket 14 收口）」。**G1–G5 全闭环**（批量分配/删除/激活/领取 + 统计卡片）；G6 线索导入 / G7 池导入 / G8 池导出 维持 Out of scope（原型有按钮≠本期交付）；无遗漏项。
|
||
|
|
|
||
|
|
验收：`mvn -q compile` 全模块通过；全 `*.java` 无 BOM 扫描通过；线索/规则/偏好接口全部出现在文档；map.md 已记录逐页比对结论与残留 Out-of-scope 项。
|