关于 write-a-skill
Writing Skills 是指导创建和审阅 Agent Skill 的 Skill,涵盖需求收集、起草和用户反馈。它还说明文件结构、描述撰写、脚本添加及拆分参考文件的条件。
主要功能
- 01收集 Skill 需求
- 02规定标准 Skill 结构
- 03提供 SKILL.md 描述撰写指南
- 04明确添加实用脚本的条件
- 05提供文件拆分与审阅清单
适用场景
- 01为新领域起草 Skill
- 02判断是否需要添加实用脚本
- 03注册前审阅 Skill
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ ashexplained/ roblox-skills --skill write-a-skill安装后在 Claude Code 中输入/write-a-skill确认已加载。
详细介绍
编写 Skills
流程
-
收集需求 - 询问用户:
- 这项 skill 涵盖什么任务/领域?
- 它应处理哪些具体用例?
- 是否需要可执行脚本,还是只需要说明?
- 是否需要包含任何参考资料?
-
起草 skill - 创建:
- 包含简洁说明的 SKILL.md
- 内容超过 500 行时,创建额外的参考文件
- 需要确定性操作时,创建实用脚本
-
与用户审核 - 展示草稿并询问:
- 是否涵盖了你的用例?
- 有没有遗漏或不清楚的内容?
- 哪些部分需要更详细或更简略?
Skill 结构
skill-name/
├── SKILL.md # Main instructions (required)
├── REFERENCE.md # Detailed docs (if needed)
├── EXAMPLES.md # Usage examples (if needed)
└── scripts/ # Utility scripts (if needed)
└── helper.js
SKILL.md 模板
---
name: skill-name
description: Brief description of capability. Use when [specific triggers].
---
# Skill Name
## Quick start
[Minimal working example]
## Workflows
[Step-by-step processes with checklists for complex tasks]
## Advanced features
[Link to separate files: See [REFERENCE.md](REFERENCE.md)]
描述要求
当 Agent 决定加载哪个 skill 时,描述是它唯一能看到的内容。它会与所有其他已安装的 skill 一起显示在系统提示词中。Agent 会阅读这些描述,并根据用户的请求选择相关的 skill。
目标:向 Agent 提供足够的信息,让它了解:
- 这项 skill 提供什么能力
- 何时/为何触发(具体关键词、上下文、文件类型)
格式:
- 最多 1024 个字符
- 使用第三人称
- 第一句:说明它的用途
- 第二句:“Use when [具体触发条件]”
示例(良好):
Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when user mentions PDFs, forms, or document extraction.
示例(不佳):
Helps with documents.
这个不佳示例无法让 Agent 将此 skill 与其他文档类 skill 区分开来。
何时添加脚本
出现以下情况时添加实用脚本:
- 操作具有确定性(验证、格式化)
- 会反复生成相同的代码
- 需要显式处理错误
与生成代码相比,脚本可以节省 token 并提高可靠性。
何时拆分文件
出现以下情况时,将内容拆分到单独的文件中:
- SKILL.md 超过 100 行
- 内容涉及不同领域(金融与销售架构)
- 很少需要高级功能
审核清单
起草后,检查:
- 描述中包含触发条件(“Use when...”)
- SKILL.md 少于 100 行
- 不包含时效性信息
- 术语一致
- 包含具体示例
- 参考资料的引用深度为一层
下一步
创建 skill 后,运行 setup-roblox-skills,将它注册到项目的路由区块中,让 Claude 了解其用途、使用场景和触发词。
评论
支持 Markdown