ARTICLE DETAIL

资讯详情

深耕编程入门与网站建设的一线实战洞察。

Agentic Awesome Skills 技能模板完全指南:从前置元数据到 CI 验证的标准化写作规范

Agentic Awesome Skills 技能模板完全指南:从前置元数据到 CI 验证的标准化写作规范 Agentic Awesome Skills 技能模板完全指南从前置元数据到 CI 验证的标准化写作规范【免费下载链接】agentic-awesome-skillsAAS Core is the local, agent-first control plane for complete catalog discovery, agent-owned selection, stack validation, and planning, backed by 2,115 agentic skills. Includes CLI, local MCP, catalog, plugins, and Workbench.项目地址: https://gitcode.com/gh_mirrors/an/agentic-awesome-skills导读本文面向所有希望向 Agentic Awesome SkillsAAS仓库贡献高质量 Agent 技能的作者系统讲解仓库官方技能模板SKILL_TEMPLATE的完整规范——包括 YAML 前置元数据字段定义、技能分类体系、风险级别划分、Markdown 内容结构、质量检查清单与提交流程。文中不仅完整还原模板指南的全部细则还结合仓库中真实的验证脚本与技能示例说明每条规范在 CI 流水线中如何被强制执行帮助你一次通过npm run validate校验写出能被 Agent、搜索引擎与 LLM 准确解析和检索的标准技能。说明仓库根目录下的docs/SKILL_TEMPLATE.md与docs_zh-CN/SKILL_TEMPLATE.md均为迁移占位页其完整技术内容已迁移至 docs_zh-CN/contributors/skill-template.md英文原版见 docs/contributors/skill-template.md。本文即以该正式模板文档为主体展开。一、模板核心一个技能文件由什么构成每个 Agent 技能在仓库中是一个独立目录目录下唯一必需的文件是SKILL.md。该文件由两大部分组成前置元数据YAML Frontmatter位于文件最顶部、用---包裹声明技能的身份、风险与来源信息是 Agent 与索引系统识别技能的身份证内容正文Markdown 指令前置元数据之后的所有内容是告诉 Agent何时用、怎么用的核心指令。模板文档给出的完整目录结构如下只有SKILL.md是必需的其余全部可选skills/ ├── skill-name/ │ ├── SKILL.md │ ├── examples/ │ │ ├── example1.md │ │ └── example2.md │ └── scripts/ │ └── helper-script.py仓库中的真实技能目录正是按此约定组织的例如 skills/brainstorming/SKILL.md 位于skills/brainstorming/目录下目录名与技能name完全一致。二、前置元数据字段详解模板文档将前置元数据分为必需字段外部来源必需字段可选字段三组并给出了完整示例。以下逐项说明。2.1 必需字段字段说明约束name技能名称小写、连字符分隔必须与目录名完全一致description一句话技能描述200 字符以内需用引号包围category技能分类见下文分类列表risk风险级别none/safe/critical/offensive/unknownsource来源community/official/selfdate_added添加日期YYYY-MM-DD格式模板给出的完整示例--- name: react-patterns description: React组件设计和状态管理的最佳实践 category: development risk: safe source: community date_added: 2024-01-15 author: zhangsan tags: [react, frontend, patterns, components] tools: [claude, cursor, gemini] ---2.2 外部 GitHub 来源必需字段当技能改编自外部 GitHub 仓库、需要 README 外部来源致谢时模板要求声明source_repo上游仓库地址格式为OWNER/REPO如owner/reposource_typeREADME 来源致谢分组取值official/community/self。英文版模板还补充了可选的上游许可证声明字段license与license_source。若技能为仓库原创、无需外部来源致谢则使用source: self与source_type: self。2.3 可选字段author作者名称或 handletags标签列表最多 5 个tools支持的工具列表包括claudeClaude Code、cursorCursor IDE、geminiGemini CLI、codexCodex CLI、antigravityAntigravity IDE、opencodeOpenCode CLI、kiroKiro CLI等。2.4 验证脚本中的字段硬约束以上字段并非仅靠自觉tools/scripts/validate_skills.py 会在npm run validate时逐条强制校验对应代码见 validate_skills.pyname缺失即报错name与目录名不一致报错Name xxx does not match folder name yyydescription缺失报错非字符串报错长度超过300 字符报错Description is oversized模板建议 200 字符以内脚本留有弹性余量但仍要求简洁risk缺失在标准模式下告警、严格模式--strict下升级为错误取值不在{none,safe,critical,offensive,unknown}内直接报错source缺失告警严格模式升级错误source_repo若存在必须匹配OWNER/REPO正则^[A-Za-z0-9_.-]/[A-Za-z0-9_.-]$否则报错source_type若存在必须属于{official,community,self}date_added若存在必须匹配^\d{4}-\d{2}-\d{2}$缺失时给出建议性提示Advisory。三、技能分类列表模板文档给出了完整的分类体系覆盖六大领域共 24 个类别开发类development通用开发、frontend前端开发、backend后端开发、mobile移动开发、testing测试、devopsDevOps架构类architecture系统架构、design设计模式、database数据库设计、apiAPI 设计安全类security安全审计、pen-testing渗透测试、compliance合规检查、cryptography加密AI 类ai人工智能、machine-learning机器学习、prompt-engineering提示工程、data-science数据科学工具类gitGit 操作、productivity生产力、documentation文档编写、deployment部署业务类product产品管理、planning项目规划、communication沟通协作、research研究分析category会进入仓库生成的技能索引skills_index.json/data/catalog.json并成为 Agent 按分类检索技能的关键维度——schemas/skills-index.v1.schema.json 中category被列为索引条目必填字段之一。四、风险级别给每个技能贴上安全标签模板对五级风险给出了精确定义级别含义典型场景unknown未知遗留或未分类内容新技能应尽量避免使用none无风险纯文本或推理指导safe安全代码审查与设计建议、文档编写与规范指导、只读命令或低风险操作流程critical关键系统修改与配置更改、数据处理与转换、自动化脚本执行offensive进攻性Pentesting 或 red-team 技术必须包含 Authorized Use Only 警告风险标签直接驱动安全护栏的强制执行。在验证脚本中validate_skills.py当技能risk为offensive时会强制检查两件事缺一即报致命错误精确的授权声明正文必须包含 **⚠️ AUTHORIZED USE ONLY**开头、说明仅限教育或经授权的安全评估、须获得系统所有者书面许可、滥用属违法行为的固定英文声明块强制逐次确认门Mandatory confirmation gate正文必须在 900 字符内同时出现exact target URL, IP, account, or resource与Wait for explicit confirmation in the current conversation两段表述确保攻击性技能要求 Agent 在执行每个动作前等待用户在会话内的明确确认。即使是非攻击性技能凡涉及 shell 命令、网络抓取、令牌/能力字符串、或直接变更文件系统的指导模板英文版都要求补充Security Safety Notes章节明确运行前提、确认要求与环境预期如local-only、authorized test environment对刻意危险的示例如curl ... | bash需添加可审查的理由与允许列表注释!-- security-allowlist: approved for documented workflow X --。五、标签与工具支持规范标签命名规则小写字母、连字符分隔、避免特殊字符、最多 5 个标签。常用标签分三类技术标签react、python、aws、kubernetes概念标签patterns、security、performance、testing领域标签frontend、backend、mobile、api。工具列表声明该技能适配的 Agent/IDE 客户端模板列出claude、cursor、gemini、codex、antigravity、opencode、kiro等。tools字段会被索引系统用于按工具过滤技能帮助不同客户端的 Agent 只发现可用技能。六、正文内容结构指南模板将正文章节分为必需与可选两类。6.1 必需章节概述Overview24 句话说明技能作用解释为什么需要这个技能——即为什么何时使用When to Use This Skill用具体场景描述使用条件——即何时工作原理How It Works逐步操作说明呈现清晰的执行流程——即如何。何时使用章节对 Agent 的激活决策至关重要。验证脚本专门为此编写了多模式正则validate_skills.py匹配## When to Use、## Use this skill when、## When to Use This Skill、## When to activate this skill等标题变体缺失该章节时标准模式告警、严格模式直接失败。写技能时务必保留能匹配这些正则的章节标题。6.2 可选章节示例Examples给出具体使用示例与可运行代码片段——即什么最佳实践Best Practices推荐用法与应避免的陷阱相关技能Related Skills用related-skill-1形式引用其他技能给出组合建议常见问题FAQ常见问答与故障排查限制和注意事项Limitations技能的能力边界与使用注意。6.3 真实技能对照仓库中的 skills/brainstorming/SKILL.md 即按此结构编写前置元数据声明name: brainstorming、description、risk: critical、source: community、date_added: 2026-02-27正文依次包含# Brainstorming Ideas Into Designs标题、## Purpose概述变体、## When to Use、## Example、## Limitations等章节并落地了决策日志退出标准等强执行约束——是研究模板落地形态的绝佳范本。更多可参考示例包括 skills/git-pushing/SKILL.md简单专注、skills/systematic-debugging/SKILL.md全面、skills/react-best-practices/SKILL.md多文件。七、编写高质量指令的通用技巧模板连同中文版技能解剖指南 docs_zh-CN/contributors/skill-anatomy.md给出了一套对 LLM 友好的写作要领使用清晰直接的语言用在继续之前检查用户是否已通过身份验证而不是您可能想要考虑检查用户是否有身份验证使用动作动词写创建文件…而不是文件应该被创建…具体明确把正确设置数据库拆成可执行步骤创建 PostgreSQL 数据库 → 运行迁移 → 播种初始数据示例先行向 AI 精确展示好的输出长什么样用 AI 测试提交前让 AI 实际运行一遍技能。高级写作模式还包括条件逻辑按用户技术栈分派指令、渐进式披露基础用法 → 高级用法、交叉引用brainstorming→writing-plans→test-driven-development的工作流编排。八、质量检查清单模板为提交前自检提供了三组清单内容质量描述清晰准确示例可运行文档完整语言简洁明了格式规范前置内容完整分类正确标签合适工具支持明确技术质量指导可执行最佳实践遵循安全考虑周全错误处理合理九、提交指南与验证流程文件命名与目录结构使用小写字母和连字符不包含特殊字符目录名与技能名称一致技能文件固定命名为SKILL.md。提交流程模板原文Fork 仓库创建技能目录编写SKILL.md文件添加示例和脚本可选运行验证npm run validate提交 Pull Request。9.1npm run validate到底检查什么在 package.json 中validate脚本定义为validate: node tools/scripts/run-python.js tools/scripts/validate_skills.py, validate:strict: node tools/scripts/run-python.js tools/scripts/validate_skills.py --strict运行后验证脚本会遍历skills/下所有含SKILL.md的目录跳过隐藏目录与符号链接逐项检查前置元数据YAML 可解析性缺失或畸形直接跳过该技能并报错、name/description/risk/source等字段When to Use章节是否存在严格模式为硬失败安全护栏offensive技能必须包含精确授权声明与逐次确认门悬空链接检查validate_skills.py正文中所有 Markdown 相对链接都会解析为技能目录下的真实路径文件不存在即报Dangling link detected——这要求技能内引用的scripts/、examples/、references/等资源必须真实存在。输出按❌致命错误直接失败、⚠️警告标准模式通过但严格模式失败、ℹ️建议三级汇报并统计技能总数。标准模式下有任何致命错误即退出码非 0--strict模式下警告也会导致失败供 CI 使用。除validate外仓库还提供npm run audit:skills、npm run audit:skills:strict调用 audit_skills.py 做深度审计、npm run index重新生成索引等配套命令npm run chain则会串联 validate → plugin-compat → index → bundles → metadata → catalog 的完整发布流水线。十、常见问题与限制Qdescription到底多长合适A模板要求 200 字符以内验证脚本在 300 字符内放行超过即报错。建议一句话讲清技能做什么、何时触发并让关键场景词前置便于 Agent 检索与索引建库。Q我的技能是仓库原创要不要填source_repoA不需要。原创技能使用source: self、source_type: self只有改编自外部 GitHub 仓库时才需声明source_repo: owner/repo与对应的source_type。Q技能目录里能放什么ASKILL.md之外examples/示例、scripts/辅助脚本、templates/代码模板、references/参考文档、README.md附加文档均可选。scripts/与examples/中的资源一旦在正文中被引用必须真实存在否则验证失败。注意事项与边界技能不替代环境特定的验证、测试与专家评审——模板英文版明确要求缺失必需输入、权限或安全边界时停下来询问澄清攻击性技能必须自带授权声明与确认门否则 CI 直接拦截不要为了凑数使用unknown风险级别新技能应明确归类仓库是只读镜像按流程在 Fork 后的副本中创建技能并提交 Pull Request无需也不应直接修改本仓库。结语掌握SKILL_TEMPLATE即掌握了进入 Agentic Awesome Skills 生态的钥匙字段层面的name/description/category/risk/source让技能可被索引与检索章节层面的 Overview / When to Use / How It Works 让 Agent 能准确触发与执行而npm run validate背后的 validate_skills.py 则以代码形式固化了这套规范的质量底线。按模板写作、用验证器自检、参考 skills/brainstorming/SKILL.md 等真实范例你就能与仓库中 2000 技能保持同等的结构一致性与可用性。更多细节可继续阅读 docs_zh-CN/contributors/skill-anatomy.md技能结构解剖与 docs_zh-CN/contributors/quality-bar.md质量标准。【免费下载链接】agentic-awesome-skillsAAS Core is the local, agent-first control plane for complete catalog discovery, agent-owned selection, stack validation, and planning, backed by 2,115 agentic skills. Includes CLI, local MCP, catalog, plugins, and Workbench.项目地址: https://gitcode.com/gh_mirrors/an/agentic-awesome-skills创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表