mcpField
W
write-a-skill

write-a-skill

github.com/vinvcnAgent 工作流5.4k1.7k 次安装1 天前更新
代码仓库

关于 write-a-skill

用于按需求创建 Agent skill 的写作指南,面向需要定义任务范围、编写说明并审阅草稿的人。它涵盖 skill 结构、描述编写、脚本选择和检查流程。

主要功能

  1. 01收集任务与用例需求
  2. 02生成 SKILL.md 和可选文件
  3. 03制定 skill 描述编写要求
  4. 04判断何时加入脚本或拆分文件
  5. 05提供草稿审阅清单

适用场景

  1. 01从零创建面向特定领域的 skill
  2. 02确定 skill 是否需要实用脚本
  3. 03检查描述是否包含明确触发条件

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/vinvcn/mattpocock-skills-zh-cn --skill write-a-skill

安装后在 Claude Code 中输入/write-a-skill确认已加载。

详细介绍

编写技能

流程

  1. 收集需求 — 询问用户:

    • 技能涵盖什么任务/领域?
    • 应处理哪些具体用例?
    • 需要可执行脚本,还是只需要说明?
    • 是否有要纳入的参考资料?
  2. 起草技能 — 创建:

    • 包含简洁说明的 SKILL.md
    • 如果内容超过 500 行,创建其他参考文件
    • 如果需要确定性操作,创建实用脚本
  3. 与用户审阅 — 展示草稿并询问:

    • 是否涵盖你的用例?
    • 是否有缺失或不清楚的内容?
    • 是否有章节需要写得更详细或更简短?

技能结构

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 是 Agent 决定是否加载技能时唯一看到的内容。它会和其他已安装的技能一起出现在 system prompt 中。Agent 会读取这些 descriptions,并根据用户请求选择相关技能。

目标:向 Agent 提供足够的信息,让它知道:

  1. 此技能提供什么能力
  2. 何时/为何触发此技能(具体关键词、上下文、文件类型)

格式:

  • 最多 1024 个字符
  • 使用第三人称
  • 第一句说明它的作用
  • 第二句:“Use when [specific triggers]”

优秀示例:

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 将它与其他文档类技能区分开来。

何时添加脚本

以下情况可添加实用脚本:

  • 操作是确定性的(验证、格式化)
  • 同一段代码会被反复生成
  • 错误需要明确处理

与生成代码相比,脚本可以节省 tokens 并提升可靠性。

何时拆分文件

以下情况可拆分为独立文件:

  • SKILL.md 超过 100 行
  • 内容涉及不同领域(财务与销售架构)
  • 高级功能很少需要

审阅清单

草稿完成后,验证以下事项:

  • Description 包含触发条件(“Use when...”)
  • SKILL.md 少于 100 行
  • 不含时效性信息
  • 术语保持一致
  • 包含具体示例
  • References 只深入一层

评论

支持 Markdown