writing-skills
Skill4 starsChanged 4 months agoMITView on GitHub
How to author and structure Claude Code skills: SKILL.md frontmatter, writing trigger-focused descriptions, file organization, and naming. Apply when creating or editing a skill (a SKILL.md file).
191 other projects use a version of this, 2 of them edited.
Adopted by
Most recently taken up by
- dragoshont/architravetheir own version, first seen Nov 16, 2026
- rundesk-ai/skillstheir own version, first seen Nov 15, 2026
- draekien/skillstheir own version, first seen Nov 15, 2026
- mintunitish/tandemtheir own version, first seen Nov 15, 2026
- alexuraxin/retainertheir own version, first seen Nov 15, 2026
- crbnos/carbontheir own version, first seen Nov 15, 2026
Used with
Projects with it also use chinese-code-review, chinese-commit-conventions and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
Leodorareluctant259Skillchinese-code-review
中文代码审查规范——在保持专业严谨的同时,用符合国内团队文化的方式给出有效反馈
Also in 8 projects that use this
Leodorareluctant259Skillchinese-commit-conventions
中文 Git 提交规范 — 适配国内团队的 commit message 规范和 changelog 自动化
Also in 8 projects that use this
obraSkilldiagnosing-superpowers
Use when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness.
Also in 20 projects that use this
kntismSkillcondition-based-waiting
Use when tests have race conditions, timing dependencies, or inconsistent pass/fail behavior - replaces arbitrary timeouts with condition polling to wait for actual state changes, eliminating flaky tests from timing guesses
Also in 3 projects that use this
aaddrickSkillwriting-agents
Use when creating new agents, editing existing agents, or defining specialized subagent roles for the Task tool
Also in 3 projects that use this
frankxaiSkilldefense-in-depth
Use when invalid data causes failures deep in execution, requiring validation at multiple system layers - validates at every layer data passes through to make bugs structurally impossible
Also in 3 projects that use this
- +3 more from Leodorareluctant259
Other versions191 projects use a version of this.
Word for word · 0
None found.
Edited · 2
- yeaight7/agent-powerups★ 622% same
- miptah21/skills★ 216% same
Wrote their own version · 189
- obra/superpowers★ 314ksame name
- PostHog/posthog★ 41ksame name
- jnMetaCode/superpowers-zh★ 8.5ksame name
- openai/plugins★ 7.8ksame name
- farm-fe/farm★ 5.6ksame name
- compozy/compozy★ 2.9ksame name
- crbnos/carbon★ 2.8ksame name
- lingyired/status-trio★ 1.8ksame name
- GanyuanRan/Aegis★ 1.4ksame name
- pcvelz/superpowers★ 1.3ksame name
179 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository53 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- llms.txtllms.txt
- actionableSkill
- astro-bootstrapSkill
- astro-patternsSkill
- autopilotSkill
- axon-code-intelSkill
- brainstormingSkill
- commit-conventionsSkill
- cross-repo-contextSkill
- django-bootstrapSkill
- django-patternsSkill
- executeSkill
- find-sessionSkill
- flutter-bootstrapSkill
- flutter-patternsSkill
- full-featureSkill
- intelSkill
- nextjs-bootstrapSkill
- nextjs-fullstack-bootstrapSkill
- nextjs-fullstack-patternsSkill
- nextjs-mui-bootstrapSkill
- nextjs-patternsSkill
- nextjs-shadcn-bootstrapSkill
- orchestratorSkill
- phase-breakdownSkill
- plan-and-scopeSkill
- prdSkill
- reactSkill
- recallSkill
- reflectSkill
- relaySkill
- rememberSkill
- scaffoldSkill
- scratchSkill
- tailwindSkill
- ux-specSkill
- ux-to-promptsSkill
- verify-astroSkill
- verify-djangoSkill
- verify-flutterSkill
- verify-nextjs-fullstackSkill
- verify-nextjs-muiSkill
- verify-nextjs-shadcnSkill
- verify-nextjsSkill
- verifySkill
- visual-feedbackSkill
- work-disciplineSkill
- worktreesSkill
- wrapSkill
- write-as-friendSkill
- write-as-humanSkill
- writing-clearlySkill
The file
We split this skill into the rules it gives an agent
12 rules. 2 are common, 9 are distinctive, and 1 is very specific to this project.
2
Common
Most of the 181 edited versions we read keep these.
9
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 44
Every skill is a skills/<skill-name>/SKILL.md file that opens with YAML frontmatter, then markdown:
- Distinctive: line 77
Description: Start with "Use when..." to focus on triggering conditions.
- Distinctive: line 87
Keywords: Use words Claude would search for — error messages, symptoms, synonyms, tool names.
- Distinctive: line 93
Every token in frequently-loaded skills counts.
- Distinctive: line 96
Use cross-references instead of repeating content
- Common: line 98
Don't repeat what's in cross-referenced skills
- Distinctive: line 114
Keep content inline unless it exceeds ~100 lines of reference material or is a reusable script/utility.
- Distinctive: line 118
Before deploying a skill, validate it works:
- Distinctive: line 120
Baseline: Run a scenario WITHOUT the skill — document what the agent does wrong
- Distinctive: line 121
With skill: Run the same scenario WITH the skill — verify the agent now complies
- Distinctive: line 123
Close loopholes: If the agent finds workarounds, add explicit counters
- Common: line 137
Untested skills: If you didn't watch an agent fail without the skill, you don't know if it teaches the right thing
“Common” is measured: kept by at least 6 in 10 of the 181 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Writing Skills (Meta-Skill)
Adapted from obra/superpowers
Overview
A guide for creating effective, discoverable, and well-tested skills. Use this when authoring new skills for this repo.
What is a Skill?
A skill is a reference guide for proven techniques, patterns, or tools. Skills help AI agents find and apply effective approaches.
Skills are: Reusable techniques, patterns, tools, reference guides Skills are NOT: Narratives about how you solved a problem once
When to Create a Skill
Create when:
- Technique wasn't intuitively obvious
- You'd reference this again across projects
- Pattern applies broadly (not project-specific)
- Others would benefit
Don't create for:
- One-off solutions
- Standard practices well-documented elsewhere
- Project-specific conventions (put in CLAUDE.md instead)
- Mechanical constraints enforceable with linting/validation
Skill Types
- Technique: Concrete method with steps (condition-based-waiting, root-cause-tracing)
- Pattern: Way of thinking about problems (flatten-with-flags, test-invariants)
- Reference: API docs, syntax guides, tool documentation
SKILL.md Structure
Every skill is a skills/<skill-name>/SKILL.md file that opens with YAML frontmatter, then markdown:
---
name: skill-name
description: One line — lead with the trigger use case (this drives auto-invocation).
# disable-model-invocation: true # command-only: won't auto-trigger; run as /skill-name
# paths: ["**/*.py"] # auto-trigger only when working on matching files
---
# Skill Name
## Overview
What is this? Core principle in 1-2 sentences.
## When to Use
Bullet list with SYMPTOMS and use cases.
When NOT to use.
## Core Pattern
Before/after comparison or step-by-step process.
## Quick Reference
Table or bullets for scanning common operations.
## Common Mistakes
What goes wrong + fixes.Discovery Optimization
Future Claude instances need to FIND your skill. Optimize for this:
Description: Start with "Use when..." to focus on triggering conditions. Describe the problem, not the solution. NEVER summarize the skill's workflow in the description — Claude may follow the description shortcut instead of reading the full skill.
# BAD: Summarizes workflow
description: Use when executing plans - dispatches subagent per task with code review
# GOOD: Just triggering conditions
description: Use when implementing any feature or bugfix, before writing implementation codeKeywords: Use words Claude would search for — error messages, symptoms, synonyms, tool names.
Naming: Kebab-case directory names. For a command-only skill the directory name is the slash command (scaffold, verify-django, nextjs-bootstrap) — name it exactly what you'd type. For an auto-triggering skill use a clear noun/verb phrase that matches its trigger (django-patterns, work-discipline, plan-and-scope). Match the repo's existing names; don't force gerunds.
Token Efficiency
Every token in frequently-loaded skills counts.
- Move details to supporting files, reference with cross-links
- Use cross-references instead of repeating content
- Compress examples — one excellent example beats many mediocre ones
- Don't repeat what's in cross-referenced skills
- Target: <200 words for frequently-loaded skills, <500 words for others
Code Examples
One excellent example beats many mediocre ones. Choose the most relevant language for the pattern. Make it complete, runnable, and well-commented. Don't implement in 5+ languages.
File Organization
skills/
skill-name/
SKILL.md # Main reference (required)
supporting-file.* # Only if needed (heavy reference, reusable tools)Keep content inline unless it exceeds ~100 lines of reference material or is a reusable script/utility.
Testing Skills
Before deploying a skill, validate it works:
- Baseline: Run a scenario WITHOUT the skill — document what the agent does wrong
- With skill: Run the same scenario WITH the skill — verify the agent now complies
- Edge cases: Try pressure scenarios where the agent might rationalize skipping the skill
- Close loopholes: If the agent finds workarounds, add explicit counters
Different skill types need different test approaches:
- Discipline skills (rules/requirements): Test with pressure scenarios
- Technique skills (how-to): Test with application scenarios and edge cases
- Pattern skills (mental models): Test recognition and counter-examples
- Reference skills (docs): Test retrieval and correct application
Anti-Patterns
- Narrative style: "In session 2025-10-03, we found..." — too specific, not reusable
- Multi-language dilution: examples in 5 languages — mediocre quality, maintenance burden
- Code in flowcharts: Can't copy-paste, hard to read
- Generic labels: "step1", "helper2" — labels should have semantic meaning
- Untested skills: If you didn't watch an agent fail without the skill, you don't know if it teaches the right thing
Checklist for New Skills
- Name uses letters, numbers, hyphens only
- Clear overview with core principle in 1-2 sentences
- "When to Use" section with specific triggers/symptoms
- Keywords throughout for search discovery
- One excellent code example (if applicable)
- Quick reference table for scanning
- Common mistakes section
- Tested against baseline behavior
- No narrative storytelling
- Supporting files only for heavy reference or reusable tools
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

