Back to Details

review-skill

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Review Skill

审核Skill

Goal

目标

  • Skill's flaws are identified, each paired with a suggested fix.
  • Findings are written to 
    TODO.md
    inside the skill's directory.
  • 识别Skill的缺陷，并为每个缺陷匹配对应的修复建议。
  • 将检查结果写入Skill目录下的
    TODO.md
    文件。

Input

输入

  • Skill name or path to the skill's directory (or its 
    SKILL.md
    ).
  • Skill名称或Skill目录（或其
    SKILL.md
    文件）的路径。

Steps

步骤

Step 1: Undraft

步骤1：解除草稿状态

Run 
/refine-text
on the skill's 
SKILL.md
first.
先对Skill的
SKILL.md
文件执行
/refine-text
命令。

Step 2: Review

步骤2：审核

Check the skill for:
  • Outdated frontmatter
  • Frontmatter 
    description
    not following convention (see below)
  • README.md 
    Meta info
    not following convention (see below)
  • Missing input description
  • Missing output description
  • Missing execution steps (for execution-kind skills)
  • Duplicate or redundant content (instructions, examples, descriptions)
  • Input/output schema mismatches with external skills, commands, etc.
  • Missing details or gaps
  • Ambiguous instructions
  • Inconsistencies with other similar skills
  • Reference mismatches: variables, names, scripts, paths, etc.
Classify each concern's severity on an absolute scale, not relative to what else was found - do not inflate a minor, unclear flaw into a major one just because the skill is otherwise clean. Do not invent issues that are not there.
检查Skill是否存在以下问题：
  • 过时的前置元数据
  • 前置元数据中的
    description
    不符合规范（见下文）
  • README.md中的
    Meta info
    不符合规范（见下文）
  • 缺少输入描述
  • 缺少输出描述
  • 缺少执行步骤（针对执行类Skill）
  • 重复或冗余内容（说明、示例、描述）
  • 输入/输出模式与外部Skill、命令等不匹配
  • 缺少细节或存在内容缺口
  • 说明模糊不清
  • 与其他同类Skill不一致
  • 引用不匹配：变量、名称、脚本、路径等
按照绝对标准对每个问题的严重程度进行分类，不要因为Skill在其他方面没有问题就将轻微、不明确的缺陷夸大为严重问题。不要编造不存在的问题。

Frontmatter description convention

前置元数据描述规范

A 
description
has two clauses, in order:
  1. Function - imperative verb, states what the skill does. One sentence, no fluff.
  2. Trigger - starts with "Use when/for/as/before/after ...", states the situation that should invoke it. Every skill needs this clause; a description without one is a flaw (e.g. "Merge, release, verify, prepare presentational info, announce" - lists actions, gives no trigger).
Add a third clause only to disambiguate from an adjacent/similarly-named skill: "invoke from 
x
", "standalone, or via 
y
", "in place of 
z
(which is for ...)". Backtick any referenced skill/command name.
Keep the whole thing to 1-3 sentences.
description
需包含两个分句，顺序如下：
  1. 功能 - 使用祈使动词，说明Skill的作用。一句话，无冗余内容。
  2. 触发场景 - 以“适用于/用于/当...时使用...”开头，说明应调用该Skill的场景。每个Skill都需要此分句；缺少该分句的描述即为缺陷（例如：“合并、发布、验证、准备展示信息、通知”——仅列出动作，未说明触发场景）。
仅当需要与相近/同名Skill区分时，才添加第三个分句：“从
x
调用”、“独立使用，或通过
y
调用”、“替代
z
（后者用于...）”。引用的Skill/命令名称需用反引号包裹。
整体长度控制在1-3句话。

README.md convention

README.md规范

The 
Meta info
section in README.md states why the skill exists - not what it does or when to use it, both already covered by the frontmatter 
description
. Flag it if missing, or if it restates function/trigger instead of rationale (e.g. history, relation to adjacent skills, design tradeoff).
README.md中的
Meta info
部分需说明Skill存在的原因——而非其功能或使用场景，这两项已在前述前置元数据的
description
中覆盖。如果该部分缺失，或重复说明功能/触发场景而非存在理由（例如：历史背景、与相近Skill的关系、设计权衡），则标记为问题。

Step 3: Report

步骤3：报告

For every concern found, suggest a solution. Write results to 
TODO.md
inside the skill's directory.
针对发现的每个问题，提出解决方案。将结果写入Skill目录下的
TODO.md
文件。

Output

输出

TODO.md
in the skill's directory, listing each concern with its suggested fix.
Skill目录下的
TODO.md
文件，列出每个问题及其对应的修复建议。