mcpField
E
example-skill

example-skill

github.com/aws-samplesAgent 工作流27673 次安装5 周前更新
代码仓库

关于 example-skill

一个用于展示技能文档结构的示例模板,面向学习技能编写或制作自动化脚本模板的人。内容包含设置、配置、诊断、参考资料和示例脚本等占位说明。

主要功能

  1. 01技能文档结构示例
  2. 02自动与手动设置步骤
  3. 03配置和故障排查章节
  4. 04脚本与参考文件说明

适用场景

  1. 01学习技能文档的组织方式
  2. 02制作自动化脚本模板

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/aws-samples/sample-well-architected-skills-and-steering --skill example-skill

安装后在 Claude Code 中输入/example-skill确认已加载。

附带文件references/additional-info.mdscripts/example-script.sh

详细介绍

示例 Skill 模板

概述

这是一个模板 Skill,用于展示文档完善的 Skill 的结构和组成部分。请将此概述替换为清晰的描述,说明你的 Skill 能实现什么,以及它解决什么问题。

用法

在以下情况下使用此 Skill:

  • 你需要完成[特定任务或解决特定问题]
  • 你遇到[常见场景 1]
  • 你想要[常见场景 2]
  • 你看到类似“[示例错误消息]”的错误

说明

基本设置

自动设置: 使用提供的脚本简化设置流程:

./scripts/example-script.sh

手动步骤:

# Step 1: Install required tools
echo "Installing dependencies..."

# Step 2: Configure settings
echo "Configuring application..."

# Step 3: Verify installation
echo "Verifying setup..."
前提条件

将此部分替换为你希望在启动 Skill 前执行的任何验证逻辑。

配置

如需更多信息,请参阅 references/additional-info.md

主要配置

替换为你的主要配置步骤。

替代配置

如果适用,请替换为其他设置方法。

功能

配置完成后,此 Skill 将提供:

  • 功能 1:描述其作用
  • 功能 2:描述其作用
  • 功能 3:描述其作用

故障排除

自动诊断: 运行诊断脚本,检查常见问题:

./scripts/example-script.sh

手动排查:

常见问题 1

**检查日志:**替换为适当的日志位置

常见解决方案:

“错误消息示例”

# Solution command
echo "Fix applied"

“另一条错误消息”

  • 解决步骤 1
  • 解决步骤 2
常见问题 2

“示例错误场景”

  • 故障排除步骤 1
  • 故障排除步骤 2

支持文件

scripts/example-script.sh

用于演示以下内容的示例脚本:

  • 基本 Shell 脚本结构
  • 错误处理
  • 用户反馈
  • 简单操作

用法: ./scripts/example-script.sh

references/additional-info.md

模板参考文件,包含:

  • 详细的背景信息
  • 扩展示例和场景
  • 高级用法模式
  • 参考表格和附录

**使用时机:**需要补充背景信息或详细示例时,请参阅此文件

确定性脚本

example-script.sh

用于演示基本自动化模式的简单示例脚本。

使用时机:

  • 学习脚本结构
  • 作为新自动化脚本的模板
  • 测试脚本执行

作用:

  • 输出 Hello World 消息
  • 演示基本 Shell 脚本编写
  • 展示错误处理模式

示例:

./scripts/example-script.sh

核心概念

概念 1:替换为与你的 Skill 领域相关的关键概念。

概念 2:替换为用户应了解的另一项重要概念。

概念 3:替换为实现细节或架构概念。

快速参考

任务命令
运行示例脚本./scripts/example-script.sh
检查配置echo "Add your check command"
查看文档查看 references/additional-info.md

常见模式

基本用法:

# Use example script
./scripts/example-script.sh

# Follow up with manual steps if needed
echo "Manual configuration step"

高级用法:

# Check prerequisites
echo "Checking requirements..."

# Run advanced configuration
echo "Advanced setup..."

常见错误

错误 1:描述用户常犯的错误。 修复方法:说明如何解决此错误。

错误 2:另一种常见错误。 修复方法:此错误的解决步骤。

评论

支持 Markdown