SuperAPI AI 工具集

claude-skills

智能体与模型

查看项目

更新于 10-15 08:56

技能介绍

用途

Claude Skills 元技能用于把分散的领域资料(文档、API、代码、规范)转化为可复用、可维护、可可靠激活的 Skill。它本身不是某个领域的技能,而是用来构建领域技能的工具。

何时使用

  • 从文档、规范或代码仓库从零创建新 Skill
  • 重构已有 Skill(内容过长、不清晰、不一致、误触发)
  • 设计可靠的激活机制(frontmatter + 触发条件 + 边界)
  • 从大量资料中提炼简洁的 Quick Reference
  • 把长内容拆分为可导航的 references/
  • 添加质量门禁与校验器

不适用与边界

  • 它本身不是领域 Skill(它构建领域 Skill)
  • 不允许编造外部事实:资料无法证明的内容应说明并给出验证路径
  • 不能替代必需输入:输入缺失时应先提出 1-3 个问题再继续

交付物

输出必须包含:

  • 具体的目录布局(通常为 skills/<skill-name>/)
  • 可执行的 SKILL.md,含可判定的触发条件、边界与可复现示例
  • 长文档移入 references/,并附 references/index.md
  • 交付前检查清单(Quality Gate)

推荐目录布局(最小到完整)

skill-name/
|-- SKILL.md              # 必需:带 YAML frontmatter 的入口
|-- references/           # 可选:长文档/证据/索引
|   `-- index.md          # 推荐:导航索引
|-- scripts/              # 可选:辅助脚本/自动化
`-- assets/               # 可选:模板/配置/静态资源

真正最小版本只需 SKILL.md,references/ 可后续添加。

YAML Frontmatter(必需)

---
name: skill-name
description: "What it does + when to use (activation triggers)."
---

规则:

  • name 必须匹配 ^[a-z][a-z0-9-]*$,且应与目录名一致
  • description 必须可判定(不能是“helps with X”),并包含具体触发关键词

SKILL.md 最小骨架(可复制粘贴)

---
name: my-skill
description: "[Domain] capability: includes [capability 1], [capability 2]. Use when [decidable triggers]."
---

# my-skill Skill

One sentence that states the boundary and the deliverable.

## When to Use This Skill

Trigger when any of these applies:
- [Trigger 1: concrete task/keyword]
- [Trigger 2]
- [Trigger 3]

## Not For / Boundaries

- What this skill will not do (prevents misfires and over-promising)
- Required inputs; ask 1-3 questions if missing

## Quick Reference

### Common Patterns

**Pattern 1:** one-line explanation
```text
[command/snippet you can paste and run]

Examples

Example 1

Input:

Steps:

Expected output / acceptance:

Example 2

Example 3

References

  • references/index.md: navigation
  • references/...: long-form docs split by topic

Maintenance

  • Sources: docs/repos/specs (do not invent)
  • Last updated: YYYY-MM-DD
  • Known limits: what is explicitly out of scope

## 编写规则(不可协商)

1. Quick Reference 用于简短、可直接使用的模式
   - 尽量不超过 20 个模式
   - 需要成段解释的内容放入 references/
2. 激活必须可判定
   - frontmatter 的 description 应说明“做什么 + 何时用”,含具体关键词
   - “When to Use” 必须列出具体任务/输入/目标,而非模糊的帮助文本
   - “Not For / Boundaries” 为可靠性所必需
3. 不对外部细节含糊其辞
   - 资料无法证明的内容应说明并给出验证路径

## 工作流(资料 -> Skill)

不要跳过步骤:

1. 范围:写出 MUST/SHOULD/NEVER(三句话即可)
2. 提炼模式:挑选 10-20 个高频模式(命令/片段/流程)
3. 添加示例:至少 3 个端到端示例(输入 -> 步骤 -> 验收)
4. 定义边界:范围外内容 + 必需输入
5. 拆分 references:长文本移入 references/ 并编写 references/index.md
6. 应用门禁:运行检查清单与校验器

## 质量门禁(交付前检查清单)

最低检查项(完整版见 references/quality-checklist.md):

1. name 匹配 ^[a-z][a-z0-9-]*$ 且与目录名一致
2. description 说明“做什么 + 何时用”,含具体触发关键词
3. 有 “When to Use This Skill” 且触发条件可判定
4. 有 “Not For / Boundaries” 以减少误触发
5. Quick Reference 不超过 20 个模式且每个可直接使用
6. 至少 3 个可复现示例
7. 长内容位于 references/ 且 references/index.md 可导航
8. 不确定的声明包含验证路径(不含糊其辞)
9. 读起来像操作手册,而非文档堆砌

本地校验:

```bash
# 从仓库根目录(基础校验)
./skills/claude-skills/scripts/validate-skill.sh skills/<skill-name>

# 从仓库根目录(严格校验)
./skills/claude-skills/scripts/validate-skill.sh skills/<skill-name> --strict

# 从 skills/claude-skills/ 目录(基础校验)
./scripts/validate-skill.sh ../<skill-name>

# 从 skills/claude-skills/ 目录(严格校验)
./scripts/validate-skill.sh ../<skill-name> --strict

工具与模板

生成新 Skill 骨架:

# 从仓库根目录(生成到 ./skills/)
./skills/claude-skills/scripts/create-skill.sh my-skill --full --output skills

# 从 skills/claude-skills/ 目录(生成到 ../ 即 ./skills/)
./scripts/create-skill.sh my-skill --full --output ..

# 最小骨架
./skills/claude-skills/scripts/create-skill.sh my-skill --minimal --output skills

模板:

  • assets/template-minimal.md
  • assets/template-complete.md

示例

示例 1:从文档创建 Skill

输入:官方文档/规范 + 2-3 个真实代码示例 + 常见失败模式

步骤:

  1. 运行 create-skill.sh 搭建 skills/<skill-name>/
  2. 将 frontmatter description 写为“做什么 + 何时用”
  3. 提炼 10-20 个高频模式到 Quick Reference
  4. 添加至少 3 个带验收标准的端到端示例
  5. 将长内容放入 references/ 并连接 references/index.md
  6. 运行 validate-skill.sh --strict 并迭代

示例 2:重构“文档堆砌”型 Skill

输入:已有 SKILL.md,内含大段粘贴的文档

步骤:

  1. 区分哪些是模式、哪些是长篇解释
  2. 将长篇文本移入 references/(按主题拆分)
  3. 将 Quick Reference 改写为简短可复制的模式
  4. 添加或修正示例直至可复现
  5. 添加 “Not For / Boundaries” 以减少误触发

示例 3:校验与门禁

输入:skills/<skill-name>/

步骤:

  1. 运行 validate-skill.sh(非严格)获取警告
  2. 修复 frontmatter/name 不匹配与缺失章节
  3. 运行 validate-skill.sh --strict 强制执行规范
  4. 发布前运行 references/quality-checklist.md 中的评分标准

参考资料

本地文档:

  • references/index.md
  • references/skill-spec.md
  • references/quality-checklist.md
  • references/anti-patterns.md
  • references/README.md(上游官方参考)

外部(官方):

  • https://support.claude.com/en/articles/12512176-what-are-skills
  • https://support.claude.com/en/articles/12512180-using-skills-in-claude
  • https://support.claude.com/en/articles/12512198-creating-custom-skills
  • https://docs.claude.com/en/api/skills-guide

维护

  • 来源:skills/claude-skills/references/ 中的本地规范文件 + references/README.md 中的上游官方文档
  • 最后更新:2025-12-14
  • 已知限制:validate-skill.sh 为启发式;严格模式假定使用推荐的章节标题