playbook/outfitter-agents/plugins/outfitter/templates/skills/simple-skill/SKILL.template.md

110 lines
2.0 KiB
Markdown

---
name: [YOUR_SKILL_NAME]
description: [YOUR_DESCRIPTION] - Be specific about WHAT the skill does and WHEN to use it. Include trigger keywords users might mention. Example: "Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction."
version: 1.0.0
---
# [YOUR_SKILL_NAME]
[Brief overview of what this skill does and its purpose]
## Overview
This skill provides [CORE_CAPABILITY]:
- **Feature 1**: [Description]
- **Feature 2**: [Description]
- **Feature 3**: [Description]
## Quick Start
### Basic Usage
```[language]
[CODE_EXAMPLE]
```
### Common Patterns
1. **Pattern 1**: [Description]
```[language]
[CODE_EXAMPLE]
```
2. **Pattern 2**: [Description]
```[language]
[CODE_EXAMPLE]
```
## Instructions
When this skill is activated, follow these steps:
1. **Step 1**: [Clear instruction]
- Detail 1
- Detail 2
2. **Step 2**: [Clear instruction]
- Detail 1
- Detail 2
3. **Step 3**: [Clear instruction]
- Detail 1
- Detail 2
## Best Practices
- **Practice 1**: [Description and reasoning]
- **Practice 2**: [Description and reasoning]
- **Practice 3**: [Description and reasoning]
## Examples
### Example 1: [Use Case Name]
```[language]
[CODE_EXAMPLE_WITH_COMMENTS]
```
### Example 2: [Use Case Name]
```[language]
[CODE_EXAMPLE_WITH_COMMENTS]
```
## Error Handling
Common issues and solutions:
1. **Error Type 1**
- Cause: [Description]
- Solution: [Fix]
2. **Error Type 2**
- Cause: [Description]
- Solution: [Fix]
## Requirements
This skill requires:
- [Dependency 1]: [Version or details]
- [Dependency 2]: [Version or details]
Installation:
```bash
[INSTALLATION_COMMANDS]
```
## Tips
- 💡 **Tip 1**: [Helpful advice]
- 💡 **Tip 2**: [Helpful advice]
- 💡 **Tip 3**: [Helpful advice]
## Related Skills
- **[skill-name]**: [Brief description of relationship]
- **[skill-name]**: [Brief description of relationship]