技能创建者

这个技能提供了创建有效技能的指导。

关于技能

技能是模块化、自包含的包，通过提供专门的知识、工作流程和工具来扩展Codex的能力。将它们视为特定领域或任务的"入职指南"——它们将Codex从一个通用代理转变为一个具备程序性知识的专门代理，而这些知识是任何模型都无法完全拥有的。

技能提供什么

专门的工作流程 - 特定领域的多步骤程序
工具集成 - 用于特定文件格式或API的指令
领域专长 - 公司特定的知识、模式、业务逻辑
捆绑资源 - 用于复杂和重复任务的脚本、参考资料和资产

核心原则

简洁是关键

上下文窗口是公共产品。技能与Codex所需的其他一切共享上下文窗口：系统提示、对话历史、其他技能的元数据以及实际的用户请求。

默认假设：Codex已经非常智能。 只添加Codex尚未拥有的上下文。挑战每一条信息："Codex真的需要这个解释吗？“以及"这段话是否值得它的令牌成本？”

比起冗长的解释，更倾向于简洁的例子。

设置适当的自由度

将具体性水平与任务的脆弱性和可变性相匹配：

高自由度（基于文本的指令）：当多种方法有效、决策取决于上下文或启发式指导方法时使用。

中等自由度（带参数的伪代码或脚本）：当存在首选模式、可接受一些变化或配置影响行为时使用。

低自由度（特定脚本、少参数）：当操作脆弱且容易出错、一致性至关重要或必须遵循特定顺序时使用。

将Codex视为探索路径：狭窄的桥梁需要特定的护栏（低自由度），而开阔的领域允许多条路线（高自由度）。

技能的解剖

每个技能由必需的SKILL.md文件和可选的捆绑资源组成：

skill-name/
├── SKILL.md (必需)
│   ├── YAML前言元数据 (必需)
│   │   ├── name: (必需)
│   │   └── description: (必需)
│   └── Markdown指令 (必需)
└── 捆绑资源 (可选)
    ├── scripts/          - 可执行代码 (Python/Bash/etc.)
    ├── references/       - 必要时加载到上下文中的文档
    └── assets/           - 在输出中使用的文件（模板、图标、字体等）

SKILL.md (必需)

每个SKILL.md由以下组成：

前言 (YAML)：包含name和description字段。这些是Codex读取以确定何时使用技能的唯一字段，因此非常重要，需要清晰全面地描述技能是什么，以及何时使用它。
正文 (Markdown)：使用技能及其捆绑资源的指令和指导。仅在技能触发后（如果有的话）加载。

捆绑资源 (可选)

脚本 (`scripts/`)

需要确定性可靠性或重复编写的可执行代码（Python/Bash等）。

何时包括：当相同的代码被重复编写或需要确定性可靠性时
示例：scripts/rotate_pdf.py用于PDF旋转任务
好处：令牌效率高，确定性，可能在不加载到上下文的情况下执行
注意：脚本仍可能需要被Codex读取以进行修补或环境特定的调整

参考资料 (`references/`)

打算根据需要加载到上下文中以通知Codex的过程和思考的文档和参考资料。

何时包括：对于Codex在工作时应该参考的文档
示例：references/finance.md用于财务模式，references/mnda.md用于公司的NDA模板，references/policies.md用于公司政策，references/api_docs.md用于API规范
用例：数据库模式、API文档、领域知识、公司政策、详细的工作流指南
好处：保持SKILL.md精简，仅在Codex确定需要时加载
最佳实践：如果文件较大（>10k字），在SKILL.md中包括grep搜索模式
避免重复：信息应该只存在于SKILL.md或参考资料文件中，而不是两者都有。除非信息确实是技能的核心——这样可以保持SKILL.md精简，同时使信息在不占用上下文窗口的情况下可发现。在SKILL.md中只保留必要的程序性指令和工作流指导；将详细的参考资料、模式和示例移动到参考资料文件中。

资产 (`assets/`)

不打算加载到上下文中，而是在Codex产生的输出中使用的文件。

何时包括：当技能需要在最终输出中使用的文件时
示例：assets/logo.png用于品牌资产，assets/slides.pptx用于PowerPoint模板，assets/frontend-template/用于HTML/React样板，assets/font.ttf用于排版
用例：模板、图像、图标、样板代码、字体、复制或修改的样本文档
好处：将输出资源与文档分开，使Codex能够在不加载它们到上下文的情况下使用文件

技能中不应包含的内容

技能应该只包含直接支持其功能的必需文件。不要创建多余的文档或辅助文件，包括：

README.md
INSTALLATION_GUIDE.md
QUICK_REFERENCE.md
CHANGELOG.md
等。

技能应该只包含AI代理执行手头工作所需的信息。它不应包含创建过程、设置和测试程序、面向用户的文档等辅助上下文。创建额外的文档文件只会增加混乱和困惑。

渐进式披露设计原则

技能使用三级加载系统有效管理上下文：

元数据（名称+描述） - 始终在上下文中（~100字）
SKILL.md正文 - 当技能触发时（<5k字）
捆绑资源 - 根据Codex的需要（由于脚本可以不读入上下文窗口执行，因此不受限制）

渐进式披露模式

保持SKILL.md正文在500行以内，以最小化上下文膨胀。当接近此限制时，将内容分割到单独的文件中。当将内容分割到其他文件时，非常重要的是要从SKILL.md中引用它们，并清楚地描述何时阅读它们，以确保技能的读者知道它们存在以及何时使用它们。

**关键原则：**当技能支持多种变体、框架或选项时，只在SKILL.md中保留核心工作流和选择指导。将变体特定的详细信息（模式、示例、配置）移动到单独的参考资料文件中。

模式1：带有参考资料的高级指南

# PDF处理

## 快速开始

使用pdfplumber提取文本：
[代码示例]

## 高级功能

- **表单填写**：查看[FORMS.md](FORMS.md)获取完整指南
- **API参考**：查看[REFERENCE.md](REFERENCE.md)获取所有方法
- **示例**：查看[EXAMPLES.md](EXAMPLES.md)获取常见模式

Codex仅在需要时加载FORMS.md、REFERENCE.md或EXAMPLES.md。

模式2：特定领域的组织

对于具有多个领域的技能，按领域组织内容以避免加载不相关的上下文：

bigquery-skill/
├── SKILL.md （概览和导航）
└── reference/
    ├── finance.md （收入、计费指标）
    ├── sales.md （机会、管道）
    ├── product.md （API使用、功能）
    └── marketing.md （活动、归因）

当用户询问销售指标时，Codex只读取sales.md。

类似地，对于支持多种框架或变体的技能，按变体组织：

cloud-deploy/
├── SKILL.md （工作流+提供商选择）
└── references/
    ├── aws.md （AWS部署模式）
    ├── gcp.md （GCP部署模式）
    └── azure.md （Azure部署模式）

当用户选择AWS时，Codex只读取aws.md。

模式3：条件详细信息

显示基本内容，链接到高级内容：

# DOCX处理

## 创建文档

使用docx-js创建新文档。查看[DOCX-JS.md](DOCX-JS.md)。

## 编辑文档

对于简单编辑，直接修改XML。

**对于跟踪更改**：查看[REDLINING.md](REDLINING.md)
**对于OOXML详细信息**：查看[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-editor技能来处理像"帮我旋转这个PDF"这样的查询时，分析显示：

旋转PDF需要每次都重写相同的代码
一个scripts/rotate_pdf.py脚本将有助于存储在技能中

示例：当设计一个frontend-webapp-builder技能来处理像"为我构建一个待办事项应用"或"为我构建一个跟踪我的步数的仪表板"这样的查询时，分析显示：

编写前端Web应用需要每次都相同的样板HTML/React
一个assets/hello-world/模板包含样板HTML/React项目文件将有助于存储在技能中

示例：当构建一个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

该脚本：

在指定路径创建技能目录
生成一个带有适当前言和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

**写作指南：**始终使用命令式/不定式形式。

前言

用name和description写YAML前言：

name：技能名称
description：这是触发技能的主要机制，帮助Codex了解何时使用技能。
- 包括技能做什么以及何时使用的具体触发器/上下文。
- 在这里包括所有"何时使用"信息 - 不在正文中。正文仅在触发后加载，因此正文中的"何时使用这个技能"部分对Codex没有帮助。
- 示例描述，用于docx技能：“全面的文档创建、编辑和分析，支持跟踪更改、注释、格式保留和文本提取。当Codex需要使用专业文档（.docx文件）进行：（1）创建新文档，（2）修改或编辑内容，（3）处理跟踪更改，（4）添加注释，或任何其他文档任务”

不要在YAML前言中包括任何其他字段。

正文

编写使用技能及其捆绑资源的指令。

第5步：打包技能

一旦技能开发完成，必须将其打包成一个可分发的.skill文件，与用户共享。打包过程首先自动验证技能以确保它满足所有要求：

scripts/package_skill.py <path/to/skill-folder>

可选输出目录指定：

scripts/package_skill.py <path/to/skill-folder> ./dist

打包脚本将：

验证技能自动，检查：
- YAML前言格式和必需字段
- 技能命名约定和目录结构
- 描述的完整性和质量
- 文件组织和资源引用
打包技能如果验证通过，创建一个以技能命名的.skill文件（例如，my-skill.skill），包括所有文件，并保持适当的目录结构以进行分发。.skill文件是一个带有.skill扩展名的zip文件。

安全限制：如果存在任何符号链接，将拒绝并打包失败。

如果验证失败，脚本将报告错误并退出而不创建包。修复任何验证错误，然后再次运行打包命令。

第6步：迭代

在测试技能后，用户可能会请求改进。这通常发生在使用技能后不久，对技能表现的上下文还记忆犹新。

迭代工作流程：

在实际任务中使用技能
注意挣扎或低效
确定应该如何更新SKILL.md或捆绑资源
实施更改并再次测试