petstore-docs/coverage/ontology-coverage-audit.md
2026-08-01 21:56:07 +08:00

6.7 KiB
Raw Blame History

本体覆盖度审计Ontology Coverage Audit

本体条目 ↔ 文档章节 ↔ 代码路径 ↔ 测试用例 三方对齐审计。 证据强度:anchored(三处对齐)/ documented(仅文档)/ implemented(仅代码)/ gap(缺失)。

刷新时间2026-07-10Batch 补全domain 回填、敏感字段规则、寄语/退订/周期规则、客户端埋点 Action、P1/P2 gap 占位)

审计方法

graph/ontology.jsonl 的每个条目,核对:

  1. 文档doc 字段指向的 docs 路径是否存在且描述一致
  2. 代码code 字段指向的源码路径是否存在且实现一致
  3. 测试test 字段指向的测试用例是否存在且覆盖该条目

任一缺失则降级证据强度。

当前规模(以 validate 为准)

类型 数量
Entity 20
Action 56
Event 23
Rule 34
Relation 56
合计 189

证据强度:anchored 15883.6%/ documented 18 / gap 11 / implemented 2。

anchored 占比相对 Batch 2 下降,是因为主动录入了 P1/P2 gap 占位与客户端埋点 documented 条目;端点漂移仍为 0。

校验:

python3 docs/graph/validate_ontology.py docs
python3 docs/graph/audit_drift.py

当前结果校验通过HTTP 端点 52/52、JPA Entity 11/11 对齐;非 JPA 领域实体 9 个(含 HighlightVideo、SessionToken、CurrentUser、HighlightFailReason 与 5 个 roadmap gap

元数据卫生

状态
Action / Relation domain 已回填0 缺失)
gap 入口 deprecated register_storewechat_authorizewechat_callback
寄语事件独立化 event:testimonial_saved(不再误挂 report_submitted
video_* emittedBy 挂到 action:track_video_play / track_video_save

核心实体覆盖

实体 文档 代码 测试 证据 备注
store StoreControllerTest anchored BR-STORE-003 公开字段裁剪已落地
user UserServiceLoginStrategyTest + UserJsonIgnoreTest anchored password/openid/unionid 均 @JsonIgnore
appointment AppointmentServiceTest / DetailTest anchored
report ReportServiceTest / ControllerTest anchored uk 上线需清重
report_lead ReportLeadControllerTest anchored
pet PetControllerTest anchored
service_type ServiceTypeControllerTest anchored
schedule_block ScheduleControllerTest anchored
report_image 间接 ReportServiceTest anchored 建议补独立类型用例
highlight_video ReportHighlightVideoServiceTest anchored 状态机/归类单测;真 FFmpeg E2E 仍可选
session_token SessionTokenServiceTest anchored jpa:false
report_testimonial ReportTestimonialServiceTest anchored
service_interval 间接 ReportLeadControllerTest anchored
highlight_fail_reason 枚举 ReportHighlightVideoServiceTest anchored jpa:false
current_user record SessionTokenServiceTest anchored jpa:false
membership 等 5 个 方向库 gap roadmap 占位

规则覆盖度34 条)

规则 测试 证据
BR-AUTH-001/002 SessionTokenServiceTest / UserServiceLoginStrategyTest anchored
BR-STORE-001/002 StoreControllerTest anchored
BR-STORE-003 公开门店字段裁剪 StoreControllerTest#publicGet/List… anchored
BR-APPT-001..003 Appointment*Test anchored
BR-APPT-004 时段校验 间接 anchored
BR-RPT-001..006 Report*Test anchored
BR-RPT-007 token hash 间接 anchored
BR-LEAD-001..003 ReportLeadControllerTest001 显式002/003 建议加强断言) anchored
BR-UPLOAD-001/002 间接 anchored
BR-HL-001/002 ReportHighlightVideoServiceTest anchored
BR-SCH-001 / BR-ST-001 / BR-PET-001 对应 ControllerTest anchored
BR-USER-001/002 间接 anchored
BR-USER-003 敏感字段 JsonIgnore UserJsonIgnoreTest anchored
BR-CONFIG-001/002 —(配置) anchored
BR-TST-001 一报告一寄语 ReportTestimonialServiceTest anchored
BR-UNSUB-001 / BR-INT-001 ReportLeadControllerTest anchored

待补 gap 清单

优先级 gap 状态
User.password @JsonIgnore
domain 回填 / 覆盖审计过期
寄语/退订/周期规则连通
成片三态 / 失败归类单测 ReportHighlightVideoServiceTest
寄语幂等独立用例 ReportTestimonialServiceTest
rule:BR-STORE-003 公开 Store 字段裁剪 toPublicStoreView
uk_report_appointment 上线迁移 🟡 运维
埋点事件可统计落地 🟡 P1
production profile 实测启动 🟡
成片真 FFmpeg 端到端集成测(本机有 ffmpeg 🟡 单测已覆盖状态机与归类
action:logout / event:session_revoked 服务端吊销 🟡 gap
废弃 register_store / wechat OAuth demo 代码路径 🟡 deprecated 已标
会员/储值/套餐/历史报告/看板 gap 占位,不展开

P1/P2 方向jsonl 已占位)

  • entity:membership / stored_value / service_package — P1/P2
  • entity:report_history / analytics_dashboard — P2

本期不实现,仅 evidence=gap + jpa=false,避免本体膨胀成未实现产品说明书。受 rule:BR-ADMIN-004 约束,不得写入 Phase A 门店后台设计

门店 Web 后台 Phase A 预录入2026-07-10

产品:docs/门店管理后台升级方案-对标宠老板.md。全部 documented / gap尚未编码

ID 类型 用途
entity:admin_console Entity Web 管理端壳
entity:workbench / workbench_todo_item Entity 今日工作台与待办
entity:store_customer Entity 门店客户稳定主档(非会员卡)
action:view_workbench 等 8 个 admin_* Action 工作台/列表/设置/排班
rule:BR-ADMIN-001004 Rule 角色、店范围、内部字段、范围闸门
event:workbench_viewed Event 可选埋点gap

设计阶段每个页面 brief 应带 ontologyRefs(例:[entity:workbench, action:view_workbench, rule:BR-ADMIN-001])。

页面清单 PRD已写docs/门店管理后台-PhaseA-页面清单PRD.mdA0A7 全页字段/筛选/API/验收)。

当前 validate 规模以脚本输出为准(约 222 条目)。