跳到主要内容
知仓学习社ZHICANG

write-a-skill

Create new agent skills with proper structure, progressive disclosure, and bundled resources. Use when user wants to create, write, build, or author…

读文件无严重或高危命中alirezarezvani/claude-skills

它会碰到什么

扫了多少8 个文本文件,57 KB
它会碰到什么读文件
命中总数5 处
命中统计严重 0 · 高 0 · 中 5 · 低 0

这一栏是扫描器报的事实,不是结论。命中多不等于有毒(安全工具、规则库、示例脚本本来就会包含危险写法),命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系,需要你自己看。

技能内容

Writing Skills

> Derived from Matt Pocock's write-a-skill (MIT). Matt's voice and 3-phase workflow preserved verbatim. Additions: validation tools + references + cs- wrapper (see Tooling + Companions* below).

Process

  1. Gather requirements - ask user about:
  • What task/domain does the skill cover?
  • What specific use cases should it handle?
  • Does it need executable scripts or just instructions?
  • Any reference materials to include?
  1. Draft the skill - create:
  • SKILL.md with concise instructions
  • Additional reference files if content exceeds 500 lines
  • Utility scripts if deterministic operations needed
  1. Review with user - present draft and ask:
  • Does this cover your use cases?
  • Anything missing or unclear?
  • Should any section be more/less detailed?

Skill Structure

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 Template

---
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 Requirements

The description is the only thing your agent sees when deciding which skill to load. It's surfaced in the system prompt alongside all other installed skills. Your agent reads these descriptions and picks the relevant skill based on the user's request.

Goal: Give your agent just enough info to know:

  1. What capability this skill provides
  2. When/why to trigger it (specific keywords, contexts, file types)

Format:

  • Max 1024 chars
  • Write in third person
  • First sentence: what it does
  • Second sentence: "Use when [specific triggers]"

Good example:

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.

Bad example:

Helps with documents.

The bad example gives your agent no way to distinguish this from other document skills.

When to Add Scripts

Add utility scripts when:

  • Operation is deterministic (validation, formatting)
  • Same code would be generated repeatedly
  • Errors need explicit handling

Scripts save tokens and improve reliability vs generated code.

When to Split Files

Split into separate files when:

  • SKILL.md exceeds 100 lines
  • Content has distinct domains (finance vs sales schemas)
  • Advanced features are rarely needed

Review Checklist

After drafting, verify:

  • [ ] Description includes triggers ("Use when...")
  • [ ] SKILL.md under 100 lines
  • [ ] No time-sensitive info
  • [ ] Consistent terminology
  • [ ] Concrete examples included
  • [ ] References one level deep

Tooling + Companions

Validation tools + cs-* wrapper sit alongside this skill. Run all 6 review-checklist items programmatically:

python scripts/skill_review_checklist_runner.py path/to/skill-folder

See [references/companion_tooling.md](references/companion_tooling.md) for the tool catalogue, cs-skill-author persona agent, and /cs:write-a-skill slash command.

When the knowledge is in a document, not your head

This skill authors from expertise you already have. When the source is a book, a docs folder,

a standard, or a pile of specs, use engineering/book-to-skill instead — it compiles the

document into a knowledge-base skill (core frameworks + on-demand chapters + glossary +

patterns + cheatsheet) and can package the result as a plugin.

/cs:book-to-skill <path|folder|glob> [skill-name]     # compile the source
/cs:book-to-plugin <compiled-skill-dir>               # wrap it as a plugin

Rule of thumb: author first, compile second. A hand-written skill states what you want the

agent to do; a compiled book skill is the reference it consults while doing it. If you have

both, they are two skills, not one.


Version: 1.0.0

Derived: Matt Pocock (MIT) + this repo's wrapper

想直接用这个技能?

本站把开放许可(MIT / Apache 等)的技能按仓库打包整理到网盘,点一下转存到你自己的网盘,不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接,不打包。

它属于哪个仓库

星标★ 26,030
本站分层T1
该仓技能数846
原文件路径engineering/write-a-skill/skills/write-a-skill/SKILL.md

同一个仓库里的其他技能

看这个仓库的全部 846 个技能

同名技能的其他版本

有 2 个不同仓库或目录里都有叫 write-a-skill 的技能。它们内容并不相同,别混用: