name: 示例技能 description: 该技能应在演示技能结构和格式时使用。提供创建新技能的示例模式。 author: Joseph OBrien status: 未发布 updated: ‘2025-12-23’ version: 1.0.1 tag: skill type: skill
示例技能
一个展示Claude Code技能正确结构和格式的演示技能。
何时使用此技能
- 创建新技能时需要参考
- 理解技能结构和最佳实践
- 学习如何将资源与技能捆绑
此技能的功能
- 演示正确的YAML前置元数据格式
- 展示内容结构要求
- 提供捆绑资源的示例
- 说明技能文档的最佳实践
核心原则
原则1:明确目的
技能应有清晰、定义明确的目的。“何时使用”部分应明确说明何时应用该技能。
原则2:渐进式披露
从高层次概述到详细实施来组织内容。在深入工作流程之前,先从“何时使用”和“此技能的功能”开始。
原则3:可操作的工作流程
提供可直接遵循的逐步工作流程。包括示例和反模式。
工作流程
步骤1:识别需求
确定此技能是否适合当前任务。
步骤2:查阅文档
阅读技能文档以了解功能和限制。
步骤3:应用技能
按照工作流程步骤应用技能。
步骤4:验证结果
检查技能是否达到了预期结果。
最佳实践
- 保持技能专注于单一领域或功能
- 包含清晰的示例和用例
- 记录反模式以避免常见错误
- 当资源增加价值时进行捆绑
反模式
- 创建过于宽泛、试图包揽一切的技能
- 跳过“何时使用”部分
- 缺少示例或用例
- 未记录捆绑资源
示例
示例1:基本用法
场景: 为代码审查创建新技能
方法:
- 查看此示例技能结构
- 使用
steve/templates/AGENT_SKILL.template.md中的模板 - 填写特定领域内容
- 根据需要添加捆绑资源
参考文件
此技能在references/中包含参考文件:
structure-guide.md:详细的结构指南examples.md:其他示例