关于 write-a-skill
write-a-skill 指导 Agent 收集需求、编写技能草稿并与用户复核,也提供 SKILL.md 结构及描述、脚本和参考文件的编写标准。
主要功能
- 01需求收集问题
- 02SKILL.md 模板与结构
- 03描述编写标准
- 04脚本与文件拆分建议
- 05草稿复核清单
适用场景
- 01为新任务领域编写技能
- 02判断是否添加实用脚本
- 03组织较长或专业的技能内容
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ leandrocfe/ skills --skill write-a-skill安装后在 Claude Code 中输入/write-a-skill确认已加载。
详细介绍
编写技能
流程
-
收集需求 — 询问用户:
- 这项技能涵盖什么任务/领域?
- 应处理哪些具体用例?
- 需要可执行脚本,还是只需要说明?
- 有什么参考资料需要纳入?
-
起草技能 — 创建:
- 包含简洁说明的 SKILL.md
- 如果内容超过 500 行,则创建额外的参考文件
- 如果需要执行确定性操作,则创建实用脚本
-
与用户一起审阅 — 展示草稿并询问:
- 是否涵盖了您的用例?
- 是否有遗漏或令人困惑的地方?
- 哪些部分需要更详细或更简略?
技能结构
skill-name/
├── SKILL.md # Instruções principais (obrigatório)
├── REFERENCE.md # Docs detalhados (se necessário)
├── EXAMPLES.md # Exemplos de uso (se necessário)
└── scripts/ # Scripts utilitários (se necessário)
└── helper.js
SKILL.md 模板
---
name: skill-name
description: "Descrição breve da capacidade. Use quando [triggers específicos]."
---
# Skill Name
## Quick start
[Exemplo mínimo funcional]
## Workflows
[Processos passo-a-passo com checklists para tasks complexas]
## Advanced features
[Link para arquivos separados: Veja [REFERENCE.md](REFERENCE.md)]
Description 要求
description 是 Agent 在决定加载哪项技能时唯一能看到的内容。它会与所有其他已安装技能一起写入 system prompt。Agent 会阅读这些 description,并根据用户请求选择相关技能。
目标:提供恰到好处的信息,让 Agent 知道:
- 这项技能提供什么能力
- 何时/为何触发(具体关键词、上下文、文件类型)
格式:
- 最多 1024 个字符
- 使用第三人称
- 第一句:说明它的功能
- 第二句:“在 [具体触发条件] 时使用”
良好示例:
Extrai texto e tabelas de arquivos PDF, preenche forms, faz merge de documents. Use quando trabalhar com arquivos PDF ou quando o usuário mencionar PDFs, forms ou extração de documentos.
糟糕示例:
Ajuda com documentos.
糟糕示例没有给 Agent 提供区分这项技能与其他文档技能的方法。
何时添加脚本
在以下情况下添加实用脚本:
- 操作是确定性的(验证、格式化)
- 相同的代码会被反复生成
- 错误需要显式处理
与生成代码相比,脚本可以节省令牌并提高可靠性。
何时拆分文件
在以下情况下拆分为单独的文件:
- SKILL.md 超过 100 行
- 内容涉及不同领域(例如 finance 与 sales 的架构)
- 高级功能很少需要
审阅清单
起草后,请检查:
- Description 包含触发条件(“在……时使用”)
- SKILL.md 少于 100 行
- 不包含时效性信息
- 术语一致
- 包含具体示例
- 参考资料最多只有一层深度
评论
支持 Markdown