
WordPress Agent Skills 创作指南如何从零编写一个高质量 SKILL.md【免费下载链接】agent-skillsExpert-level WordPress knowledge for AI coding assistants - blocks, themes, plugins, and best practices项目地址: https://gitcode.com/gh_mirrors/agents/agent-skillsWordPress Agent Skills 是教 AI 编程助手Claude、Copilot、Cursor 等用正确方式开发 WordPress 的可移植技能包。本文是一份从零开始编写高质量 SKILL.md 的完整指南无需编程基础只需清晰描述你的 WordPress 知识 什么是 Agent Skills 和 SKILL.md每个技能Skill都是一个自包含的文件夹AI 助手在执行 WordPress 相关任务时会读取它并按文档中的流程操作而不是靠猜。这正是 README.md 中强调的核心理念skills/wp-block-development/ ├── SKILL.md # 主指令何时使用、流程、验证 ├── references/ # 特定主题的深入文档 └── scripts/ # 确定性辅助脚本检测、校验其中SKILL.md 是技能的大脑包含 YAML 前置元数据和六大核心章节references/存放深度资料scripts/存放确定性检查脚本。想快速上手建议先阅读官方 创作指南 和 设计原则。SKILL.md 的完整结构前置元数据 六大章节打开任意现成技能比如 skills/wp-env/SKILL.md都会看到统一的结构① YAML 前置元数据必填 3 个字段字段要求示例name与目录名完全一致小写字母/数字/连字符≤64 字符wp-envdescription说明何时触发≤1024 字符Use when setting up local WordPress development…compatibility版本契约≤500 字符Targets WordPress 7.0 (PHP 7.4.0).② 六大核心章节缺一不可When to use何时使用——触发条件清单用户说了什么话、项目里存在什么文件Inputs required所需输入——AI 动手前要先收集什么Docker 状态、Node 版本、项目类型……Procedure操作流程——编号的分步检查清单每步给出具体命令Verification验证——可勾选的验证项例如访问 localhost:8888 能看到后台Failure modes / debugging故障模式——常见症状、原因、修复方法对照表Escalation何时求助——超出技能范围、需要人类介入的情形 小技巧description是 AI 判断该不该用这个技能的唯一依据写清触发词用户可能提到的关键词比写功能介绍更重要。一键脚手架30 秒生成合规骨架不用手写模板。仓库提供了 scaffold-skill.mjs 脚手架脚本克隆仓库后执行git clone https://gitcode.com/gh_mirrors/agents/agent-skills cd agent-skills node shared/scripts/scaffold-skill.mjs my-skill Use when 描述触发场景它会自动完成三件事创建skills/my-skill/SKILL.md预填好全部六大章节标题创建eval/scenarios/my-skill.json评估场景占位文件内置名称校验拒绝大写、超长、连续连字符从源头避免格式错误填充六大章节像写检查清单一样写 SKILL.md官方黄金法则只有一条最重要的SKILL.md 保持短小、流程化把深度内容推到references/和脚本中见 CONTRIBUTING.md 的 Keep It Small 章节。写每一章时可以自问章节写作要点When to use用要点列表写触发条件而不是段落叙述Inputs required每项输入附上怎么获取如node -vProcedure编号步骤 具体命令示例保持简短Verification用- [ ]复选框让结果可核对Failure modes表格形式症状 → 原因 → 修复Escalation明确列出哪些情况我不该硬撑以 skills/wp-env/SKILL.md 为例它的 Failure modes 章节就是一张 10 行的症状-原因-修复表AI 遇到 Port 8888 already in use 时能直接定位到--auto-port方案而不是瞎试。深度放 references/确定性放 scripts/docs/principles.md 给出了两条关键设计原则文件引用保持 1 跳references/直接从 SKILL.md 链接避免 A→B→C 的深层嵌套能用脚本就不让 AI 猜凡是需要检测仓库类型、版本、构建系统的地方优先写一个scripts/下的确定性脚本。参考 skills/wp-plugin-development/scripts/detect_plugins.mjs——AI 运行它拿到 JSON 结果比让它目测目录结构可靠得多⚠️ 上游官方文档是权威来源。技能里放面向 AI 的检查清单和决策树深度知识通过链接指向官方文档即可不要复制粘贴大段文档。兼容性契约锁定 WordPress 7.0所有技能必须声明统一的版本目标见 docs/compatibility-policy.mdWordPress 核心7.0PHP7.4.0compatibility:字段必须包含WordPress 7.0和PHP 7.4.0两个字样否则结构校验会直接报错。同时遵循指南优先稳定 API优先检测 护栏而非硬编码假设避免推荐经典主题、Gutenberg 之前的遗留模式。每个技能必须配一个评估场景黄金法则第四条没有评估场景的技能不许入库。在eval/scenarios/下添加一个技能名.json文件包含 5 个字段详见 eval/scenarios/README.md{ name: my-skill, skills: [my-skill], query: 一个真实的用户提问示例, expected_behavior: [AI 应该做什么], success_criteria: [怎样算成功] }脚手架已经帮你生成了占位文件你只需要填入一个真实的提问和预期行为。提交 PR 时请手动运行该场景并把结果写进 PR 说明——仓库目前还没有自动评估运行器。提交前必做运行结构校验提交前的最后一道关卡是 validate-skills.mjsnode shared/scripts/validate-skills.mjs它会自动检查全部技能目录任何一项不合规都会明确报错✅ 每个技能存在SKILL.md且带 YAML 前置元数据✅name与目录名一致、命名合法小写、≤64 字符✅description≤1024 字符compatibility≤500 字符且符合 WP 7.0 / PHP 7.4.0 契约✅ 项目分诊脚本triage detector输出正常看到OK: skill metadata and triage report sanity checks passed.就可以放心提交 PR 了 常见错误清单错误做法正确做法把长文档塞进 SKILL.mdSKILL.md 只留流程深度内容放references/description 只写功能介绍写清触发词和触发场景让 AI 看看目录判断类型写scripts/检测脚本结果确定可复现引用链 SKILL.md → A → B → C保持 1 跳references 直接挂 SKILL.md没有评估场景就提交至少 1 个eval/scenarios/场景 手动验证结果推荐 5.x 旧版 API 写法锁定 WP 7.0 / PHP 7.4.0 现代 API用 AI 辅助起草技能这个项目本身就是AI 辅助创作 确定性护栏的产物见 docs/ai-authorship.md。用 LLM 起草技能时官方推荐的提示模板包含仓库分诊 JSON 输出用户的任务描述版本约束和非目标要求输出SKILL.md 提到的references/*.md 所需的scripts/脚本桩 一个评估场景 JSON然后由人类审阅编辑——这就是AI 打草稿、规范做护栏的高效组合。开始创作完整工作流回顾先路由从 skills/wordpress-router/SKILL.md 入手分类项目、选定领域收输入项目类型、WP/PHP/Node 版本、已有工具链脚手架node shared/scripts/scaffold-skill.mjs 名称 描述写流程填充六大章节短小、可执行、可验证加护栏检测类逻辑写成scripts/脚本加场景补齐eval/scenarios/中的评估 JSON跑校验node shared/scripts/validate-skills.mjs通过后提交 PR 你不需要是编程高手——代码本质上是流程检查清单、决策树和参考文档。只要你能把某个 WordPress 概念讲清楚就能为一个技能做出真实贡献。【免费下载链接】agent-skillsExpert-level WordPress knowledge for AI coding assistants - blocks, themes, plugins, and best practices项目地址: https://gitcode.com/gh_mirrors/agents/agent-skills创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考