| name | cheatsheet-review-skill |
| description | 为本仓库的单个 cheatsheet topic 做质量评审与完整度审核的技能。用于检查 `cheatsheets/<topic>/` 的内容是否匮乏、是否存在事实错误、版本或命令是否过时、结构是否适配主题、以及 topic 内文件是否一致;当用户提到评审完整度、做质量审核、检查内容是否匮乏、检查有没有错误、判断这份 cheatsheet 能否发布时使用。仅输出评审结论、问题分级、证据与修复建议,不直接改写内容。 |
cheatsheet-review-skill
为 cheatsheets/<topic>/ 生成结构化质量评审结果,判断该 topic 是否可用、是否匮乏、是否存在高风险错误。
评审边界
- 只评审单个
cheatsheets/<topic>/
- 重点检查
<topic>.md,并核对同目录内 meta.yml、refmap.md 与正文的一致性
- 只输出评审结果,不直接修正文档
- 需要联网核验;优先使用官方文档、官方仓库、发布说明、release notes
- 若用户明确只看某一维度,收缩到该维度;否则做完整审核
评审目标
- 判断内容是否匮乏,而不是只看字数或章节数量
- 判断命令、参数、概念解释、版本、链接映射是否存在错误
- 判断正文结构是否匹配主题类型,而不是机械套模板
- 判断 topic 内源文件是否能互相支撑,避免正文、元数据、引用来源互相脱节
审查输入
- 读取
cheatsheets/<topic>/ 现有文件
- 识别主题类型与正文风格,参考
../cheatsheet-maker-skill/SKILL.md 的风格判定与文件规范
- 联网核验该主题的官方资料、仓库、版本信息与核心用法
- 结合
references/review-rubric.md 做分级判断
核心判断维度
内容完整度
事实正确性
版本时效性
结构适配度
来源可追溯性
topic 内文件一致性
安装方式完整性
若某一维度证据不足,不要臆断;应标记为”待核验”并说明缺口。
内容完整度判定
- 不是按篇幅打分,而是按“是否覆盖读者完成高频任务所需的关键内容”打分
- 优先检查是否缺少以下高价值内容:
- 核心命令、API、语法或配置项
- 高频场景、典型 workflow、常见 recipes
- 关键参数、前提条件、结果差异、常见坑
- 对主题定位有决定性的模块、角色、子命令、子系统
- 若正文只有零散示例、缺少最小工作路径,通常应判为匮乏
- 若正文覆盖面宽但遗漏关键入口或核心场景,也应判为匮乏
- 若该 topic 涉及可安装的工具/库/CLI,需检查安装说明是否覆盖该工具支持的主要平台/环境;若缺少主流平台的安装方式,视为内容缺失
错误判定
- 对以下问题做重点检查:
- 命令、参数、选项、示例代码与官方用法不符
- 版本号、发布日期、仓库信息、链接归属错误
- 概念解释错误,或把不同能力混为一谈
refmap.md 无法为正文关键结论提供来源
meta.yml 与正文、仓库事实不一致
- 正文声称支持某能力,但官方资料不支持
- 对可能随版本变化的内容必须联网确认,不靠记忆硬判
结构适配度判定
- 不要求所有 topic 长得一样;要判断结构是否适合该主题
- 若主题明显适合普通 cheatsheet,却写成空泛场景文案,记为结构失配
- 若主题明显需要 cookbook 或混合风格,却只堆命令清单,记为结构失配
- 若章节顺序导致读者无法快速找到入口、最小工作流或高频内容,记为可用性问题
- 安装说明应在靠前位置(紧随快速定位或一眼入口之后),不在末尾才出现
评审输出
输出应固定包含以下内容:
总评级
结论摘要
主要问题
内容匮乏项
错误项
证据与来源
修复优先级建议
若问题较少,也不要省略这些栏目;可以写“无明显问题”。
评级规则
- 评级与触发条件见
references/review-rubric.md
- 默认输出四级:
A 通过
B 轻微问题
C 明显匮乏或存在错误
D 高风险不可用
执行流程
- 识别目标 topic,并读取该目录现有文件
- 判断本次评审范围是完整审核还是单维度审核
- 读取正文、
meta.yml、refmap.md,提炼主题结构与关键断言
- 参考
../cheatsheet-maker-skill/SKILL.md,判断该主题本应采用的内容组织方式
- 联网核验官方资料、官方仓库、版本与关键命令
- 按
references/review-rubric.md 分维度记录问题、证据、影响等级
- 汇总总评级,并输出结构化评审结果
- 若用户后续要求修复,再交由
cheatsheet-maker 或其他相关技能处理
自检
- 已联网,而不是仅凭本地文件下结论
- 已区分“内容匮乏”和“事实错误”,未混写
- 结论有证据支撑,不是笼统评价
- 已覆盖正文、
meta.yml、refmap.md 的一致性
- 已说明评级依据与问题优先级
- 未直接改动 topic 内容