SuperAPI AI 工具集

prowler-tour

测试与质量

查看项目

更新于 10-16 04:35

技能介绍

用途:prowler-tour 用于让产品导览定义与它们所描述的 UI 功能保持对齐。触发场景是修改了带有关联导览的 UI 组件,或编辑导览本身。该技能为只报告模式,绝不编辑导览文件或 UI 文件,只检查变更、报告发现的漂移,并建议开发者自行采取的操作。

主要能力:先执行提前退出规则——用 Glob 匹配 ui/lib/tours/*.tour.ts,逐个检查导览的 coversFiles 通配模式是否匹配当前变更中的文件;若无匹配,则原样输出“No tour affected — skipping alignment check”并退出,不进入检查清单。若有匹配,则对受影响导览执行漂移检查清单,逐项评估并明确列出检查了哪些项:孤立选择器(每个步骤的 target 组合成 data-tour-id="<tour-id>-<step.target>",必须在代码库中解析到真实元素,在 ui/ 中 grep 期望属性值,报告缺失 target 的步骤)、重命名选择器(本次变更编辑了 data-tour-id 属性,需匹配回引用旧值的导览步骤)、过时文案(弹窗标题/描述引用了被覆盖页面上已不存在的按钮标签、标题或术语)、废弃步骤(步骤描述了已被移除的区块、面板或工作流)、缺失步骤(被覆盖界面新增了功能却没有对应步骤,如新面板、新主操作、新向导阶段)、流程重排(用户路径改变,步骤顺序不再反映它)。

版本号决策:列出漂移后按导览应用。外观性变更不升版本,例如修正错别字、软化文案、重命名 data-tour-id 选择器但保持同一步骤、替换截图、精简措辞。用户可见流程发生实质变化时升版本,例如新增或删除步骤、顺序改变、锚定目标改指向不同面板、导览覆盖了界面上新功能。存疑时自问:已看过旧版本的用户若错过本版本,是否会漏掉有用内容?若是则升版本。

输出格式:发出报告时须严格遵循 references/output-format.md 中的结构,该结构是强制的,因为报告会被下游消费,不容忍字段重排。

限制:不得编辑 *.tour.ts 文件;不得编辑 UI 文件来添加或重命名 data-tour-id 属性;不得发明新导览(编写新导览是独立的、有意的决定,由开发者做出);不得对 coversFiles 不匹配当前变更任何文件的导览标记漂移,须遵守提前退出规则。

相关文件:references/output-format.md 为精确报告模板(发出报告时阅读);references/tours-architecture.md 为 ui/lib/tours/ 下导览抽象的代码地图;assets/tour-template.ts 为编写新 *.tour.ts 的样板。