Codex 技能文档编写|让名称、目录和触发条件匹配
EnglishCodex 安装步骤
- 打开 GitHub 固定提交的 `.agents/skills/writing-skills/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.agents/skills/writing-skills/`,把核对后的文件保存为 `.agents/skills/writing-skills/SKILL.md`。
- 在该项目根目录启动 Codex,输入 `$writing-skills` 并选择同名技能。
中文摘要
按维护者的约定写简短的技能文档,让目录和名称一致,并用具体场景说明何时触发、能完成什么。
SKILL.md 中文导读
可复现示例
检查这个模拟技能的描述和名称。
{"folder":"csv-column-check","draftName":"csv-check","trigger":"validating CSV headers","behavior":"reports missing columns"}工作步骤
- 核对目录名与技能 name。
- 用第三人称把场景和动作写进短描述。
- 把正文分成便于扫读的步骤,核对示例与实际用途。
验收方法
使名称为 `csv-column-check`。英文描述可写 `Use when validating CSV headers - reports missing columns`。
GitHub 原文 · 更新日期
适用环境
在 Codex 中打开采用仓库级技能目录的项目,准备技能目录名、实际触发条件和所需交付物。
常见问题
正文要把所有项目资料都贴进去吗?
正文只保留该任务需要的约束与说明。需要附加文件时,可从技能正文引用。