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.
2.0 KiB
2.0 KiB
04 文档完善度审计（前端视角）
Status: resolved Type: research Blocked by: (无)
Question
以「前端拿到 .bru 能否不看源码直接联调」为标准，审计 D:\code\crm-api-docs 线索相关 .bru 的内容质量（接口在不在由 02 管，这里管「看得懂」）：
- 参数示例值是否真实可用：viewType 四值、status 七态、ids 逗号分隔形态、日期格式 yyyy-MM-dd HH:mm:ss、雪花 ID 按字符串；
- 枚举/字典语义说明：7 状态机、4 视图、反馈结果类型、池 claim_rule、公海可见状态集；
- 响应结构可读性：分页信封（content/total/...）、BatchResult 部分成功结构（failItems）、LeadStatsDTO 卡片口径；
- 错误/边界场景是否点到：如删除已转商机线索报错、领取超限、非池成员领取；
collection.bru全局契约 README 是否覆盖 menuBindings 对照、认证方式、环境地址。
产出：.scratch/lead-docs-audit/research/04-completeness-audit.md——按 .bru 文件的问题清单 + 每项修复建议（归「gen_bruno.py 机制升级」还是「数据/文案补齐」），供 03 拍板补缺口径。
Answer
2026-08-17 审计完成，详见 research/04-completeness-audit.md。要点：
- D 盘 32 个线索 .bru 全部无参数体/无响应示例/无枚举——完善度仅「目录级」，前端无法联调；根因是 D 盘从未用 141 版生成器重新生成（旧版生成器产物）。
- gen_bruno.py（141 版）已具备全部补齐能力（参数六元组、PageResult/BatchResult/StatsDTO 响应构造、status 七态枚举、四菜单 viewType/scopeKey 副本绑定）——重生成即消灭 A 类致命问题。
- 真正增量只有：collection.bru 两处失效文案（crm-core 指向、auth/ 路径）+ 可选的每接口典型报错一行 + baseUrl 环境确认。
- 对 03 的口径建议：补缺 = 重生成 + 两处文案修正；裁剪机制才是主体工作量。