⚡

技能文档模板 [TODO:lowercase-hyphen-case-name]

这个技能提供了一个完整的模板，用于创建和文档化Claude技能，帮助用户快速搭建结构化、标准化的技能文档。它包括了YAML元数据定义、快速启动指南、配置示例、常见模式、故障排除等模块，适用于技能开发、文档编写和团队协作场景。关键词：技能模板，文档创建，Claude技能，开发指南，YAML配置，SEO优化。

其他 0 次安装 0 次浏览 更新于 3/7/2026

名称: [TODO: lowercase-hyphen-case-name] 描述: | [TODO: 用第三人称写全面描述。以“这个技能提供…”或“这个技能应该在…时使用”开头]

[TODO: 添加“使用场景” - Claude应该使用这个技能的具体情况]

[TODO: 添加关键词 - 技术、用例、应该触发这个技能的错误消息] 许可证: MIT

[TODO: 技能显示名称]

状态: [TODO: 生产就绪 / Beta / 实验性] 最后更新: [TODO: YYYY-MM-DD] 依赖项: [TODO: 列出先决技能或工具，或写“无”] 最新版本: [TODO: package@version, package2@version]

快速开始 ([TODO: X] 分钟)

1. [TODO: 第一个主要步骤]

[TODO: 提供清晰、可操作的指令]

# [TODO: 示例命令]

为什么这很重要:

  • [TODO: 解释原因]
  • [TODO: 关键好处]

2. [TODO: 第二个主要步骤]

[TODO: 继续逐步指令]

// [TODO: 代码示例带注释]

关键:

  • [TODO: 防止常见错误的重要注意事项]

3. [TODO: 第三个主要步骤]

[TODO: 继续直到设置完成]

[TODO: 数字]步设置流程

步骤 1: [TODO: 第一步名称]

[TODO: 详细指令]

[TODO: 代码示例、配置等]

关键点:

  • [TODO: 重要细节]
  • [TODO: 要避免什么]

步骤 2: [TODO: 第二步名称]

[TODO: 继续详细步骤]

关键规则

总是做

✅ [TODO: 最佳实践 #1] ✅ [TODO: 最佳实践 #2] ✅ [TODO: 最佳实践 #3]

从不做

❌ [TODO: 反模式 #1] ❌ [TODO: 反模式 #2] ❌ [TODO: 反模式 #3]

已知问题预防

这个技能防止 [TODO: 数字] 个文档化问题:

问题 #1: [TODO: 问题名称]

错误: [TODO: 确切错误消息或描述] 来源: [TODO: GitHub 问题链接、Stack Overflow 链接或官方文档] 为什么发生: [TODO: 根本原因] 预防: [TODO: 这个技能如何修复它]

问题 #2: [TODO: 问题名称]

[TODO: 为每个问题重复模式]

配置文件参考

[TODO: config-file.ext] (完整示例)

[TODO: 完整、可工作的配置文件]

为什么这些设置:

  • [TODO: 解释关键配置决策]

常见模式

模式 1: [TODO: 模式名称]

// [TODO: 代码示例]

何时使用: [TODO: 具体场景]

模式 2: [TODO: 模式名称]

[TODO: 更多示例]

使用捆绑资源

[TODO: 只有在有scripts/、references/或assets/时才包括此部分]

脚本 (scripts/)

[TODO: 列出并解释任何可执行脚本]

示例用法:

./scripts/[TODO: script-name].sh

参考 (references/)

[TODO: 列出Claude在需要时可以加载的文档文件]

  • references/[TODO: filename].md - [TODO: 包含什么]

当Claude应该加载这些时: [TODO: 具体场景]

资产 (assets/)

[TODO: 列出在输出中使用的模板文件、图像等]

  • assets/[TODO: filename] - [TODO: 用途]

高级主题

[TODO: 高级主题 1]

[TODO: 深入复杂场景]

[TODO: 高级主题 2]

[TODO: 附加高级内容]

依赖项

必需:

  • [TODO: package@version] - [TODO: 用途]
  • [TODO: package@version] - [TODO: 用途]

可选:

  • [TODO: package@version] - [TODO: 用途]

官方文档

  • [TODO: 技术名称]: [TODO: 官方文档URL]
  • [TODO: 相关工具]: [TODO: 官方文档URL]
  • Context7 库 ID: [TODO: /org/project 如果适用]

包版本 (验证于 [TODO: YYYY-MM-DD])

{
  "dependencies": {
    "[TODO: package]": "^[TODO: version]"
  },
  "devDependencies": {
    "[TODO: package]": "^[TODO: version]"
  }
}

生产示例

[TODO: 可选 - 提供生产使用证据]

这个技能基于 [TODO: 项目名称]:

  • 在线: [TODO: URL 如果适用]
  • 构建时间: [TODO: 时间]
  • 错误: 0 (所有 [TODO: 数字] 个已知问题已预防)
  • 验证: ✅ [TODO: 测试了什么]

故障排除

问题: [TODO: 常见问题]

解决方案: [TODO: 如何修复]

问题: [TODO: 另一个问题]

解决方案: [TODO: 如何修复]

完整设置检查清单

使用此检查清单验证您的设置:

  • [ ] [TODO: 第一个验证步骤]
  • [ ] [TODO: 第二个验证步骤]
  • [ ] [TODO: 第三个验证步骤]
  • [ ] [TODO: 所有包版本正确]
  • [ ] [TODO: 开发服务器运行无错误]
  • [ ] [TODO: 生产构建成功]
  • [ ] [TODO: 部署成功 (如果适用)]

有问题？有疑问？

  1. 检查 [TODO: reference/common-issues.md] 如果您创建了一个
  2. 验证设置流程中的所有步骤
  3. 检查官方文档: [TODO: URL]
  4. 确保 [TODO: 关键要求] 已配置

使用此模板的说明

  1. 搜索 [TODO:** - 替换每个 [TODO: …] 为实际内容
  2. 删除此部分 当完成时
  3. 移除部分 如果不适用于您的技能
  4. 添加部分 根据您的具体用例需要
  5. 测试一切 在提交前
  6. 验证对比 ONE_PAGE_CHECKLIST.md

关键提醒:

  • 在描述中使用第三人称: “这个技能提供…” 而不是 “这个技能帮助您…”
  • 以命令形式写: “要做X，运行Y” 而不是 “您应该运行Y来做X”
  • 包括实际错误消息和GitHub问题链接
  • 用验证日期记录所有包版本
  • 测试所有代码示例
  • 在提交前移除所有 [TODO:] 标记

良好描述示例:

description: |
  This skill provides comprehensive knowledge for building React applications with
  Vite and TypeScript. It should be used when scaffolding new Vite projects,
  configuring TypeScript settings, or encountering HMR issues.

  Keywords: vite, react, typescript, hmr, vite config, react setup

不良描述示例:

description: "A skill for Vite and React"  # ❌ 太模糊，无关键词

准备构建？ 填写所有 [TODO:] 标记并创建一个惊人的技能！