
skill-creator
by SPURSGO
Other Chinese translations of awesome skills
SKILL.md
name: skill-creator description: 创建有效技能的指南。当用户想要创建新技能(或更新现有技能)以通过专业知识、工作流程或工具集成扩展 Codex 的能力时,应使用此技能。 metadata: short-description: 创建或更新技能
Skill Creator
此技能提供创建有效技能的指导。
关于技能
技能是模块化、自包含的包,通过提供专业知识、工作流程和工具来扩展 Codex 的能力。可以将它们视为特定领域或任务的"入门指南"——它们将 Codex 从通用代理转变为配备程序性知识的专业代理,这些知识是任何模型都无法完全掌握的。
技能提供的内容
- 专业化工作流程 - 针对特定领域的多步骤程序
- 工具集成 - 处理特定文件格式或 API 的说明
- 领域专业知识 - 公司特定知识、模式、业务逻辑
- 捆绑资源 - 用于复杂和重复任务的脚本、参考资料和资源
核心原则
简洁是关键
上下文窗口是公共资源。技能与 Codex 需要的其他所有内容共享上下文窗口:系统提示、对话历史、其他技能的元数据以及实际的用户请求。
默认假设:Codex 已经非常智能。 只添加 Codex 尚未拥有的上下文。质疑每条信息:"Codex 真的需要这个解释吗?"和"这段文字是否值得其 token 成本?"
优先使用简洁的示例而非冗长的解释。
设置适当的自由度
将具体程度与任务的脆弱性和可变性相匹配:
高自由度(基于文本的说明):当多种方法都有效、决策取决于上下文或启发式指导方法时使用。
中等自由度(伪代码或带参数的脚本):当存在首选模式、允许一些变化或配置影响行为时使用。
低自由度(特定脚本,参数很少):当操作脆弱且容易出错、一致性至关重要或必须遵循特定顺序时使用。
将 Codex 想象为探索路径:有悬崖的窄桥需要特定的护栏(低自由度),而开阔的田野允许多条路线(高自由度)。
技能的结构
每个技能由一个必需的 SKILL.md 文件和可选的捆绑资源组成:
skill-name/
├── SKILL.md (required)
│ ├── YAML frontmatter metadata (required)
│ │ ├── name: (required)
│ │ └── description: (required)
│ └── Markdown instructions (required)
└── Bundled Resources (optional)
├── scripts/ - Executable code (Python/Bash/etc.)
├── references/ - Documentation intended to be loaded into context as needed
└── assets/ - Files used in output (templates, icons, fonts, etc.)
SKILL.md (必需)
每个 SKILL.md 包含:
- Frontmatter (YAML):包含
name和description字段。这些是 Codex 用来确定何时使用技能的唯一字段,因此在描述技能是什么以及何时应该使用时,清晰和全面非常重要。 - Body (Markdown):使用技能及其捆绑资源的说明和指导。仅在技能触发后加载(如果有的话)。
捆绑资源(可选)
脚本 (scripts/)
用于需要确定性可靠性或重复重写的任务的可执行代码(Python/Bash 等)。
- 何时包含:当相同代码被重复重写或需要确定性可靠性时
- 示例:用于 PDF 旋转任务的
scripts/rotate_pdf.py - 优势:Token 高效、确定性、可以在不加载到上下文的情况下执行
- 注意:脚本可能仍需要被 Codex 读取以进行修补或特定环境的调整
参考资料 (references/)
旨在根据需要加载到上下文中的文档和参考资料,以告知 Codex 的流程和思考。
- 何时包含:对于 Codex 在工作时应参考的文档
- 示例:用于财务模式的
references/finance.md,用于公司 NDA 模板的references/mnda.md,用于公司政策的references/policies.md,用于 API 规范的references/api_docs.md - 用例:数据库模式、API 文档、领域知识、公司政策、详细的工作流程指南
- 优势:保持 SKILL.md 精简,仅在 Codex 确定需要时加载
- 最佳实践:如果文件很大(>10k 字),在 SKILL.md 中包含 grep 搜索模式
- 避免重复:信息应该存在于 SKILL.md 或参考资料文件中,而不是两者都有。除非信息真正是技能的核心,否则优先使用参考资料文件存储详细信息——这保持 SKILL.md 精简,同时使信息可发现而不占用上下文窗口。在 SKILL.md 中只保留基本的程序性说明和工作流程指导;将详细的参考资料、模式和示例移到参考资料文件中。
资源 (assets/)
不打算加载到上下文中的文件,而是在 Codex 生成的输出中使用。
- 何时包含:当技能需要将在最终输出中使用的文件时
- 示例:用于品牌资源的
assets/logo.png,用于 PowerPoint 模板的assets/slides.pptx,用于 HTML/React 样板代码的assets/frontend-template/,用于字体的assets/font.ttf - 用例:模板、图像、图标、样板代码、字体、被复制或修改的示例文档
- 优势:将输出资源与文档分离,使 Codex 能够使用文件而不将它们加载到上下文中
技能中不应包含的内容
技能应该只包含直接支持其功能的基本文件。不要创建多余的文档或辅助文件,包括:
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- 等等
技能应该只包含 AI 代理完成手头工作所需的信息。它不应该包含关于创建它的过程的辅助上下文、设置和测试程序、面向用户的文档等。创建额外的文档文件只会增加混乱和困惑。
渐进式披露设计原则
技能使用三级加载系统来高效管理上下文:
- 元数据(name + description) - 始终在上下文中(约 100 字)
- SKILL.md 正文 - 当技能触发时(<5k 字)
- 捆绑资源 - 根据需要由 Codex 加载(无限,因为脚本可以在不读取到上下文窗口的情况下执行)
渐进式披露模式
将 SKILL.md 正文保持在基本内容并少于 500 行,以最小化上下文膨胀。接近此限制时,将内容拆分为单独的文件。将内容拆分到其他文件时,从 SKILL.md 引用它们并清楚地描述何时读取它们非常重要,以确保技能的读者知道它们的存在以及何时使用它们。
关键原则: 当技能支持多种变体、框架或选项时,在 SKILL.md 中只保留核心工作流程和选择指导。将特定变体的详细信息(模式、示例、配置)移到单独的参考资料文件中。
模式 1:带参考资料的高级指南
# PDF Processing
## Quick start
Extract text with pdfplumber:
[code example]
## Advanced features
- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
Codex 仅在需要时加载 FORMS.md、REFERENCE.md 或 EXAMPLES.md。
模式 2:特定领域的组织
对于具有多个领域的技能,按领域组织内容以避免加载无关的上下文:
bigquery-skill/
├── SKILL.md (overview and navigation)
└── reference/
├── finance.md (revenue, billing metrics)
├── sales.md (opportunities, pipeline)
├── product.md (API usage, features)
└── marketing.md (campaigns, attribution)
当用户询问销售指标时,Codex 只读取 sales.md。
类似地,对于支持多个框架或变体的技能,按变体组织:
cloud-deploy/
├── SKILL.md (workflow + provider selection)
└── references/
├── aws.md (AWS deployment patterns)
├── gcp.md (GCP deployment patterns)
└── azure.md (Azure deployment patterns)
当用户选择 AWS 时,Codex 只读取 aws.md。
模式 3:条件性详细信息
显示基本内容,链接到高级内容:
# DOCX Processing
## Creating documents
Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
## Editing documents
For simple edits, modify the XML directly.
**For tracked changes**: See [REDLINING.md](REDLINING.md)
**For OOXML details**: See [OOXML.md](OOXML.md)
Codex 仅在用户需要这些功能时读取 REDLINING.md 或 OOXML.md。
重要指南:
- 避免深层嵌套引用 - 保持引用从 SKILL.md 一级深度。所有参考资料文件应该直接从 SKILL.md 链接。
- 构建较长的参考资料文件 - 对于超过 100 行的文件,在顶部包含目录,以便 Codex 在预览时可以看到完整范围。
技能创建流程
技能创建涉及以下步骤:
- 通过具体示例理解技能
- 规划可重用的技能内容(脚本、参考资料、资源)
- 初始化技能(运行 init_skill.py)
- 编辑技能(实现资源并编写 SKILL.md)
- 打包技能(运行 package_skill.py)
- 基于实际使用进行迭代
按顺序遵循这些步骤,只有在有明确理由不适用时才跳过。
技能命名
- 仅使用小写字母、数字和连字符;将用户提供的标题标准化为连字符格式(例如,"Plan Mode" ->
plan-mode)。 - 生成名称时,生成一个少于 64 个字符的名称(字母、数字、连字符)。
- 优先使用描述动作的简短、动词开头的短语。
- 当工具命名空间提高清晰度或触发时,使用工具命名空间(例如,
gh-address-comments、linear-address-issue)。 - 技能文件夹名称应与技能名称完全一致。
步骤 1:通过具体示例理解技能
只有在技能的使用模式已经清楚理解时才跳过此步骤。即使在处理现有技能时,它仍然有价值。
要创建有效的技能,清楚地理解技能将如何使用的具体示例。这种理解可以来自直接的用户示例或经过用户反馈验证的生成示例。
例如,在构建图像编辑器技能时,相关问题包括:
- "图像编辑器技能应该支持什么功能?编辑、旋转,还有其他吗?"
- "你能给出一些这个技能将如何使用的示例吗?"
- "我可以想象用户会要求诸如'从这张图片中去除红眼'或'旋转这张图片'之类的事情。你能想象这个技能还有其他使用方式吗?"
- "用户说什么应该触发这个技能?"
为避免让用户不知所措,避免在单条消息中问太多问题。从最重要的问题开始,根据需要跟进以提高效率。
当对技能应该支持的功能有清晰的认识时,结束此步骤。
步骤 2:规划可重用的技能内容
要将具体示例转化为有效的技能,通过以下方式分析每个示例:
- 考虑如何从头开始执行示例
- 识别在执行这些工作流程时哪些脚本、参考资料和资源会有帮助
示例:在构建处理"帮我旋转这个 PDF"等查询的 pdf-editor 技能时,分析显示:
- 旋转 PDF 每次都需要重写相同的代码
- 在技能中存储
scripts/rotate_pdf.py脚本会很有帮助
示例:在设计处理"给我构建一个待办事项应用"或"给我构建一个跟踪步数的仪表板"等查询的 frontend-webapp-builder 技能时,分析显示:
- 编写前端 webapp 每次都需要相同的样板 HTML/React
- 在技能中存储包含样板 HTML/React 项目文件的
assets/hello-world/模板会很有帮助
示例:在构建处理"今天有多少用户登录?"等查询的 big-query 技能时,分析显示:
- 查询 BigQuery 每次都需要重新发现表模式和关系
- 在技能中存储记录表模式的
references/schema.md文件会很有帮助
要建立技能的内容,分析每个具体示例以创建要包含的可重用资源列表:脚本、参考资料和资源。
步骤 3:初始化技能
此时,是时候实际创建技能了。
只有在正在开发的技能已经存在,并且需要迭代或打包时才跳过此步骤。在这种情况下,继续下一步。
从头创建新技能时,始终运行 init_skill.py 脚本。该脚本方便地生成一个新的模板技能目录,自动包含技能所需的一切,使技能创建过程更加高效和可靠。
用法:
scripts/init_skill.py <skill-name> --path <output-directory> [--resources scripts,references,assets] [--examples]
示例:
scripts/init_skill.py my-skill --path skills/public
scripts/init_skill.py my-skill --path skills/public --resources scripts,references
scripts/init_skill.py my-skill --path skills/public --resources scripts --examples
脚本:
- 在指定路径创建技能目录
- 生成具有适当 frontmatter 和 TODO 占位符的 SKILL.md 模板
- 根据
--resources可选创建资源目录 - 当设置了
--examples时可选添加示例文件
初始化后,根据需要自定义 SKILL.md 并添加资源。如果使用了 --examples,替换或删除占位符文件。
步骤 4:编辑技能
编辑(新生成的或现有的)技能时,请记住技能是为另一个 Codex 实例使用而创建的。包含对 Codex 有益且不明显的信信息。考虑哪些程序性知识、特定领域的详细信息或可重用资源将帮助另一个 Codex 实例更有效地执行这些任务。
学习经过验证的设计模式
根据技能的需求查阅这些有用的指南:
- 多步骤流程:查看 references/workflows.md 了解顺序工作流程和条件逻辑
- 特定输出格式或质量标准:查看 references/output-patterns.md 了解模板和示例模式
这些文件包含有效技能设计的既定最佳实践。
从可重用的技能内容开始
要开始实现,从上面识别的可重用资源开始:scripts/、references/ 和 assets/ 文件。请注意,此步骤可能需要用户输入。例如,在实现 brand-guidelines 技能时,用户可能需要提供要存储在 assets/ 中的品牌资源或模板,或要存储在 references/ 中的文档。
添加的脚本必须通过实际运行来测试,以确保没有错误并且输出符合预期。如果有许多类似的脚本,只需要测试代表性样本,以确保它们都能正常工作,同时平衡完成时间。
如果使用了 --examples,删除技能不需要的任何占位符文件。只创建实际需要的资源目录。
更新 SKILL.md
编写指南: 始终使用命令式/不定式形式。
Frontmatter
编写包含 name 和 description 的 YAML frontmatter:
name:技能名称description:这是技能的主要触发机制,帮助 Codex 理解何时使用技能。- 包括技能做什么以及何时使用它的特定触发器/上下文。
- 在此处包含所有"何时使用"信息 - 不要在正文中。正文仅在触发后加载,因此正文中的"何时使用此技能"部分对 Codex 没有帮助。
docx技能的示例描述:"全面的文档创建、编辑和分析,支持跟踪更改、评论、格式保留和文本提取。当 Codex 需要处理专业文档(.docx 文件)时使用,用于:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理跟踪更改,(4) 添加评论,或任何其他文档任务"
不要在 YAML frontmatter 中包含任何其他字段。
Body
编写使用技能及其捆绑资源的说明。
步骤 5:打包技能
技能开发完成后,必须打包成分发的 .skill 文件,与用户共享。打包过程首先自动验证技能,以确保它满足所有要求:
scripts/package_skill.py <path/to/skill-folder>
可选的输出目录规范:
scripts/package_skill.py <path/to/skill-folder> ./dist
打包脚本将:
-
验证技能自动,检查:
- YAML frontmatter 格式和必需字段
- 技能命名约定和目录结构
- 描述完整性和质量
- 文件组织和资源引用
-
打包技能(如果验证通过),创建一个以技能命名的 .skill 文件(例如,
my-skill.skill),该文件包含所有文件并保持适当的分发目录结构。.skill 文件是一个带有 .skill 扩展名的 zip 文件。
如果验证失败,脚本将报告错误并退出而不创建包。修复任何验证错误并再次运行打包命令。
步骤 6:迭代
测试技能后,用户可能会请求改进。这通常在使用技能后立即发生,对技能的表现有新的上下文。
迭代工作流程:
- 在实际任务上使用技能
- 注意困难或低效
- 确定应如何更新 SKILL.md 或捆绑资源
- 实施更改并再次测试
スコア
総合スコア
リポジトリの品質指標に基づく評価
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
レビュー
レビュー機能は近日公開予定です