/example-skill

name: example-skill
description: Example skill template used for the CreateHub template. You should never use this skill directly as it is just a template made to be updated.
version: 1.0.0
tags: [skill]

Example Skill Template

Overview

This is a template skill that demonstrates the structure and components of a well-documented skill. Replace this overview with a clear description of what your skill accomplishes and the problem it solves.

Usage

Use this skill when:

• You need to accomplish [specific task or solve specific problem]
• You encounter [common scenario 1]
• You want to [common scenario 2]
• You see errors like "[example error message]"

Instructions

Basic Setup

**Automated Setup:** Use the provided script for streamlined setup:

./scripts/example-script.sh

**Manual Steps:**

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

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

# Step 3: Verify installation
echo "Verifying setup..."

Prerequisites

Replace this section with any pre-skill validation logic you want to perform prior to starting the skill.

Configuration

**For additional information, see `references/additional-info.md`**

Primary Configuration

Replace with your main configuration steps.

Alternative Configuration

Replace with alternative setup methods if applicable.

Features

Once configured, this skill provides:

• **Feature 1**: Description of what it does
• **Feature 2**: Description of what it does
• **Feature 3**: Description of what it does

Troubleshooting

**Automated Diagnostics:** Run the diagnostic script to check for common issues:

./scripts/example-script.sh

**Manual Troubleshooting:**

Common Issue 1

**Check logs:** Replace with appropriate log location

**Common Solutions:**

**"Error message example"**

# Solution command
echo "Fix applied"

**"Another error message"**

• Step 1 to resolve
• Step 2 to resolve

Common Issue 2

**"Example error scenario"**

• Troubleshooting step 1
• Troubleshooting step 2

Supporting Files

scripts/example-script.sh

Example script that demonstrates:

• Basic shell scripting structure
• Error handling
• User feedback
• Simple operations

**Usage:** `./scripts/example-script.sh`

references/additional-info.md

Template reference file containing:

• Detailed background information
• Extended examples and scenarios
• Advanced usage patterns
• Reference tables and appendices

**When to use:** Reference when you need additional context or detailed examples

Deterministic Scripts

example-script.sh

Simple example script demonstrating basic automation patterns.

**When to use:**

• Learning script structure
• Template for new automation scripts
• Testing script execution

**What it does:**

• Prints hello world message
• Demonstrates basic shell scripting
• Shows error handling patterns

**Example:**

./scripts/example-script.sh

Core Concepts

**Concept 1**: Replace with key concept relevant to your skill domain.

**Concept 2**: Replace with another important concept users should understand.

**Concept 3**: Replace with implementation details or architectural concepts.

Quick Reference

| Task | Command | |------|---------| | Run example script | `./scripts/example-script.sh` | | Check configuration | `echo "Add your check command"` | | View documentation | See `references/additional-info.md` |

Common Patterns

**Basic Usage:**

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

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

**Advanced Usage:**

# Check prerequisites
echo "Checking requirements..."

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

Common Mistakes

**Mistake 1**: Description of common mistake users make. **Fix**: How to resolve this mistake.

**Mistake 2**: Another common mistake. **Fix**: Resolution steps for this mistake.

<!-- Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: MIT-0 -->