csh
/
playbook
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
playbook/outfitter-agents/plugins/outfitter/templates/skills/multi-file-skill/SKILL.template.md

2.6 KiB
Raw Blame History

name: [YOUR_SKILL_NAME] description: [YOUR_DESCRIPTION] - Be specific about WHAT the skill does and WHEN to use it. Include trigger keywords. Example: "Test REST APIs with validation and reporting. Use when testing APIs, endpoints, HTTP services, or when users mention API testing, endpoint validation, or integration testing." allowed-tools: Read, Grep, Glob, Bash version: 1.0.0

[YOUR_SKILL_NAME]

[Brief overview - 1-2 sentences]

Overview

This skill provides comprehensive [CAPABILITY]:

  • Feature 1: [Description]
  • Feature 2: [Description]
  • Feature 3: [Description]

Quick Start

Basic Example

[SIMPLE_EXAMPLE]

Key Concepts

  1. Concept 1: [Explanation]
  2. Concept 2: [Explanation]
  3. Concept 3: [Explanation]

Core Workflows

Workflow 1: [Name]

  1. [Step 1 description]
  2. [Step 2 description]
  3. [Step 3 description]
[EXAMPLE_CODE]

Workflow 2: [Name]

  1. [Step 1 description]
  2. [Step 2 description]
  3. [Step 3 description]
[EXAMPLE_CODE]

Advanced Usage

For advanced patterns and detailed API reference, see:

Tool Restrictions

This skill restricts tool usage to: Read, Grep, Glob, Bash

Why these restrictions?

  • Read/Grep/Glob: [Explanation]
  • Bash: [Explanation]
  • No Write/Edit: [Explanation]

Best Practices

  1. Practice 1

    • What: [Description]
    • Why: [Reasoning]
    • How: [Implementation tip]

  2. Practice 2

    • What: [Description]
    • Why: [Reasoning]
    • How: [Implementation tip]

Common Patterns

Pattern 1: [Name]

[CODE_EXAMPLE]

Use when: [Scenario description]

Pattern 2: [Name]

[CODE_EXAMPLE]

Use when: [Scenario description]

Troubleshooting

Issue Cause Solution
[Problem 1] [Cause] [Fix]
[Problem 2] [Cause] [Fix]
[Problem 3] [Cause] [Fix]

Requirements

Dependencies:

Installation:

[INSTALL_COMMANDS]

Environment:

Progressive Disclosure

This SKILL.md provides the essentials. For deeper information:

📚 REFERENCE.md

  • Complete API documentation
  • Configuration options
  • Advanced patterns
  • Performance tuning

📚 EXAMPLES.md

  • Real-world use cases
  • Integration examples
  • Best practice implementations
  • Common scenarios

Version History

  • 1.0.0: Initial release
    • [Feature 1]
    • [Feature 2]
    • [Feature 3]