用途
write-a-skill 用于创建新的智能体技能(agent skill)。当用户想要创建、编写、构建或撰写新技能时,可以使用该技能。它帮助作者按照规范的结构、渐进式披露(progressive disclosure)和捆绑资源来组织技能内容。
该技能源自 Matt Pocock 的 write-a-skill(MIT 许可),保留了其原始表述和三阶段工作流。在此基础上增加了验证工具、参考文档和 cs-* 包装器。
主要能力
- 引导用户完成技能编写流程,包括需求收集、草拟和评审。
- 提供技能的标准目录结构,包含 SKILL.md、REFERENCE.md、EXAMPLES.md 和 scripts/ 等文件。
- 提供 SKILL.md 模板,包含 frontmatter(name、description)和正文结构(Quick start、Workflows、Advanced features)。
- 说明 description 的编写要求:最多 1024 字符、第三人称、第一句说明功能、第二句以“Use when [specific triggers]”说明触发条件。
- 指导何时添加脚本(确定性操作、重复生成的代码、需要显式错误处理)。
- 指导何时拆分文件(SKILL.md 超过 100 行、内容属于不同领域、高级功能很少使用)。
- 提供评审清单,包含 6 项检查。
- 提供验证工具,可编程运行全部 6 项评审清单:
python scripts/skill_review_checklist_runner.py path/to/skill-folder。 - 提供 references/companion_tooling.md,包含工具目录、cs-skill-author 角色代理和 /cs:write-a-skill 斜杠命令。
- 当知识来源是文档而非个人经验时,建议使用 engineering/book-to-skill 将文档编译为知识库技能,并可通过 /cs:book-to-skill 和 /cs:book-to-plugin 命令打包为插件。
使用方式
该技能采用三阶段工作流:
- 收集需求:询问用户技能覆盖的任务/领域、需要处理的具体用例、是否需要可执行脚本或仅需说明、是否需要包含参考材料。
- 草拟技能:创建 SKILL.md(简洁说明)、内容超过 500 行时添加参考文件、需要确定性操作时添加实用脚本。
- 与用户评审:展示草稿并询问是否覆盖用例、是否有遗漏或不清晰之处、某部分是否需要更详细或更简略。
技能结构示例:
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)]
评审清单(草拟后验证):
- Description 包含触发条件(“Use when...”)
- SKILL.md 少于 100 行
- 无时间敏感信息
- 术语一致
- 包含具体示例
- 引用仅一层深度
验证工具运行方式:
python scripts/skill_review_checklist_runner.py path/to/skill-folder
当知识来源是文档时,可使用:
/cs:book-to-skill <path|folder|glob> [skill-name] # compile the source
/cs:book-to-plugin <compiled-skill-dir> # wrap it as a plugin
经验法则:先编写,后编译。手写技能说明你希望智能体做什么;编译的书籍技能是它在执行时参考的资料。如果两者都有,它们是两个技能,而不是一个。
适用场景
- 用户需要从零创建新的智能体技能。
- 用户需要按照规范结构和渐进式披露组织技能内容。
- 用户需要为技能添加可执行脚本或参考文档。
- 用户需要验证技能是否符合评审清单。
- 用户需要将文档(书籍、文档文件夹、标准、规格)编译为知识库技能。
限制
- 该技能用于从作者已有专业知识编写技能;当知识来源是文档时,应改用 engineering/book-to-skill。
- 版本为 1.0.0,派生自 Matt Pocock(MIT)及本仓库的包装器。
- 关于收费、价格、平台支持等具体信息,资料中暂未提供。