技能创建指南 是做什么的？
此技能提供有关如何创建有效技能的指导。
关于技能
技能是模块化的、自包含的文件夹，通过提供专业知识、工作流和工具来扩展 Codex 的能力。可以将它们视为特定领域或任务的“入手指南”——它们将 Codex 从通用代理转变为配备有程序性知识的专业代理，这是任何模型都无法完全拥有的。
技能提供的内容
- 专业化工作流 - 针对特定领域的多步骤程序
- 工具集成 - 处理特定文件格式或 API 的说明
- 领域专业知识 - 公司特定知识、模式、业务逻辑
- 捆绑资源 - 用于复杂和重复性任务的脚本、参考和资源
核心原则
简洁是关键
上下文窗口是一种公共资源。技能与 Codex 所需的其他所有内容共享上下文窗口：系统提示、对话历史、其他技能的元数据以及实际的用户请求。
默认假设：Codex 已经非常智能。 仅添加 Codex 尚未掌握的上下文。对每条信息都提出质疑：“Codex 真的需要这个解释吗？”以及“这段文字是否值得消耗其 token 成本？”
倾向于使用简洁的示例，而不是冗长的解释。
设置适当的自由度
将具体程度与任务的脆弱性和可变性相匹配：
高自由度（基于文本的指令）：当多种方法都可行、决策取决于上下文或启发式方法指导方法时使用。
中自由度（伪代码或带有参数的脚本）：当存在首选模式、允许一定程度的变体或配置影响行为时使用。
低自由度（特定脚本，少量参数）：当操作脆弱且容易出错、一致性至关重要或必须遵循特定顺序时使用。
可以将 Codex 想象为探索一条路径：一座带有悬崖的窄桥需要特定的护栏（低自由度），而一片开阔地带允许多条路线（高自由度）。
保护验证完整性
在迭代过程中，你可以使用子代理来验证技能是否能在实际任务中工作，或者怀疑的问题是否真实存在。当希望在修订后对技能的行为、输出或失败模式进行独立检查时，这最为有用。仅在可以启动新的子代理时才这样做。
当使用子代理进行验证时，将其视为一个评估面。目标是了解技能是否具有泛化能力，而不是另一个代理能否从泄露的上下文中重建答案。
倾向于使用原始制品，例如示例提示、输出、差异、日志或跟踪。仅提供执行验证所需的最小任务局部上下文。除非验证明确要求，否则避免传递预期答案、怀疑的错误、预期的修复或你之前的结论。
技能的解剖结构
每个技能由一个必需的 SKILL.md 文件和可选的捆绑资源组成：
skill-name/
├── SKILL.md (必需)
│ ├── YAML 前置元数据 (必需)
│ │ ├── name: (必需)
│ │ └── description: (必需)
│ └── Markdown 指令 (必需)
├── agents/ (推荐)
│ └── openai.yaml - 技能列表和芯片的 UI 元数据
└── 捆绑资源 (可选)
├── scripts/ - 可执行代码 (Python/Bash/等)
├── references/ - 旨在根据需要加载到上下文中的文档
└── assets/ - 输出中使用的文件 (模板、图标、字体等)
SKILL.md (必需)
每个 SKILL.md 包括：
- 前置元数据 (YAML)：包含
name和description字段。这些是 Codex 唯一用来确定何时使用技能的字段，因此在描述技能是什么以及何时应使用时，表述清晰且全面非常重要。 - 正文 (Markdown)：使用技能的指令和指南。仅在技能触发后（如果触发）才加载。
代理元数据（推荐）
- 面向 UI 的元数据，用于技能列表和芯片
- 在生成值之前阅读 references/openai_yaml.md，并遵循其描述和约束
- 创建：通过阅读技能生成面向人类的
display_name、short_description和default_prompt - 通过将值作为
--interface key=value传递给scripts/generate_openai_yaml.py或scripts/init_skill.py来确定性生成 - 在更新时：验证
agents/openai.yaml是否仍与 SKILL.md 匹配；如果过时则重新生成 - 仅在明确提供时才包含其他可选的界面字段（图标、品牌颜色）
- 有关字段定义和示例，请参阅 references/openai_yaml.md
捆绑资源（可选）
脚本 (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 确定需要时加载
- 最佳实践：如果文件很大（>1万字），则在 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 代理执行当前任务所需的信息。它不应包含有关创建过程、设置和测试程序、面向用户的文档等的辅助上下文。创建额外的文档文件只会增加混乱。
渐进式信息披露设计原则
技能使用三级加载系统来有效管理上下文：
- 元数据（名称 + 描述） - 始终在上下文中（约100个词）
- SKILL.md 正文 - 当技能触发时（<5000词）
- 捆绑资源 - 按 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）
- 验证技能（运行 quick_validate.py）
- 基于实际使用情况进行迭代，并对复杂的技能进行前向测试。
按顺序执行这些步骤，仅在明确有理由认为不适用时才跳过。
技能命名
- 仅使用小写字母、数字和连字符；将用户提供的标题规范化为连字符形式（例如，“Plan Mode” ->
plan-mode）。 - 生成名称时，生成一个不超过 64 个字符的名称（字母、数字、连字符）。
- 优先使用短小、以动词开头的短语来描述操作。
- 在能提高清晰度或触发效果时，按工具命名空间（例如，
gh-address-comments、linear-address-issue）。 - 将技能文件夹精确地命名为技能名称。
步骤 1：通过具体示例理解技能
仅当技能的使用模式已经清晰理解时才跳过此步骤。即使在处理现有技能时，它仍然有价值。
要创建有效的技能，请清晰理解技能将如何使用的具体示例。这种理解可以来自直接的用户示例，也可以来自通过用户反馈验证的生成示例。
例如，在构建图像编辑器技能时，相关问题包括：
- “图像编辑器技能应支持哪些功能？编辑、旋转，还有其他吗？”
- “您能举一些如何使用此技能的示例吗？”
- “我可以想象用户会提出诸如‘从这张图片中去除红眼’或‘旋转这张图片’之类的要求。您还能想到使用此技能的其他方式吗？”
- “用户说什么话会触发此技能？”
- “我应在哪里创建此技能？如果您没有偏好，我将把它放在
$CODEX_HOME/skills（或当CODEX_HOME未设置时为~/.codex/skills）中，以便 Codex 自动发现它。”
为避免使用户感到不知所措，避免在一条消息中提出太多问题。从最重要的问题开始，根据需要跟进问题以提高效果。
当对技能应支持的功能有清晰概念时，结束此步骤。
步骤 2：规划可重用的技能内容
要将具体示例转化为有效的技能，通过以下方式分析每个示例：
- 考虑如何从头开始执行该示例
- 识别在重复执行这些工作流时会有帮助的脚本、参考资料和资源
示例：在构建一个 pdf-editor 技能来处理“请帮我旋转此 PDF”之类的查询时，分析显示：
- 旋转 PDF 需要每次重写相同的代码
- 在技能中存储一个
scripts/rotate_pdf.py脚本会很有帮助
示例：在设计一个 frontend-webapp-builder 技能来处理“为我构建一个待办事项应用”或“为我构建一个用于跟踪步数的仪表板”之类的查询时，分析显示：
- 编写前端 Web 应用每次都需要相同的 HTML/React 样板代码
- 在技能中存储一个包含样板 HTML/React 项目文件的
assets/hello-world/模板会很有帮助
示例：在构建一个 big-query 技能来处理诸如“H
…
[此处原文截断]