知识点思维导图
21 个知识节点
参考资料
Skill（04） - SKILL.md 元数据
读完后，你应能完成以下任务：
- 绘制“Skill（04） - SKILL.md 元数据 / frontmatter 是什么”的关键对象与数据流，解释“这段就叫 frontmatter（前置元数据），用的是 YAML 格式。”，并用源码位置、日志或 Trace 标注证据。
- 为“Skill（04） - SKILL.md 元数据 / 两个核心字段”设计正常与异常输入，验证“它是触发开关，重要到我们专门用第 05 章来讲怎么写。”，输出首个偏差位置与回归测试结果。
- 实现“Skill（04） - SKILL.md 元数据 / name（必填）”的最小代码或配置，检验“用小写字母 + 连字符（kebab-case），如 code-review、pdf-report。”，输出命令、结果与 Diff，并说明不适用边界。
本章目标：把
SKILL.md开头那段被---包起来的元数据讲清楚——哪些必填、哪些可选、各自怎么写。学完你会拿到一份字段速查表。
一、先建立全局：SKILL.md 元数据 是什么？
理解“SKILL.md 元数据”，先要把标题中的对象放进同一条处理链：它接收什么输入，经过哪些状态变化，最终用什么证据判断结果。下表不另造概念，只把作者正文已经解释的章节按依赖顺序连起来。
“SKILL.md 元数据”的第一个核心判断是：这段就叫 frontmatter（前置元数据），用的是 YAML 格式。。先弄清这个判断中的对象和输入输出，后面的实现、故障和验收才有共同语境。
| 顺序 | 章节 | 读完本节应抓住的结论 |
|---|---|---|
| 1 | frontmatter 是什么 | 这段就叫 frontmatter（前置元数据），用的是 YAML 格式。 |
| 2 | 两个核心字段 | 它是触发开关，重要到我们专门用第 05 章来讲怎么写。 |
| 3 | 可能遇到的其它可选字段 | ⚠️ 提示：可选字段的具体支持情况会随版本变化。 |
| 4 | 常见错误 | ❌ --- 不成对或写错：开头结尾必须各是恰好三个横线、单独成行。 |
| 5 | 最佳实践 | 值里有特殊字符就加引号：尤其是中文冒号、英文冒号、# 等，用双引号包住最安全。 |
| 6 | 它的角色是「目录卡片」 | 它的角色是「目录卡片」：Claude 平时只扫这张卡片，来决定「这个技能要不要加载」。 |
1.1 核心对象之间怎样衔接
flowchart LR
S1["frontmatter 是什么"] --> S2
S2["两个核心字段"] --> S3
S3["可能遇到的其它可选字段"] --> S4
S4["常见错误"] --> S5
S5["最佳实践"]
这张图只表达本文的讲解顺序，不替代正文机制。判断“SKILL.md 元数据”是否真正掌握，需要能从最后一个结果沿图回到前面每个章节的输入、状态变化和证据。
1.2 再看失败：问题最早会出现在哪一步？
在“SKILL.md 元数据”的对象和顺序已经明确后，再看可观察的失败：条件缺失、结果不可复现或失败后责任不清。定位时不从最后一条错误猜原因，而是沿上图找第一个偏离正文结论的节点。
二、frontmatter 是什么
每个 SKILL.md 的最开头，都有一段被两行 --- 夹住的内容：
---
name: code-review
description: 当用户需要审查代码质量、查找 bug 时使用。
---
# 这里开始是正文……
这段就叫 frontmatter（前置元数据），用的是 YAML 格式。 它的角色是「目录卡片」：Claude 平时只扫这张卡片，来决定「这个技能要不要加载」。 正文则要等技能真被选中后才读。
所以记住一个关键差异：
frontmatter 永远在「待命扫描」阶段就被读取；正文只有技能被触发后才加载。
这也意味着：frontmatter 要短而精， 因为所有技能的 frontmatter 都常驻在 Claude 的「待选清单」里， 太长就是公共开销。
三、两个核心字段
绝大多数技能，frontmatter 只需要这两个字段：
3.1 name（必填）
技能的唯一标识。规则：
- 用小写字母 + 连字符（kebab-case），如
code-review、pdf-report。 - 不要用空格、大写、中文。
- 强烈建议和文件夹名一致，省得自己混乱。
name: code-review # ✅ 好
name: CodeReview # ❌ 不要用大写驼峰
name: 代码审查 # ❌ 不要用中文
name: code review # ❌ 不要用空格
3.2 description（必填，且最重要）
一句话说明「这个技能在什么场景下该被用」。 它是触发开关，重要到我们专门用第 05 章来讲怎么写。 这里先记住三个要点：
- 用第三人称、描述场景：「当用户需要……时使用」。
- 写清楚触发的关键词和场景，别只写技能名。
- 别太长，一两句话讲清「干什么 + 什么时候用」即可。
# ✅ 好：说清了场景和触发词
description: 当用户需要审查代码质量、查找 bug、检查安全漏洞时使用。
# ❌ 差：太干，Claude 不知道啥时候该用
description: 代码审查工具
四、可能遇到的其它可选字段
不同版本/平台支持的可选字段略有差异，常见的有这几类（用到再查，不必背）：
| 字段 | 作用 | 说明 |
|---|---|---|
license |
标明许可证 | 分享给他人时有用 |
allowed-tools |
限制技能能用的工具 | 用于收紧权限、提升安全性 |
metadata |
附加元信息 | 版本号、作者等自定义信息 |
⚠️ 提示：可选字段的具体支持情况会随版本变化。拿不准时，只写
name+description这两个必填项最稳，其余等明确需要时再加。
五、字段速查表
| 字段 | 必填? | 格式 | 一句话记忆 |
|---|---|---|---|
name |
✅ | 小写+连字符 | 技能的身份证，和文件夹同名 |
description |
✅ | 一两句话，讲场景 | 触发开关，决定「啥时候用它」 |
| 其它可选字段 | ❌ | 视字段而定 | 用到再查，别瞎加 |
六、常见错误
- ❌ YAML 缩进/格式坏了：
description:后面忘了空格、或值里有特殊字符（如冒号:）没加引号。
description: 工具：用于审查 # ❌ 值里的冒号可能让 YAML 解析出错 description: "工具：用于审查" # ✅ 有歧义时用引号包起来最保险
- **❌ `---` 不成对或写错**：开头结尾必须各是**恰好三个**横线、单独成行。
- **❌ `name` 用了中文或空格**：会导致识别异常。
- **❌ 把正文内容写进了 frontmatter**：frontmatter 只放元数据键值对，操作步骤是正文的事。
- **❌ 乱加没用的字段**：写一堆模型不认识的字段，徒增噪音甚至报错。
# 七、最佳实践
- **能省则省**：新手只写 `name` + `description`，先跑通。
- **`name` 与文件夹同名**：减少心智负担。
- **值里有特殊字符就加引号**：尤其是中文冒号、英文冒号、`#` 等，用双引号包住最安全。
- **改完 frontmatter 必测触发**：它直接决定技能能否被加载，改完一定用「埋暗号」法验证一下。
# 八、动手实践：04 章 Demo · frontmatter 好坏对照
这个 Demo 给你两份 `SKILL.md`：一份 frontmatter 写得规范，
一份满是新手常犯的错。
对照着看，你就记住了。
## 8.1 文件
```text
05-元数据frontmatter-demo/
├── README.md
├── good-SKILL.md # ✅ 规范的 frontmatter
└── bad-SKILL.md # ❌ 故意写错，找找有几处问题
8.2 玩法
- 先不看答案，打开
bad-SKILL.md，自己找出里面的格式错误（至少有 4 处）。 - 再对照
good-SKILL.md，看自己找全了没。 - 答案和讲解在本文件最下方。
8.3 bad-SKILL.md 的 4 个坑（看完再展开核对）
name用了大写和空格：Code Review→ 应为code-review。description后缺空格：description:当用户……→ 冒号后要有空格。- 值里的中文冒号没加引号：
代码审查：查找bug里的：可能让 YAML 解析异常 → 用双引号包住。 - 结尾
---写成了两个横线--→ 必须是恰好三个横线，否则 frontmatter 不闭合，整个技能加载失败。
8.4 你会收获什么
- 一眼认出 frontmatter 的常见格式错误。
- 养成「改完 frontmatter 就检查
---成对、冒号带空格」的肌肉记忆。
8.5 配套实践材料
以下材料已并入正文，便于阅读时直接对照和练习。
bad-SKILL.md
---
name: Code Review
description:代码审查：查找bug
--
# 代码审查
这份 frontmatter 故意埋了 4 个错误，对照 README 找找看。
（提示：name、冒号后的空格、值里的中文冒号、结尾的横线数量。）
good-SKILL.md
---
name: code-review
description: 当用户需要审查代码质量、查找 bug、检查安全漏洞或代码规范问题时使用。
---
# 代码审查
这是一份 frontmatter 规范的示例：
- name 用小写加连字符，且与文件夹同名
- description 用第三人称描述场景，讲清「什么时候该用」
- 三个横线成对闭合，冒号后有空格
（正文从这里开始……）
九、动手验证：先跑通 SKILL.md 元数据，再改变一个变量
前面的章节已经建立问题、概念和机制。现在把“SKILL.md 元数据”放进同一套基线中运行；本节不再引入新术语，只验证前文结论能否被复现。
9.1 基线与候选只允许一个变量不同
验证“SKILL.md 元数据”时，先固定样本、基线、候选、成功标准和失败边界。候选方案只能改变本次要验证的变量；如果同时更换数据、依赖和配置，即使结果改善，也不能知道是哪一项产生作用。
执行“SKILL.md 元数据”时，动作是：同环境运行基线与候选，记录输入、中间状态和异常。原始结果不能只保留截图或汇总分数，必须同步保存：可重放命令、结构化日志、输出 Diff、失败样本、版本，使下一次复查可以在同一输入上重放。
| 实验要素 | 本文要求 |
|---|---|
| 固定条件 | 固定样本、基线、候选、成功标准和失败边界 |
| 唯一变量 | 本次候选方案与基线之间的一项明确差异 |
| 原始证据 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 |
| 通过阈值 | 结果符合结论条件，异常输入可解释、可恢复 |
| 立即停止 | 条件缺失、结果不可复现或失败后责任不清 |
9.2 执行前先排除不可比较条件
“SKILL.md 元数据”开始前先确认下面四项；任一项不成立，都应先修复实验条件，而不是解释结果。
- 基线能够在“SKILL.md 元数据”的当前环境重复运行。
- 候选只改变一个与“SKILL.md 元数据”结论直接相关的条件。
- “SKILL.md 元数据”的基线和候选使用同一批输入、同一版本依赖与同一通过阈值。
- “SKILL.md 元数据”的原始输出和失败现场不会被重试、格式化或汇总覆盖。
9.3 执行后先核对证据完整性
结果出来后先检查证据，再讨论“SKILL.md 元数据”是否通过。缺少中间状态时，最终输出只能说明现象，不能证明机制。
| 检查项 | 当前文章的判定 |
|---|---|
| 输入可追溯 | 固定样本、基线、候选、成功标准和失败边界 |
| 过程可回放 | 同环境运行基线与候选，记录输入、中间状态和异常 |
| 结果可审计 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 |
“SKILL.md 元数据”的一次合格基线对照按以下顺序执行：
- 保存“SKILL.md 元数据”基线版本及输入摘要，确认基线本身可以重复运行。
- 写下“SKILL.md 元数据”候选方案唯一变化的变量，以及它预期影响的指标。
- 在同一环境执行“SKILL.md 元数据”：同环境运行基线与候选，记录输入、中间状态和异常。
- 为“SKILL.md 元数据”保存：可重放命令、结构化日志、输出 Diff、失败样本、版本。
- 使用“SKILL.md 元数据”预登记条件判断：结果符合结论条件，异常输入可解释、可恢复。
- 如果“SKILL.md 元数据”未通过，不修改第二个变量，先恢复基线并保留失败现场。
十、用一张矩阵验证 SKILL.md 元数据 的关键结论
矩阵按正文顺序列出“SKILL.md 元数据”的结论。一次实验只选择一行，只改变这一行对应的条件；不要把多行合并成一个无法归因的大实验。
| 正文章节 | 已解释的结论 | 本轮唯一变量 | 必须保存的证据 |
|---|---|---|---|
| frontmatter 是什么 | 这段就叫 frontmatter（前置元数据），用的是 YAML 格式。 | 只改变与“frontmatter 是什么”相关的条件 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 |
| 两个核心字段 | 它是触发开关，重要到我们专门用第 05 章来讲怎么写。 | 只改变与“两个核心字段”相关的条件 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 |
| 可能遇到的其它可选字段 | ⚠️ 提示：可选字段的具体支持情况会随版本变化。 | 只改变与“可能遇到的其它可选字段”相关的条件 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 |
| 常见错误 | ❌ --- 不成对或写错：开头结尾必须各是恰好三个横线、单独成行。 | 只改变与“常见错误”相关的条件 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 |
| 最佳实践 | 值里有特殊字符就加引号：尤其是中文冒号、英文冒号、# 等，用双引号包住最安全。 | 只改变与“最佳实践”相关的条件 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 |
| 它的角色是「目录卡片」 | 它的角色是「目录卡片」：Claude 平时只扫这张卡片，来决定「这个技能要不要加载」。 | 只改变与“它的角色是「目录卡片」”相关的条件 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 |
10.1 记录本次实际实验
下面的记录用于“SKILL.md 元数据”当前这一次实验，不是第二套知识目录。先从矩阵选择一个章节，再填写实际值；没有填写的字段表示尚未验证。
topic: "SKILL.md 元数据"
selected_chapter: required
claim_from_article: required
baseline_version: required
changed_condition: exactly_one
execution: "同环境运行基线与候选，记录输入、中间状态和异常"
evidence: "可重放命令、结构化日志、输出 Diff、失败样本、版本"
pass_when: "结果符合结论条件，异常输入可解释、可恢复"
stop_when: "条件缺失、结果不可复现或失败后责任不清"
observed_result: required
first_deviation: null_or_evidence
recovery_replay: required_after_failure
10.2 边界实验必须证明能够停止和恢复
成功路径只能证明“SKILL.md 元数据”在当前样本上工作，不能证明它可以进入生产。边界实验需要主动制造：条件缺失、结果不可复现或失败后责任不清，并观察系统是否在产生不可逆副作用前停止。
| 场景 | 只改变什么 | 应保存什么 | 通过标准 |
|---|---|---|---|
| 正常路径 | 使用已知有效输入 | 可重放命令、结构化日志、输出 Diff、失败样本、版本 | 结果符合结论条件，异常输入可解释、可恢复 |
| 边界路径 | 把一个输入推进到约束临界值 | 临界值前后的输出与指标 | 不静默降级，不把部分结果冒充成功 |
| 明确失败 | 注入：条件缺失、结果不可复现或失败后责任不清 | 原始错误、首个异常阶段和最终状态 | 失败被正确分类且没有扩大副作用 |
| 恢复重放 | 执行：保留基线，缩小变量；根因确认前不扩大范围 | 原失败样本的复测证据 | 原样本恢复，正常样本没有回归 |
恢复动作不是简单重启。对于“SKILL.md 元数据”，第一步是：保留基线，缩小变量；根因确认前不扩大范围。完成后使用原始失败样本复测；只验证一个新样本成功，不能证明触发条件已经消失。
“SKILL.md 元数据”边界实验结束后，应把正常、临界、失败和恢复四类记录放在同一个运行批次中。这样才能区分“候选方案真的修复问题”和“环境变化让问题暂时没有出现”。
十一、SKILL.md 元数据 的结果解释
解释“SKILL.md 元数据”实验时先看首个偏差，而不是最后一条错误。最后的异常通常只是上游状态错误的结果；从末端反推容易误把症状当根因。
| 观察结果 | 可以支持的判断 | 下一步 |
|---|---|---|
| 主链路没有达到预期 | 条件缺失、结果不可复现或失败后责任不清 | 先执行：保留基线，缩小变量；根因确认前不扩大范围 |
| 异常链路无法恢复 | 条件缺失、结果不可复现或失败后责任不清 | 先执行：保留基线，缩小变量；根因确认前不扩大范围 |
| 新样本成功但原样本仍失败 | 修复没有覆盖原始触发条件 | 固定原失败输入，恢复基线后重新比较 |
| 指标改善但证据无法回链 | 数据、版本或中间状态没有固定 | 暂停发布，补齐可追溯记录后重跑 |
“SKILL.md 元数据”只有同时满足“结果符合结论条件，异常输入可解释、可恢复”，并且没有出现“条件缺失、结果不可复现或失败后责任不清”，才可以认为主链路通过。这里的“通过”只对当前固定版本、样本和环境有效，不能外推到尚未测试的容量、权限或数据分布。
如果“SKILL.md 元数据”候选方案与基线差异很小，先检查证据分辨率是否足够；如果差异很大，先排除数据泄漏、环境漂移和版本不一致。两种情况都不能只看一个汇总均值，需要回到逐样本输出和中间状态。
“SKILL.md 元数据”故障定位完成后，记录“现象、首个偏差、根因、改动、原样本复测”五项。缺少原样本复测时，只能标记为待观察，不能标记为已解决。
十二、SKILL.md 元数据 的发布判断
发布判断需要把“SKILL.md 元数据”的质量、失败边界和恢复能力放在同一份记录中。以下任一条件缺失，都应停止扩量，而不是用“基本正常”替代证据。
- “SKILL.md 元数据”的基线与候选只存在一个计划内变量。
- “SKILL.md 元数据”的输入、代码、依赖、配置和数据版本可以追溯。
- “SKILL.md 元数据”的正常、临界、失败和恢复样本使用同一套断言。
- “SKILL.md 元数据”的原始输出、中间状态和失败现场已经保留。
- “SKILL.md 元数据”的日志、Trace、截图和测试数据已经脱敏。
- “SKILL.md 元数据”的停止条件、负责人和回滚入口已经演练。
- “SKILL.md 元数据”尚未覆盖的输入、权限、容量和外部依赖已经登记。
最终记录至少包含基线版本、唯一变量、原始证据、首个偏差、恢复复测和发布责任人。没有参与本次修改的人如果不能据此重放“SKILL.md 元数据”的判断，就不能发布。
十三、总结
- frontmatter 是什么：这段就叫 frontmatter（前置元数据），用的是 YAML 格式。
- 两个核心字段：它是触发开关，重要到我们专门用第 05 章来讲怎么写。
- 可能遇到的其它可选字段：不同版本/平台支持的可选字段略有差异，常见的有这几类（用到再查，不必背）：
- 字段速查表：| description | ✅ | 一两句话，讲场景 | 触发开关，决定「啥时候用它」 |
- 常见错误：❌ --- 不成对或写错：开头结尾必须各是恰好三个横线、单独成行。
- 最佳实践：值里有特殊字符就加引号：尤其是中文冒号、英文冒号、# 等，用双引号包住最安全。
学完自测
选择所有正确答案；提交后逐项核对判断依据。