brainstorming
brainstorming
You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).
skill-creator-zh创建、编辑、改进或审计 AgentSkills。用于从头创建新技能,或被要求改进、审查、审计、整理或清理现有技能或 SKILL.md 文件。也用于编辑或重构技能目录(将文件移动到 references/ 或 scripts/,删除过时内容,根据 AgentSkills 规范进行验证)。触发短语包括"创建技能"、"编写技能"、"整理技能"、"改进技能"、"审查技能"、"清理技能"、"审计技能"。
Independent GitHub snapshot · Automated classification · Original documentation governs
本技能提供创建有效技能的指导。
技能是模块化、自包含的包,通过提供专业知识、工作流程和工具来扩展 Codex 的能力。可以将它们视为特定领域或任务的"入职指南"——它们将 Codex 从通用代理转变为具备程序性知识的专业代理,这些知识是任何模型都无法完全拥有的。
上下文窗口是公共资源。技能与 Codex 需要的其他所有内容共享上下文窗口:系统提示、对话历史、其他技能的元数据以及实际的用户请求。
默认假设:Codex 已经非常聪明。 只添加 Codex 还不知道的上下文。挑战每一条信息:"Codex 真的需要这个解释吗?"和"这一段是否值得它的 token 成本?"
优先使用简洁的示例而非冗长的解释。
根据任务的脆弱性和可变性匹配具体程度:
高自由度(基于文本的指令):当多种方法都有效、决策取决于上下文或启发式方法指导方法时使用。
中等自由度(伪代码或带参数的脚本):当存在首选模式、一些变化是可接受的或配置影响行为时使用。
低自由度(特定脚本,少量参数):当操作脆弱且容易出错、一致性至关重要或必须遵循特定顺序时使用。
将 Codex 想象为探索路径:悬崖间的窄桥需要特定的护栏(低自由度),而开阔的田野允许多条路线(高自由度)。
每个技能由必需的 SKILL.md 文件和可选的捆绑资源组成:
skill-name/
├── SKILL.md(必需)
│ ├── YAML frontmatter 元数据(必需)
│ │ ├── name:(必需)
│ │ └── description:(必需)
│ └── Markdown 指令(必需)
└── 捆绑资源(可选)
├── scripts/ - 可执行代码(Python/Bash 等)
├── references/ - 预期按需加载到上下文中的文档
└── assets/ - 输出中使用的文件(模板、图标、字体等)
每个 SKILL.md 由以下组成:
name 和 description 字段。这是 Codex 用来确定何时使用技能的唯一字段,因此在描述技能是什么以及何时应该使用时,清晰和全面非常重要。scripts/)需要确定性可靠性或被重复重写的任务的可执行代码(Python/Bash 等)。
scripts/rotate_pdf.pyreferences/)预期按需加载到上下文中以指导 Codex 流程和思考的文档和参考材料。
references/finance.md,用于公司 NDA 模板的 references/mnda.md,用于公司政策的 references/policies.md,用于 API 规范的 references/api_docs.mdassets/)不打算加载到上下文中,而是在 Codex 产生的输出中使用的文件。
assets/logo.png,用于 PowerPoint 模板的 assets/slides.pptx,用于 HTML/React 样板的 assets/frontend-template/,用于排版的 assets/font.ttf技能应该只包含直接支持其功能的必要文件。不要创建额外的文档或辅助文件,包括:
技能应该只包含 AI 代理完成手头工作所需的信息。它不应该包含关于创建过程、设置和测试程序、面向用户的文档等辅助上下文。创建额外的文档文件只会增加混乱和困惑。
技能使用三级加载系统来高效管理上下文:
将 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。
重要指南:
技能创建涉及以下步骤:
按顺序遵循这些步骤,只有在有明确理由说明它们不适用时才跳过。
plan-mode)。gh-address-comments、linear-address-issue)。只有当技能的使用模式已经清楚理解时才跳过此步骤。即使在使用现有技能时,它仍然有价值。
要创建有效的技能,需要清楚地了解技能将如何使用的具体示例。这种理解可以来自直接的用户示例或经过用户反馈验证的生成示例。
例如,在构建图像编辑器技能时,相关问题包括:
为避免让用户不知所措,避免在一条消息中问太多问题。从最重要的问题开始,根据需要跟进以提高效果。
当清楚了解技能应该支持的功能时,结束此步骤。
要将具体示例转化为有效的技能,通过以下方式分析每个示例:
示例:当构建 pdf-editor 技能来处理像"帮我旋转这个 PDF"这样的查询时,分析显示:
scripts/rotate_pdf.py 脚本会有帮助示例:当设计 frontend-webapp-builder 技能用于像"给我构建一个待办事项应用"或"给我构建一个跟踪步数的仪表板"这样的查询时,分析显示:
assets/hello-world/ 模板会有帮助示例:当构建 big-query 技能来处理像"今天有多少用户登录了?"这样的查询时,分析显示:
references/schema.md 文件会有帮助要确定技能的内容,分析每个具体示例以创建要包含的可复用资源列表:脚本、参考和资产。
此时,是时候实际创建技能了。
只有当正在开发的技能已经存在,并且需要迭代或打包时才跳过此步骤。在这种情况下,继续下一步。
当从头创建新技能时,始终运行 init_skill.py 脚本。该脚本方便地生成一个新的模板技能目录,自动包含技能所需的一切,使技能创建过程更加高效和可靠。
用法:
scripts/init_skill.py <技能名称> --path <输出目录> [--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
脚本会:
--resources 可选创建资源目录--examples 时可选添加示例文件初始化后,根据需要自定义 SKILL.md 并添加资源。如果使用了 --examples,请替换或删除占位符文件。
在编辑(新生成或现有)技能时,请记住技能是为另一个 Codex 实例使用而创建的。包含对 Codex 有益且不明显的信息。考虑哪些程序性知识、领域特定细节或可复用资产可以帮助另一个 Codex 实例更有效地执行这些任务。
根据技能需求查阅这些有用的指南:
这些文件包含有效技能设计的既定最佳实践。
要开始实现,从上面识别的可复用资源开始:scripts/、references/ 和 assets/ 文件。注意,此步骤可能需要用户输入。例如,在实现 brand-guidelines 技能时,用户可能需要提供要存储在 assets/ 中的品牌资产或模板,或要存储在 references/ 中的文档。
添加的脚本必须通过实际运行来测试,以确保没有错误且输出符合预期。如果有许多类似的脚本,只需要测试代表性样本以确保对所有脚本的信心,同时平衡完成时间。
如果使用了 --examples,请删除技能不需要的任何占位符文件。只创建实际需要的资源目录。
写作指南: 始终使用祈使/不定式形式。
使用 name 和 description 编写 YAML frontmatter:
name:技能名称description:这是技能的主要触发机制,帮助 Codex 了解何时使用技能。
docx 技能的示例描述:"全面的文档创建、编辑和分析,支持跟踪更改、评论、格式保留和文本提取。当 Codex 需要处理专业文档(.docx 文件)时使用:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理跟踪更改,(4) 添加评论,或任何其他文档任务"不要在 YAML frontmatter 中包含任何其他字段。
编写使用技能及其捆绑资源的指令。
技能开发完成后,必须将其打包成可分发的 .skill 文件,与用户共享。打包过程首先自动验证技能以确保其满足所有要求:
scripts/package_skill.py <技能文件夹路径>
可选指定输出目录:
scripts/package_skill.py <技能文件夹路径> ./dist
打包脚本将:
验证 技能自动,检查:
打包 技能(如果验证通过),创建以技能命名的 .skill 文件(例如,my-skill.skill),包含所有文件并保持适当的目录结构以供分发。.skill 文件是带有 .skill 扩展名的 zip 文件。
安全限制:拒绝符号链接,当存在任何符号链接时打包失败。
如果验证失败,脚本将报告错误并退出而不创建包。修复任何验证错误并再次运行打包命令。
测试技能后,用户可能会要求改进。这通常发生在使用技能后不久,此时对技能表现的上下文还很新鲜。
迭代工作流程: