
writing-skills
by SPURSGO
Other Chinese translations of awesome skills
SKILL.md
name: writing-skills description: 在创建新技能、编辑现有技能或验证技能在部署前有效时使用
编写技能
概述
编写技能就是应用于流程文档的测试驱动开发。
个人技能存在于特定代理目录中(Claude Code 为 ~/.claude/skills,Codex 为 ~/.codex/skills)
你编写测试用例(带子代理的压力场景),看它们失败(基线行为),编写技能(文档),看测试通过(代理合规),然后重构(关闭漏洞)。
核心原则: 如果你没有看到代理在没有技能的情况下失败,你不知道技能是否教授了正确的内容。
必需背景: 在使用此技能之前,你必须理解 superpowers:test-driven-development。该技能定义了基本的 RED-GREEN-REFACTOR 循环。此技能将 TDD 适应到文档。
官方指导: 有关 Anthropic 的官方技能编写最佳实践,请参见 anthropic-best-practices.md。本文档提供了补充此技能中 TDD 聚焦方法的额外模式和指南。
什么是技能?
技能 是经过验证的技术、模式或工具的参考指南。技能帮助未来的 Claude 实例找到并应用有效方法。
技能是: 可重用技术、模式、工具、参考指南
技能不是: 关于你如何解决一次问题的叙述
技能的 TDD 映射
| TDD 概念 | 技能创建 |
|---|---|
| 测试用例 | 带子代理的压力场景 |
| 生产代码 | 技能文档(SKILL.md) |
| 测试失败(RED) | 代理在没有技能的情况下违反规则(基线) |
| 测试通过(GREEN) | 代理在有技能时合规 |
| 重构 | 在保持合规的同时关闭漏洞 |
| 先写测试 | 在编写技能之前运行基线场景 |
| 看它失败 | 记录代理使用的确切合理化 |
| 最小代码 | 编写解决这些特定违规的技能 |
| 看它通过 | 验证代理现在合规 |
| 重构循环 | 找到新合理化 → 堵塞 → 重新验证 |
整个技能创建过程遵循 RED-GREEN-REFACTOR。
何时创建技能
创建当:
- 技术对你来说不是直观明显的
- 你会跨项目再次参考这个
- 模式广泛适用(不是项目特定的)
- 其他人会受益
不要为以下情况创建:
- 一次性解决方案
- 在其他地方有良好文档的标准实践
- 项目特定约定(放在 CLAUDE.md 中)
- 机械约束(如果可以用 regex/验证强制执行,自动化它 - 为判断调用保存文档)
技能类型
技术
具有要遵循步骤的具体方法(condition-based-waiting、root-cause-tracing)
模式
思考问题的方式(flatten-with-flags、test-invariants)
参考
API 文档、语法指南、工具文档(office docs)
目录结构
skills/
skill-name/
SKILL.md # 主要参考(必需)
supporting-file.* # 仅在需要时
扁平命名空间 - 所有技能在一个可搜索的命名空间中
为以下内容使用单独文件:
- 重型参考(100+ 行)- API 文档、综合语法
- 可重用工具 - 脚本、实用程序、模板
保持内联:
- 原则和概念
- 代码模式(< 50 行)
- 其他一切
SKILL.md 结构
Frontmatter(YAML):
- 仅支持两个字段:
name和description - 总共最多 1024 个字符
name:仅使用字母、数字和连字符(无括号、特殊字符)description:第三人称,仅描述何时使用(不做什么)- 以 "Use when..." 开头以专注于触发条件
- 包括特定症状、情况和上下文
- 永远不要总结技能的过程或工作流(参见 CSO 部分了解原因)
- 如果可能,保持在 500 个字符以下
---
name: Skill-Name-With-Hyphens
description: Use when [specific triggering conditions and symptoms]
---
# Skill Name
## Overview
What is this? Core principle in 1-2 sentences.
## When to Use
[Small inline flowchart IF decision non-obvious]
Bullet list with SYMPTOMS and use cases
When NOT to use
## Core Pattern (for techniques/patterns)
Before/after code comparison
## Quick Reference
Table or bullets for scanning common operations
## Implementation
Inline code for simple patterns
Link to file for heavy reference or reusable tools
## Common Mistakes
What goes wrong + fixes
## Real-World Impact (optional)
Concrete results
Claude 搜索优化(CSO)
对发现至关重要: 未来的 Claude 需要找到你的技能
1. 丰富的描述字段
目的: Claude 读取描述以决定为给定任务加载哪些技能。让它回答:"我现在应该阅读此技能吗?"
格式: 以 "Use when..." 开头以专注于触发条件
关键:描述 = 何时使用,不是技能做什么
描述应该只描述触发条件。不要在描述中总结技能的过程或工作流。
为什么这很重要: 测试显示,当描述总结技能的工作流时,Claude 可能遵循描述而不是阅读完整的技能内容。说"任务之间的代码审查"的描述导致 Claude 进行一次审查,即使技能的流程图清楚地显示两次审查(规范合规性然后代码质量)。
当描述改为仅"在当前会话中执行具有独立任务的实施计划时使用"(无工作流摘要)时,Claude 正确读取流程图并遵循两阶段审查过程。
陷阱: 总结工作流的描述创建了 Claude 会采用的快捷方式。技能主体成为 Claude 跳过的文档。
# ❌ 错误:总结工作流 - Claude 可能遵循这个而不是阅读技能
description: Use when executing plans - dispatches subagent per task with code review between tasks
# ❌ 错误:太多过程细节
description: Use for TDD - write test first, watch it fail, write minimal code, refactor
# ✅ 好:只是触发条件,无工作流摘要
description: Use when executing implementation plans with independent tasks in the current session
# ✅ 好:仅触发条件
description: Use when implementing any feature or bugfix, before writing implementation code
内容:
- 使用具体触发器、症状和表示此技能适用的情况
- 描述问题(竞态条件、不一致行为)而不是特定语言症状(setTimeout、sleep)
- 保持触发器与技术无关,除非技能本身是特定技术的
- 如果技能是特定技术的,在触发器中明确说明
- 用第三人称编写(注入到系统提示中)
- 永远不要总结技能的过程或工作流
# ❌ 错误:太抽象、模糊、不包括何时使用
description: For async testing
# ❌ 错误:第一人称
description: I can help you with async tests when they're flaky
# ❌ 错误:提到技术但技能不特定于它
description: Use when tests use setTimeout/sleep and are flaky
# ✅ 好:以 "Use when" 开头,描述问题,无工作流
description: Use when tests have race conditions, timing dependencies, or pass/fail inconsistently
# ✅ 好:具有明确触发器的特定技术技能
description: Use when using React Router and handling authentication redirects
2. 关键词覆盖
使用 Claude 会搜索的词语:
- 错误消息:"Hook timed out"、"ENOTEMPTY"、"race condition"
- 症状:"flaky"、"hanging"、"zombie"、"pollution"
- 同义词:"timeout/hang/freeze"、"cleanup/teardown/afterEach"
- 工具:实际命令、库名称、文件类型
3. 描述性命名
使用主动语态,动词优先:
- ✅
creating-skills不是skill-creation - ✅
condition-based-waiting不是async-test-helpers
4. Token 效率(关键)
问题: 入门和经常引用的技能加载到每个对话中。每个 token 都很重要。
目标字数:
- 入门工作流:每个 <150 字
- 经常加载的技能:总共 <200 字
- 其他技能:<500 字(仍然要简洁)
技术:
将细节移到工具帮助:
# ❌ 错误:在 SKILL.md 中记录所有标志
search-conversations supports --text, --both, --after DATE, --before DATE, --limit N
# ✅ 好:引用 --help
search-conversations supports multiple modes and filters. Run --help for details.
使用交叉引用:
# ❌ 错误:重复工作流细节
When searching, dispatch subagent with template...
[20 lines of repeated instructions]
# ✅ 好:引用其他技能
Always use subagents (50-100x context savings). REQUIRED: Use [other-skill-name] for workflow.
压缩示例:
# ❌ 错误:冗长示例(42 字)
your human partner: "How did we handle authentication errors in React Router before?"
You: I'll search past conversations for React Router authentication patterns.
[Dispatch subagent with search query: "React Router authentication error handling 401"]
# ✅ 好:最小示例(20 字)
Partner: "How did we handle auth errors in React Router?"
You: Searching...
[Dispatch subagent → synthesis]
消除冗余:
- 不要重复交叉引用技能中的内容
- 不要解释从命令中显而易见的内容
- 不要包含相同模式的多个示例
验证:
wc -w skills/path/SKILL.md
# getting-started workflows: aim for <150 each
# Other frequently-loaded: aim for <200 total
按你做什么或核心洞察命名:
- ✅
condition-based-waiting>async-test-helpers - ✅
using-skills不是skill-usage - ✅
flatten-with-flags>data-structure-refactoring - ✅
root-cause-tracing>debugging-techniques
动名词(-ing)对流程很有效:
creating-skills、testing-skills、debugging-with-logs- 主动,描述你正在采取的行动
4. 交叉引用其他技能
编写引用其他技能的文档时:
仅使用技能名称,带有明确的要求标记:
- ✅ 好:
**REQUIRED SUB-SKILL:** Use superpowers:test-driven-development - ✅ 好:
**REQUIRED BACKGROUND:** You MUST understand superpowers:systematic-debugging - ❌ 坏:
See skills/testing/test-driven-development(不清楚是否必需) - ❌ 坏:
@skills/testing/test-driven-development/SKILL.md(强制加载,消耗上下文)
为什么没有 @ 链接: @ 语法立即强制加载文件,在你需要它们之前消耗 200k+ 上下文。
流程图使用
digraph when_flowchart {
"Need to show information?" [shape=diamond];
"Decision where I might go wrong?" [shape=diamond];
"Use markdown" [shape=box];
"Small inline flowchart" [shape=box];
"Need to show information?" -> "Decision where I might go wrong?" [label="yes"];
"Decision where I might go wrong?" -> "Small inline flowchart" [label="yes"];
"Decision where I might go wrong?" -> "Use markdown" [label="no"];
}
仅在以下情况使用流程图:
- 不明显的决策点
- 你可能过早停止的流程循环
- "何时使用 A vs B" 决策
永远不要将流程图用于:
- 参考材料 → 表格、列表
- 代码示例 → Markdown 块
- 线性指令 → 编号列表
- 无语义意义的标签(step1、helper2)
参见 @graphviz-conventions.dot 了解 graphviz 样式规则。
为你的合作伙伴可视化: 使用此目录中的 render-graphs.js 将技能的流程图渲染为 SVG:
./render-graphs.js ../some-skill # Each diagram separately
./render-graphs.js ../some-skill --combine # All diagrams in one SVG
代码示例
一个优秀的示例胜过许多平庸的示例
选择最相关的语言:
- 测试技术 → TypeScript/JavaScript
- 系统调试 → Shell/Python
- 数据处理 → Python
好示例:
- 完整且可运行
- 注释良好,解释为什么
- 来自真实场景
- 清楚地显示模式
- 准备适应(不是通用模板)
不要:
- 用 5+ 种语言实施
- 创建填空模板
- 编写人为示例
你很擅长移植 - 一个很好的示例就足够了。
文件组织
自包含技能
defense-in-depth/
SKILL.md # Everything inline
当:所有内容都适合,不需要重型参考
带可重用工具的技能
condition-based-waiting/
SKILL.md # Overview + patterns
example.ts # Working helpers to adapt
当:工具是可重用代码,不仅仅是叙述
带重型参考的技能
pptx/
SKILL.md # Overview + workflows
pptxgenjs.md # 600 lines API reference
ooxml.md # 500 lines XML structure
scripts/ # Executable tools
当:参考材料太大无法内联
铁律(与 TDD 相同)
没有先失败的测试,就没有技能
这适用于新技能和对现有技能的编辑。
在测试之前编写技能?删除它。重新开始。 不测试就编辑技能?同样的违规。
无例外:
- 不是"简单添加"
- 不是"只是添加一个部分"
- 不是"文档更新"
- 不要将未测试的更改保留为"参考"
- 不要在运行测试时"适应"
- 删除意味着删除
必需背景: superpowers:test-driven-development 技能解释了为什么这很重要。相同的原则适用于文档。
测试所有技能类型
不同的技能类型需要不同的测试方法:
纪律执行技能(规则/要求)
示例: TDD、verification-before-completion、designing-before-coding
测试:
- 学术问题:他们理解规则吗?
- 压力场景:他们在压力下合规吗?
- 多种压力组合:时间 + 沉没成本 + 疲惫
- 识别合理化并添加明确的反驳
成功标准: 代理在最大压力下遵循规则
技术技能(操作指南)
示例: condition-based-waiting、root-cause-tracing、defensive-programming
测试:
- 应用场景:他们能正确应用技术吗?
- 变化场景:他们处理边界情况吗?
- 缺失信息测试:指令有缺口吗?
成功标准: 代理成功将技术应用于新场景
模式技能(心理模型)
示例: reducing-complexity、information-hiding concepts
测试:
- 识别场景:他们识别何时模式适用吗?
- 应用场景:他们能使用心理模型吗?
- 反例:他们知道何时不应用吗?
成功标准: 代理正确识别何时/如何应用模式
参考技能(文档/API)
示例: API 文档、命令参考、库指南
测试:
- 检索场景:他们能找到正确的信息吗?
- 应用场景:他们能正确使用找到的内容吗?
- 缺口测试:常见用例是否覆盖?
成功标准: 代理找到并正确应用参考信息
跳过测试的常见合理化
| 借口 | 现实 |
|---|---|
| "技能显然清楚" | 对你清楚 ≠ 对其他代理清楚。测试它。 |
| "这只是参考" | 参考可能有缺口、不清楚的部分。测试检索。 |
| "测试是过度杀伤" | 未测试的技能有问题。总是。15 分钟测试节省数小时。 |
| "如果出现问题我会测试" | 问题 = 代理无法使用技能。在部署之前测试。 |
| "测试太繁琐" | 测试比在生产中调试坏技能不那么繁琐。 |
| "我有信心它很好" | 过度自信保证问题。无论如何测试。 |
| "学术审查足够" | 阅读 ≠ 使用。测试应用场景。 |
| "没有时间测试" | 部署未测试的技能浪费更多时间稍后修复它。 |
所有这些都意味着:在部署之前测试。无例外。
强化技能以抵抗合理化
执行纪律的技能(如 TDD)需要抵抗合理化。代理很聪明,在压力下会找到漏洞。
心理学说明: 理解为什么说服技术有效有助于你系统地应用它们。参见 persuasion-principles.md 了解关于权威、承诺、稀缺、社会证明和统一原则的研究基础(Cialdini, 2021; Meincke et al., 2025)。
明确关闭每个漏洞
不要只是说明规则 - 禁止特定的变通方法:
No exceptions:
- Don't keep it as "reference"
- Don't "adapt" it while writing tests
- Don't look at it
- Delete means delete
</Good>
### 解决"精神 vs 字面"论证
早期添加基础原则:
```markdown
**Violating the letter of the rules is violating the spirit of the rules.**
这切断了整个"我遵循精神"合理化的类别。
构建合理化表
从基线测试中捕获合理化(参见下面的测试部分)。代理做出的每个借口都进入表格:
| Excuse | Reality |
|--------|---------|
| "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
| "I'll test after" | Tests passing immediately prove nothing. |
| "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
创建危险信号列表
让代理在合理化时容易自我检查:
## Red Flags - STOP and Start Over
- Code before test
- "I already manually tested it"
- "Tests after achieve the same purpose"
- "It's about spirit not ritual"
- "This is different because..."
**All of these mean: Delete code. Start over with TDD.**
更新 CSO 以获取违规症状
添加到描述:当你即将违反规则时的症状:
description: use when implementing any feature or bugfix, before writing implementation code
技能的 RED-GREEN-REFACTOR
遵循 TDD 循环:
RED:编写失败测试(基线)
在没有技能的情况下运行压力场景。记录确切行为:
- 他们做了什么选择?
- 他们使用了什么合理化(逐字)?
- 哪些压力触发了违规?
这是"看测试失败" - 你必须在编写技能之前看到代理自然做什么。
GREEN:编写最小技能
编写解决这些特定合理化的技能。不要为假设情况添加额外内容。
使用技能运行相同场景。代理现在应该合规。
REFACTOR:关闭漏洞
代理找到新合理化?添加明确的反驳。重新测试直到强化。
测试方法: 参见 @testing-skills-with-subagents.md 了解完整的测试方法:
- 如何编写压力场景
- 压力类型(时间、沉没成本、权威、疲惫)
- 系统地堵塞漏洞
- 元测试技术
反模式
❌ 叙述性示例
"In session 2025-10-03, we found empty projectDir caused..." 为什么坏: 太具体,不可重用
❌ 多语言稀释
example-js.js, example-py.py, example-go.go 为什么坏: 质量平庸,维护负担
❌ 流程图中的代码
step1 [label="import fs"];
step2 [label="read file"];
为什么坏: 无法复制粘贴,难以阅读
❌ 通用标签
helper1, helper2, step3, pattern4 为什么坏: 标签应该有语义意义
停止:在移动到下一个技能之前
编写任何技能后,你必须停止并完成部署过程。
不要:
- 批量创建多个技能而不测试每个
- 在当前技能验证之前移动到下一个技能
- 因为"批处理更高效"而跳过测试
下面的部署清单对每个技能都是强制性的。
部署未测试的技能 = 部署未测试的代码。这是违反质量标准的行为。
技能创建清单(TDD 适应)
重要:使用 TodoWrite 为下面的每个清单项创建待办事项。
RED 阶段 - 编写失败测试:
- 创建压力场景(纪律技能 3+ 组合压力)
- 在没有技能的情况下运行场景 - 逐字记录基线行为
- 识别合理化/失败中的模式
GREEN 阶段 - 编写最小技能:
- 名称仅使用字母、数字、连字符(无括号/特殊字符)
- YAML frontmatter 仅包含 name 和 description(最多 1024 字符)
- 描述以 "Use when..." 开头并包括特定触发器/症状
- 描述用第三人称编写
- 整个搜索关键词(错误、症状、工具)
- 清晰的概述和核心原则
- 解决 RED 中识别的特定基线失败
- 代码内联或链接到单独文件
- 一个优秀示例(不是多语言)
- 使用技能运行场景 - 验证代理现在合规
REFACTOR 阶段 - 关闭漏洞:
- 从测试中识别新合理化
- 添加明确的反驳(如果是纪律技能)
- 从所有测试迭代构建合理化表
- 创建危险信号列表
- 重新测试直到强化
质量检查:
- 仅在决策不明显时使用小流程图
- 快速参考表
- 常见错误部分
- 无叙述性故事
- 支持文件仅用于工具或重型参考
部署:
- 将技能提交到 git 并推送到你的 fork(如果配置)
- 考虑通过 PR 贡献回来(如果广泛有用)
发现工作流
未来 Claude 如何找到你的技能:
- 遇到问题("测试不稳定")
- 找到技能(描述匹配)
- 扫描概述(这相关吗?)
- 阅读模式(快速参考表)
- 加载示例(仅在实施时)
优化此流程 - 早期且经常放置可搜索术语。
底线
创建技能就是流程文档的 TDD。
相同的铁律:没有先失败的测试,就没有技能。 相同的循环:RED(基线)→ GREEN(编写技能)→ REFACTOR(关闭漏洞)。 相同的优势:更好的质量、更少的意外、强化的结果。
如果你为代码遵循 TDD,为技能也遵循它。这是应用于文档的相同纪律。
スコア
総合スコア
リポジトリの品質指標に基づく評価
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
レビュー
レビュー機能は近日公開予定です