About

Imported from aws-samples/sample-well-architected-skills-and-steering (skills/example-skill/SKILL.md). Install upstream with npx skills add aws-samples/sample-well-architected-skills-and-steering --skill example-skill. Copyright stays with the author.

Example Skill Template

Name: example-skill
Author: aws-samples

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.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/aws-samples-sample-well-architected-skills-and-steering-0da4d2/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

aws-samples-sample-well-architected-skills-and-steering-0da4d2.ocm.jsonjson

{
  "ocm": "1",
  "id": "aws-samples-sample-well-architected-skills-and-steering-0da4d2",
  "kind": "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.",
  "publisher": "aws-samples",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "skill",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "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."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/aws-samples/sample-well-architected-skills-and-steering",
      "path": "skills/example-skill/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/aws-samples/sample-well-architected-skills-and-steering/blob/HEAD/skills/example-skill/SKILL.md",
      "key": "aws-samples/sample-well-architected-skills-and-steering/skills/example-skill/SKILL.md"
    }
  },
  "instructions": "# Example Skill Template\n\n## Overview\n\nThis 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.\n\n## Usage\n\nUse this skill when:\n- You need to accomplish [specific task or solve specific problem]\n- You encounter [common scenario 1]\n- You want to [common scenario 2]\n- You see errors like \"[example error message]\"\n\n## Instructions\n\n### Basic Setup\n\n**Automated Setup:**\nUse the provided script for streamlined setup:\n```bash\n./scripts/example-script.sh",
  "cost": {
    "context_tokens": 974
  }
}

Fetch it by URL: GET /api/v1/registry/aws-samples-sample-well-architected-skills-and-steering-0da4d2/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.