skill-creator
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseSkill Creator
Skill Creator
This skill provides guidance for creating effective skills.
本技能为创建高效可用的技能提供指导。
About Skills
关于技能
Skills are modular, self-contained packages that extend Codex's capabilities by providing
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
domains or tasks—they transform Codex from a general-purpose agent into a specialized agent
equipped with procedural knowledge that no model can fully possess.
技能是模块化、自包含的包,通过提供专业知识、工作流和工具来扩展Codex的能力。你可以把它们看作特定领域或任务的“入门指南”——它们能将通用型Agent Codex转变为专业Agent,具备任何大模型都无法完全自带的流程类知识。
What Skills Provide
技能的能力构成
- Specialized workflows - Multi-step procedures for specific domains
- Tool integrations - Instructions for working with specific file formats or APIs
- Domain expertise - Company-specific knowledge, schemas, business logic
- Bundled resources - Scripts, references, and assets for complex and repetitive tasks
- 专业工作流:特定领域的多步操作流程
- 工具集成:对接特定文件格式或API的操作说明
- 领域 expertise:企业专属知识、数据 schema、业务逻辑
- 捆绑资源:用于处理复杂重复性任务的脚本、参考资料、资产
Core Principles
核心原则
Concise is Key
简洁是关键
The context window is a public good. Skills share the context window with everything else Codex needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
Default assumption: Codex is already very smart. Only add context Codex doesn't already have. Challenge each piece of information: "Does Codex really need this explanation?" and "Does this paragraph justify its token cost?"
Prefer concise examples over verbose explanations.
上下文窗口是公共资源。技能需要和Codex所需的所有其他内容共享上下文窗口:系统提示词、对话历史、其他技能的元数据,以及用户的实际请求。
默认前提:Codex本身已经足够智能。 仅添加Codex尚未掌握的上下文内容。对每一条信息都要提出质疑:“Codex真的需要这段解释吗?”以及“这段内容占用的token成本值得吗?”
优先选择简洁的示例,而非冗长的解释。
Set Appropriate Degrees of Freedom
设定合适的自由度
Match the level of specificity to the task's fragility and variability:
High freedom (text-based instructions): Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
Medium freedom (pseudocode or scripts with parameters): Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
Low freedom (specific scripts, few parameters): Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
Think of Codex as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
根据任务的容错性和可变程度匹配信息的具体程度:
高自由度(纯文本说明):适用于存在多种有效方案、决策依赖上下文、或需要靠启发式方法推进的场景。
中等自由度(带参数的伪代码或脚本):适用于存在推荐实现模式、允许一定程度的变体、或配置会影响行为的场景。
低自由度(特定脚本、极少参数):适用于操作脆弱易出错、一致性至关重要、或必须遵循特定执行顺序的场景。
你可以把Codex的执行过程看作探路:悬崖边的窄桥需要明确的护栏(低自由度),而开阔的原野则允许选择多条路线(高自由度)。
Anatomy of a Skill
技能的结构
Every skill consists of a required SKILL.md file and optional bundled resources:
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-name/
├── SKILL.md (必填)
│ ├── YAML frontmatter 元数据 (必填)
│ │ ├── name: (必填)
│ │ └── description: (必填)
│ └── Markdown 操作说明 (必填)
└── 捆绑资源 (可选)
├── scripts/ - 可执行代码(Python/Bash等)
├── references/ - 按需加载到上下文的文档资料
└── assets/ - 输出产物用到的文件(模板、图标、字体等)SKILL.md (required)
SKILL.md(必填)
Every SKILL.md consists of:
- Frontmatter (YAML): Contains and
namefields. These are the only fields that Codex reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.description - Body (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
每个SKILL.md都包含以下部分:
- Frontmatter(YAML格式):包含和
name字段。这是Codex判断何时触发该技能的唯一依据,因此清晰全面地描述技能的用途和触发场景非常重要。description - 正文(Markdown格式):使用技能的操作说明和指导。仅在技能触发后才会加载(如果需要的话)。
Bundled Resources (optional)
捆绑资源(可选)
Scripts (scripts/
)
scripts/脚本(scripts/
)
scripts/Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
- When to include: When the same code is being rewritten repeatedly or deterministic reliability is needed
- Example: for PDF rotation tasks
scripts/rotate_pdf.py - Benefits: Token efficient, deterministic, may be executed without loading into context
- Note: Scripts may still need to be read by Codex for patching or environment-specific adjustments
用于需要确定性可靠性或会被反复编写的任务的可执行代码(Python/Bash等)。
- 何时加入:当相同代码会被反复编写,或者需要确定性的执行结果时
- 示例: 用于PDF旋转任务的
scripts/rotate_pdf.py - 优势: 节省token、结果确定、无需加载到上下文即可执行
- 注意: Codex可能仍需要读取脚本内容来进行补丁修改或适配特定环境
References (references/
)
references/参考资料(references/
)
references/Documentation and reference material intended to be loaded as needed into context to inform Codex's process and thinking.
- When to include: For documentation that Codex should reference while working
- Examples: for financial schemas,
references/finance.mdfor company NDA template,references/mnda.mdfor company policies,references/policies.mdfor API specificationsreferences/api_docs.md - Use cases: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
- Benefits: Keeps SKILL.md lean, loaded only when Codex determines it's needed
- Best practice: If files are large (>10k words), include grep search patterns in SKILL.md
- Avoid duplication: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
按需加载到上下文的文档和参考材料,用于支撑Codex的处理流程和决策。
- 何时加入:用于Codex工作过程中需要参考的文档
- 示例: 记录财务schema的、企业NDA模板
references/finance.md、企业政策references/mnda.md、API规范references/policies.mdreferences/api_docs.md - 适用场景: 数据库schema、API文档、领域知识、企业政策、详细工作流指南
- 优势: 保持SKILL.md精简,仅在Codex判定需要时才加载
- 最佳实践: 如果文件过大(超过1万字),在SKILL.md中加入grep搜索模式
- 避免重复: 信息要么存放在SKILL.md中,要么存放在参考文件中,不要同时存在。详细信息优先放在参考文件中,除非是技能的核心内容——这样既能保持SKILL.md精简,又能让信息可被检索,同时不会占用过多上下文窗口。仅在SKILL.md中保留核心流程说明和工作流指导;将详细参考材料、schema、示例移动到参考文件中。
Assets (assets/
)
assets/资产(assets/
)
assets/Files not intended to be loaded into context, but rather used within the output Codex produces.
- When to include: When the skill needs files that will be used in the final output
- Examples: for brand assets,
assets/logo.pngfor PowerPoint templates,assets/slides.pptxfor HTML/React boilerplate,assets/frontend-template/for typographyassets/font.ttf - Use cases: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
- Benefits: Separates output resources from documentation, enables Codex to use files without loading them into context
不需要加载到上下文,而是用于Codex生成的输出产物中的文件。
- 何时加入: 当技能需要用到最终输出中会包含的文件时
- 示例: 品牌资产、PowerPoint模板
assets/logo.png、HTML/React初始化模板assets/slides.pptx、字体文件assets/frontend-template/assets/font.ttf - 适用场景: 模板、图片、图标、初始化代码、字体、会被复制或修改的示例文档
- 优势: 区分输出资源和文档,允许Codex无需加载到上下文即可使用这些文件
What to Not Include in a Skill
技能中不应包含的内容
A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- etc.
The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxiliary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
技能仅应包含直接支撑其功能的必要文件。不要创建多余的文档或辅助文件,包括:
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- 等等
技能仅应包含AI Agent完成当前工作所需的信息。不应包含关于技能创建过程的辅助上下文、安装和测试流程、面向用户的文档等。创建额外的文档文件只会增加杂乱和混淆。
Progressive Disclosure Design Principle
渐进式披露设计原则
Skills use a three-level loading system to manage context efficiently:
- Metadata (name + description) - Always in context (~100 words)
- SKILL.md body - When skill triggers (<5k words)
- Bundled resources - As needed by Codex (Unlimited because scripts can be executed without reading into context window)
技能使用三级加载系统来高效管理上下文:
- 元数据(名称+描述):始终在上下文中(约100词)
- SKILL.md正文:技能触发时加载(少于5000词)
- 捆绑资源:Codex按需加载(无上限,因为脚本无需读取到上下文窗口即可执行)
Progressive Disclosure Patterns
渐进式披露模式
Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
Key principle: When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
Pattern 1: High-level guide with references
markdown
undefined将SKILL.md正文内容控制在核心必要范围内,不超过500行,以减少上下文臃肿。接近这个限制时将内容拆分到单独的文件中。将内容拆分到其他文件时,非常重要的一点是要在SKILL.md中引用它们,并明确说明何时需要读取这些文件,确保技能的使用者知道它们的存在和使用时机。
核心原则: 当一个技能支持多种变体、框架或选项时,仅在SKILL.md中保留核心工作流和选择指导。将变体相关的细节(模式、示例、配置)移动到单独的参考文件中。
模式1:带参考资料的高层指南
markdown
undefinedPDF Processing
PDF Processing
Quick start
快速开始
Extract text with pdfplumber:
[code example]
使用pdfplumber提取文本:
[代码示例]
Advanced features
高级功能
- Form filling: See FORMS.md for complete guide
- API reference: See REFERENCE.md for all methods
- Examples: See EXAMPLES.md for common patterns
Codex loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
**Pattern 2: Domain-specific organization**
For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
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)
When a user asks about sales metrics, Codex only reads sales.md.
Similarly, for skills supporting multiple frameworks or variants, organize by variant:
cloud-deploy/
├── SKILL.md (workflow + provider selection)
└── references/
├── aws.md (AWS deployment patterns)
├── gcp.md (GCP deployment patterns)
└── azure.md (Azure deployment patterns)
When the user chooses AWS, Codex only reads aws.md.
**Pattern 3: Conditional details**
Show basic content, link to advanced content:
```markdown- 表单填充:完整指南参见 FORMS.md
- API参考:所有方法参见 REFERENCE.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:条件式详情**
展示基础内容,链接到高级内容:
```markdownDOCX Processing
DOCX Processing
Creating documents
创建文档
Use docx-js for new documents. See DOCX-JS.md.
新文档使用docx-js创建。参见 DOCX-JS.md。
Editing documents
编辑文档
For simple edits, modify the XML directly.
For tracked changes: See REDLINING.md
For OOXML details: See OOXML.md
Codex reads REDLINING.md or OOXML.md only when the user needs those features.
**Important guidelines:**
- **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
- **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Codex can see the full scope when previewing.简单修改可直接修改XML。
修订痕迹相关操作:参见 REDLINING.md
OOXML细节:参见 OOXML.md
Codex仅在用户需要对应功能时才读取REDLINING.md或OOXML.md。
**重要指南:**
- **避免深层嵌套的参考引用**:参考文件保持在SKILL.md下一级,所有参考文件都应直接从SKILL.md链接。
- **长参考文件要结构化**:超过100行的文件要在顶部添加目录,方便Codex预览时了解完整范围。Skill Creation Process
技能创建流程
Skill creation involves these steps:
- Understand the skill with concrete examples
- Plan reusable skill contents (scripts, references, assets)
- Initialize the skill (run init_skill.py)
- Edit the skill (implement resources and write SKILL.md)
- Package the skill (run package_skill.py)
- Iterate based on real usage
Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
技能创建包含以下步骤:
- 通过具体示例理解技能需求
- 规划可复用的技能内容(脚本、参考资料、资产)
- 初始化技能(运行init_skill.py)
- 编辑技能(实现资源并编写SKILL.md)
- 打包技能(运行package_skill.py)
- 基于实际使用迭代优化
请按顺序执行这些步骤,仅在有明确理由证明某步骤不适用时才跳过。
Skill Naming
技能命名规则
- Use lowercase letters, digits, and hyphens only; normalize user-provided titles to hyphen-case (e.g., "Plan Mode" -> ).
plan-mode - When generating names, generate a name under 64 characters (letters, digits, hyphens).
- Prefer short, verb-led phrases that describe the action.
- Namespace by tool when it improves clarity or triggering (e.g., ,
gh-address-comments).linear-address-issue - Name the skill folder exactly after the skill name.
- 仅使用小写字母、数字和连字符;将用户提供的标题统一转换为连字符格式(例如“Plan Mode”转为)。
plan-mode - 生成名称时,控制长度在64字符以内(字母、数字、连字符)。
- 优先选择简短的、动词开头的短语描述动作。
- 如果能提升清晰度或触发准确率,可按工具添加命名空间(例如、
gh-address-comments)。linear-address-issue - 技能文件夹名称与技能名称完全一致。
Step 1: Understanding the Skill with Concrete Examples
步骤1:通过具体示例理解技能需求
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
For example, when building an image-editor skill, relevant questions include:
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
- "Can you give some examples of how this skill would be used?"
- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
- "What would a user say that should trigger this skill?"
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
Conclude this step when there is a clear sense of the functionality the skill should support.
仅当技能的使用模式已经非常明确时才跳过此步骤。即使是处理现有技能,这一步也仍然有价值。
要创建高效的技能,需要清晰了解技能使用场景的具体示例。这些理解可以来自用户直接提供的示例,也可以是经过用户反馈验证的生成示例。
例如,构建image-editor技能时,相关问题包括:
- “image-editor技能需要支持哪些功能?编辑、旋转,还有其他吗?”
- “你能举几个这个技能的使用示例吗?”
- “我能想到用户会提出‘移除这张图片的红眼’或者‘旋转这张图片’这类需求,你还能想到其他使用场景吗?”
- “用户说什么内容的时候应该触发这个技能?”
为了避免给用户造成负担,不要在单条消息中问太多问题。从最重要的问题开始,按需跟进,效果会更好。
当明确了技能需要支持的功能范围时,此阶段结束。
Step 2: Planning the Reusable Skill Contents
步骤2:规划可复用的技能内容
To turn concrete examples into an effective skill, analyze each example by:
- Considering how to execute on the example from scratch
- Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
Example: When building a skill to handle queries like "Help me rotate this PDF," the analysis shows:
pdf-editor- Rotating a PDF requires re-writing the same code each time
- A script would be helpful to store in the skill
scripts/rotate_pdf.py
Example: When designing a skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
frontend-webapp-builder- Writing a frontend webapp requires the same boilerplate HTML/React each time
- An template containing the boilerplate HTML/React project files would be helpful to store in the skill
assets/hello-world/
Example: When building a skill to handle queries like "How many users have logged in today?" the analysis shows:
big-query- Querying BigQuery requires re-discovering the table schemas and relationships each time
- A file documenting the table schemas would be helpful to store in the skill
references/schema.md
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
要将具体示例转化为高效的技能,需要对每个示例做如下分析:
- 思考如何从零开始执行这个示例对应的任务
- 识别重复执行这些工作流时会用到的脚本、参考资料和资产
示例:构建技能处理“帮我旋转这个PDF”这类需求时,分析得出:
pdf-editor- 旋转PDF每次都需要重写相同的代码
- 在技能中存放脚本会很有帮助
scripts/rotate_pdf.py
示例:设计技能处理“帮我做一个待办应用”或者“帮我做一个步数统计看板”这类需求时,分析得出:
frontend-webapp-builder- 编写前端Web应用每次都需要相同的HTML/React初始化代码
- 在技能中存放包含HTML/React项目初始化文件的模板会很有帮助
assets/hello-world/
示例:构建技能处理“今天有多少用户登录了?”这类需求时,分析得出:
big-query- 查询BigQuery每次都需要重新梳理表结构和关联关系
- 在技能中存放记录表结构的文件会很有帮助
references/schema.md
通过分析每个具体示例,整理出需要包含的可复用资源列表:脚本、参考资料和资产,以此确定技能的内容构成。
Step 3: Initializing the Skill
步骤3:初始化技能
At this point, it is time to actually create the skill.
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
When creating a new skill from scratch, always run the script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
init_skill.pyUsage:
bash
scripts/init_skill.py <skill-name> --path <output-directory> [--resources scripts,references,assets] [--examples]Examples:
bash
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 --examplesThe script:
- Creates the skill directory at the specified path
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
- Optionally creates resource directories based on
--resources - Optionally adds example files when is set
--examples
After initialization, customize the SKILL.md and add resources as needed. If you used , replace or delete placeholder files.
--examples到这一步就可以正式创建技能了。
仅当正在开发的技能已经存在,需要进行迭代或打包时才跳过此步骤,这种情况直接进入下一步。
从零创建新技能时,始终运行脚本。该脚本会方便地生成新的技能目录模板,自动包含技能所需的所有内容,大幅提升技能创建流程的效率和可靠性。
init_skill.py使用方法:
bash
scripts/init_skill.py <skill-name> --path <output-directory> [--resources scripts,references,assets] [--examples]示例:
bash
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并添加资源。如果你使用了参数,请替换或删除占位符文件。
--examplesStep 4: Edit the Skill
步骤4:编辑技能
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Codex to use. Include information that would be beneficial and non-obvious to Codex. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Codex instance execute these tasks more effectively.
编辑(新生成或现有)技能时,请记住你创建的技能是给其他Codex实例使用的。要加入对Codex有价值且Codex不知道的信息。思考哪些流程知识、领域特定细节或可复用资产能够帮助其他Codex实例更高效地执行这些任务。
Learn Proven Design Patterns
学习成熟的设计模式
Consult these helpful guides based on your skill's needs:
- Multi-step processes: See references/workflows.md for sequential workflows and conditional logic
- Specific output formats or quality standards: See references/output-patterns.md for template and example patterns
These files contain established best practices for effective skill design.
根据你的技能需求参考这些有用的指南:
- 多步流程:顺序工作流和条件逻辑参见references/workflows.md
- 特定输出格式或质量标准:模板和示例模式参见references/output-patterns.md
这些文件包含了经过验证的高效技能设计最佳实践。
Start with Reusable Skill Contents
从可复用技能内容开始
To begin implementation, start with the reusable resources identified above: , , and files. Note that this step may require user input. For example, when implementing a skill, the user may need to provide brand assets or templates to store in , or documentation to store in .
scripts/references/assets/brand-guidelinesassets/references/Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
If you used , delete any placeholder files that are not needed for the skill. Only create resource directories that are actually required.
--examples实现时,先从前面识别出的可复用资源开始:、和文件。注意这一步可能需要用户输入。例如,实现技能时,用户可能需要提供存放在中的品牌资产或模板,或者存放在中的文档。
scripts/references/assets/brand-guidelinesassets/references/添加的脚本必须实际运行测试,确保没有bug,输出符合预期。如果有很多类似的脚本,仅需要测试代表性样本即可,在保证可用性的同时平衡完成时间。
如果你使用了参数,删除所有技能不需要的占位符文件。仅创建实际需要的资源目录。
--examplesUpdate SKILL.md
更新SKILL.md
Writing Guidelines: Always use imperative/infinitive form.
编写规范: 始终使用祈使/不定式形式。
Frontmatter
Frontmatter
Write the YAML frontmatter with and :
namedescription- : The skill name
name - : This is the primary triggering mechanism for your skill, and helps Codex understand when to use the skill.
description- Include both what the Skill does and specific triggers/contexts for when to use it.
- Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to Codex.
- Example description for a skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Codex needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
docx
Do not include any other fields in YAML frontmatter.
编写包含和的YAML frontmatter:
namedescription- :技能名称
name - :这是技能的核心触发机制,帮助Codex了解何时使用该技能。
description- 同时包含技能的功能,以及使用它的具体触发条件/场景。
- 所有“何时使用”的信息都放在这里——不要放在正文中。正文仅在触发后才会加载,因此正文中的“何时使用本技能”板块对Codex没有用。
- 技能的description示例:“提供全面的文档创建、编辑和分析能力,支持修订痕迹、评论、格式保留和文本提取。适用于Codex需要处理专业文档(.docx文件)的场景:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理修订痕迹,(4) 添加评论,或任何其他文档相关任务”
docx
YAML frontmatter中不要包含其他任何字段。
Body
正文
Write instructions for using the skill and its bundled resources.
编写使用技能及其捆绑资源的操作说明。
Step 5: Packaging a Skill
步骤5:打包技能
Once development of the skill is complete, it must be packaged into a distributable .skill file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
bash
scripts/package_skill.py <path/to/skill-folder>Optional output directory specification:
bash
scripts/package_skill.py <path/to/skill-folder> ./distThe packaging script will:
-
Validate the skill automatically, checking:
- YAML frontmatter format and required fields
- Skill naming conventions and directory structure
- Description completeness and quality
- File organization and resource references
-
Package the skill if validation passes, creating a .skill file named after the skill (e.g.,) that includes all files and maintains the proper directory structure for distribution. The .skill file is a zip file with a .skill extension.
my-skill.skillSecurity restriction: symlinks are rejected and packaging fails when any symlink is present.
If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
技能开发完成后,必须打包为可分发的.skill文件共享给用户。打包流程会首先自动校验技能,确保其满足所有要求:
bash
scripts/package_skill.py <path/to/skill-folder>可选指定输出目录:
bash
scripts/package_skill.py <path/to/skill-folder> ./dist打包脚本会:
-
自动校验技能,检查:
- YAML frontmatter格式和必填字段
- 技能命名规范和目录结构
- 描述的完整性和质量
- 文件组织和资源引用
-
校验通过后打包技能,创建以技能命名的.skill文件(例如),包含所有文件并保持正确的目录结构用于分发。.skill文件是后缀为.skill的zip文件。
my-skill.skill安全限制:存在软链接时打包会失败,不允许包含软链接。
如果校验失败,脚本会报错并退出,不会创建包。修复所有校验错误后重新运行打包命令。
Step 6: Iterate
步骤6:迭代优化
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
Iteration workflow:
- Use the skill on real tasks
- Notice struggles or inefficiencies
- Identify how SKILL.md or bundled resources should be updated
- Implement changes and test again
技能测试后,用户可能会提出改进需求。通常这会发生在使用技能之后,用户对技能的表现有最新的上下文感受。
迭代工作流:
- 在真实任务中使用技能
- 发现使用难点或效率问题
- 确定需要更新SKILL.md还是捆绑资源
- 实现改动并重新测试