730 lines
12 KiB
Markdown
730 lines
12 KiB
Markdown
# Skill Templates
|
|
|
|
Ready-to-use templates for common skill types. Copy and customize for your needs.
|
|
|
|
## Template 1: Code Framework Skill
|
|
|
|
```markdown
|
|
---
|
|
name: [Framework Name] Development
|
|
description: Build [type of applications] using [framework] following [key principles/patterns]. Use when creating [specific project types] with [key requirements].
|
|
---
|
|
|
|
## When to Use This Skill
|
|
|
|
Use this skill when:
|
|
- Building [specific type] applications with [framework]
|
|
- Implementing [key feature] using [framework] patterns
|
|
- Setting up [framework] projects with best practices
|
|
|
|
Do NOT use this skill for:
|
|
- [Related but different framework]
|
|
- [Different type of application]
|
|
|
|
## Prerequisites
|
|
|
|
- [Framework] version X.X or higher
|
|
- [Required dependencies]
|
|
- Basic understanding of [concepts]
|
|
|
|
## Quick Start
|
|
|
|
Create a new project:
|
|
|
|
\```bash
|
|
[command to create project]
|
|
\```
|
|
|
|
Basic structure:
|
|
|
|
\```[language]
|
|
[Minimal working example]
|
|
\```
|
|
|
|
Run the application:
|
|
|
|
\```bash
|
|
[command to run]
|
|
\```
|
|
|
|
## Project Structure
|
|
|
|
\```
|
|
project-name/
|
|
├── src/
|
|
│ ├── [key directory 1]/
|
|
│ ├── [key directory 2]/
|
|
│ └── [key file]
|
|
├── tests/
|
|
├── [config file]
|
|
└── README.md
|
|
\```
|
|
|
|
## Core Patterns
|
|
|
|
### Pattern 1: [Name]
|
|
|
|
**When to use:** [Scenario]
|
|
|
|
**Implementation:**
|
|
|
|
\```[language]
|
|
[Code example]
|
|
\```
|
|
|
|
**Key points:**
|
|
- [Important detail]
|
|
- [Important detail]
|
|
|
|
### Pattern 2: [Name]
|
|
|
|
**When to use:** [Scenario]
|
|
|
|
**Implementation:**
|
|
|
|
\```[language]
|
|
[Code example]
|
|
\```
|
|
|
|
## Common Tasks
|
|
|
|
### Task 1: [Name]
|
|
|
|
1. [Step]
|
|
2. [Step]
|
|
3. [Step]
|
|
|
|
**Example:**
|
|
\```[language]
|
|
[Code]
|
|
\```
|
|
|
|
### Task 2: [Name]
|
|
|
|
1. [Step]
|
|
2. [Step]
|
|
3. [Step]
|
|
|
|
**Example:**
|
|
\```[language]
|
|
[Code]
|
|
\```
|
|
|
|
## Configuration
|
|
|
|
### [Config File Name]
|
|
|
|
\```[format]
|
|
[Example configuration]
|
|
\```
|
|
|
|
**Options:**
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| [name] | [type] | [default] | [description] |
|
|
|
|
## Testing
|
|
|
|
### Unit Tests
|
|
|
|
\```[language]
|
|
[Test example]
|
|
\```
|
|
|
|
### Integration Tests
|
|
|
|
\```[language]
|
|
[Test example]
|
|
\```
|
|
|
|
## Common Pitfalls
|
|
|
|
### Issue: [Problem]
|
|
**Solution:** [How to fix/avoid]
|
|
|
|
### Issue: [Problem]
|
|
**Solution:** [How to fix/avoid]
|
|
|
|
## Advanced Topics
|
|
|
|
### [Topic 1]
|
|
[Brief explanation and example]
|
|
|
|
### [Topic 2]
|
|
[Brief explanation and example]
|
|
|
|
## Resources
|
|
|
|
- Official Documentation: [link]
|
|
- Best Practices Guide: [link]
|
|
- Community Examples: [link]
|
|
```
|
|
|
|
---
|
|
|
|
## Template 2: Workflow/Process Skill
|
|
|
|
```markdown
|
|
---
|
|
name: [Process Name]
|
|
description: [Action verb] for [domain/purpose] following [methodology/standard]. Use when [primary scenario] and [key differentiator].
|
|
---
|
|
|
|
## When to Use This Skill
|
|
|
|
Use this skill when:
|
|
- [Primary use case]
|
|
- [Secondary use case]
|
|
- [Edge case to include]
|
|
|
|
Do NOT use this skill for:
|
|
- [Common confusion case]
|
|
- [Related but different process]
|
|
|
|
## Overview
|
|
|
|
[Brief explanation of what this process achieves and why it matters]
|
|
|
|
## Prerequisites
|
|
|
|
Before starting, ensure you have:
|
|
- [ ] [Requirement 1]
|
|
- [ ] [Requirement 2]
|
|
- [ ] [Requirement 3]
|
|
|
|
## Process Steps
|
|
|
|
### Phase 1: [Name]
|
|
|
|
**Goal:** [What this phase accomplishes]
|
|
|
|
**Steps:**
|
|
|
|
1. **[Step name]**
|
|
- [Detailed action]
|
|
- [Why this matters]
|
|
- **Output:** [What you should have after this step]
|
|
|
|
2. **[Step name]**
|
|
- [Detailed action]
|
|
- [Why this matters]
|
|
- **Output:** [What you should have after this step]
|
|
|
|
**Checkpoint:** [How to verify this phase is complete]
|
|
|
|
### Phase 2: [Name]
|
|
|
|
**Goal:** [What this phase accomplishes]
|
|
|
|
**Steps:**
|
|
|
|
1. **[Step name]**
|
|
- [Detailed action]
|
|
- [Why this matters]
|
|
- **Output:** [What you should have after this step]
|
|
|
|
2. **[Step name]**
|
|
- [Detailed action]
|
|
- [Why this matters]
|
|
- **Output:** [What you should have after this step]
|
|
|
|
**Checkpoint:** [How to verify this phase is complete]
|
|
|
|
### Phase 3: [Name]
|
|
|
|
**Goal:** [What this phase accomplishes]
|
|
|
|
**Steps:**
|
|
|
|
1. **[Step name]**
|
|
- [Detailed action]
|
|
- [Why this matters]
|
|
- **Output:** [What you should have after this step]
|
|
|
|
**Checkpoint:** [How to verify this phase is complete]
|
|
|
|
## Decision Points
|
|
|
|
### Decision 1: [Name]
|
|
|
|
**When:** [At what point in the process]
|
|
|
|
**Question:** [What you need to decide]
|
|
|
|
**Options:**
|
|
- **Option A:** [Description] → Proceed to [next step/phase]
|
|
- **Option B:** [Description] → Proceed to [next step/phase]
|
|
|
|
### Decision 2: [Name]
|
|
|
|
**When:** [At what point in the process]
|
|
|
|
**Question:** [What you need to decide]
|
|
|
|
**Options:**
|
|
- **Option A:** [Description] → Proceed to [next step/phase]
|
|
- **Option B:** [Description] → Proceed to [next step/phase]
|
|
|
|
## Quality Checklist
|
|
|
|
Before considering the process complete, verify:
|
|
|
|
- [ ] [Quality criterion 1]
|
|
- [ ] [Quality criterion 2]
|
|
- [ ] [Quality criterion 3]
|
|
- [ ] [Quality criterion 4]
|
|
|
|
## Common Scenarios
|
|
|
|
### Scenario 1: [Name]
|
|
|
|
**Situation:** [When this applies]
|
|
|
|
**Approach:**
|
|
1. [Specific step for this scenario]
|
|
2. [Specific step for this scenario]
|
|
|
|
### Scenario 2: [Name]
|
|
|
|
**Situation:** [When this applies]
|
|
|
|
**Approach:**
|
|
1. [Specific step for this scenario]
|
|
2. [Specific step for this scenario]
|
|
|
|
## Troubleshooting
|
|
|
|
### Problem: [Issue]
|
|
**Symptoms:** [How you know this is happening]
|
|
**Solution:** [Steps to resolve]
|
|
|
|
### Problem: [Issue]
|
|
**Symptoms:** [How you know this is happening]
|
|
**Solution:** [Steps to resolve]
|
|
|
|
## Examples
|
|
|
|
### Example 1: [Scenario Name]
|
|
|
|
**Context:** [Background and requirements]
|
|
|
|
**Process:**
|
|
|
|
1. [What was done in Phase 1]
|
|
2. [What was done in Phase 2]
|
|
3. [What was done in Phase 3]
|
|
|
|
**Outcome:** [What was achieved]
|
|
|
|
**Lessons learned:** [Key insights]
|
|
|
|
### Example 2: [Scenario Name]
|
|
|
|
**Context:** [Background and requirements]
|
|
|
|
**Process:**
|
|
|
|
1. [What was done in Phase 1]
|
|
2. [What was done in Phase 2]
|
|
3. [What was done in Phase 3]
|
|
|
|
**Outcome:** [What was achieved]
|
|
|
|
**Lessons learned:** [Key insights]
|
|
|
|
## Templates and Tools
|
|
|
|
### Template 1: [Name]
|
|
|
|
\```
|
|
[Template content]
|
|
\```
|
|
|
|
### Template 2: [Name]
|
|
|
|
\```
|
|
[Template content]
|
|
\```
|
|
|
|
## References
|
|
|
|
- [Resource 1]
|
|
- [Resource 2]
|
|
- [Resource 3]
|
|
```
|
|
|
|
---
|
|
|
|
## Template 3: Reference/Lookup Skill
|
|
|
|
```markdown
|
|
---
|
|
name: [Topic] Reference
|
|
description: Quick reference for [specific domain/tool/technology] covering [key aspects]. Use when [looking up/configuring/troubleshooting] [specific scenarios].
|
|
---
|
|
|
|
## When to Use This Skill
|
|
|
|
Use this skill when:
|
|
- Looking up [specific information type]
|
|
- Configuring [system/tool]
|
|
- Troubleshooting [specific issues]
|
|
|
|
Do NOT use this skill for:
|
|
- [Different but related topic]
|
|
- [Step-by-step tutorials - refer to X skill instead]
|
|
|
|
## Quick Reference
|
|
|
|
### Most Common Operations
|
|
|
|
| Operation | Command/Syntax | Example |
|
|
|-----------|----------------|---------|
|
|
| [Operation 1] | `[syntax]` | `[example]` |
|
|
| [Operation 2] | `[syntax]` | `[example]` |
|
|
| [Operation 3] | `[syntax]` | `[example]` |
|
|
|
|
## Command Reference
|
|
|
|
### Category 1: [Name]
|
|
|
|
#### [command_name]
|
|
|
|
**Purpose:** [What it does]
|
|
|
|
**Syntax:**
|
|
\```
|
|
[command syntax]
|
|
\```
|
|
|
|
**Options:**
|
|
- `[option]`: [description]
|
|
- `[option]`: [description]
|
|
|
|
**Examples:**
|
|
\```
|
|
[example 1]
|
|
[example 2]
|
|
\```
|
|
|
|
#### [command_name]
|
|
|
|
**Purpose:** [What it does]
|
|
|
|
**Syntax:**
|
|
\```
|
|
[command syntax]
|
|
\```
|
|
|
|
**Options:**
|
|
- `[option]`: [description]
|
|
- `[option]`: [description]
|
|
|
|
**Examples:**
|
|
\```
|
|
[example 1]
|
|
[example 2]
|
|
\```
|
|
|
|
### Category 2: [Name]
|
|
|
|
[Similar structure as Category 1]
|
|
|
|
## Configuration Reference
|
|
|
|
### [Configuration File/Section Name]
|
|
|
|
**Location:** `[path/to/config]`
|
|
|
|
**Format:** [format type]
|
|
|
|
**Common Settings:**
|
|
|
|
\```[format]
|
|
[example configuration with comments]
|
|
\```
|
|
|
|
**Options:**
|
|
|
|
| Setting | Type | Default | Description |
|
|
|---------|------|---------|-------------|
|
|
| [name] | [type] | [default] | [description] |
|
|
| [name] | [type] | [default] | [description] |
|
|
|
|
## Common Patterns
|
|
|
|
### Pattern 1: [Name]
|
|
|
|
**Use case:** [When to use this]
|
|
|
|
**Implementation:**
|
|
\```
|
|
[code/commands]
|
|
\```
|
|
|
|
### Pattern 2: [Name]
|
|
|
|
**Use case:** [When to use this]
|
|
|
|
**Implementation:**
|
|
\```
|
|
[code/commands]
|
|
\```
|
|
|
|
## Troubleshooting
|
|
|
|
### Error: [Error message or type]
|
|
|
|
**Cause:** [Why this happens]
|
|
|
|
**Solution:**
|
|
\```
|
|
[fix command or steps]
|
|
\```
|
|
|
|
### Error: [Error message or type]
|
|
|
|
**Cause:** [Why this happens]
|
|
|
|
**Solution:**
|
|
\```
|
|
[fix command or steps]
|
|
\```
|
|
|
|
## Tips and Tricks
|
|
|
|
### Tip 1: [Name]
|
|
[Description and example]
|
|
|
|
### Tip 2: [Name]
|
|
[Description and example]
|
|
|
|
## Related Topics
|
|
|
|
- **[Related Skill/Topic]**: [When to use instead]
|
|
- **[Related Skill/Topic]**: [When to use instead]
|
|
|
|
## Further Reading
|
|
|
|
For detailed information, see [reference.md](reference.md)
|
|
|
|
- Official Documentation: [link]
|
|
- Cheat Sheet: [link]
|
|
- Common Examples: [link]
|
|
```
|
|
|
|
---
|
|
|
|
## Template 4: Tool/Utility Skill
|
|
|
|
```markdown
|
|
---
|
|
name: [Tool Name]
|
|
description: Use [tool] to [primary purpose] for [domain/use case]. Covers [key features] and [integration points].
|
|
---
|
|
|
|
## When to Use This Skill
|
|
|
|
Use this skill when:
|
|
- [Primary use case]
|
|
- [Secondary use case]
|
|
- [Integration scenario]
|
|
|
|
Do NOT use this skill for:
|
|
- [What the tool doesn't do]
|
|
- [Alternative tool suggestion]
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
- [System requirement 1]
|
|
- [System requirement 2]
|
|
|
|
### Install
|
|
|
|
**Using [package manager 1]:**
|
|
\```bash
|
|
[install command]
|
|
\```
|
|
|
|
**Using [package manager 2]:**
|
|
\```bash
|
|
[install command]
|
|
\```
|
|
|
|
**Verify installation:**
|
|
\```bash
|
|
[verify command]
|
|
\```
|
|
|
|
## Quick Start
|
|
|
|
Minimal example to get started:
|
|
|
|
\```bash
|
|
[command]
|
|
\```
|
|
|
|
Expected output:
|
|
\```
|
|
[output]
|
|
\```
|
|
|
|
## Core Features
|
|
|
|
### Feature 1: [Name]
|
|
|
|
**What it does:** [Description]
|
|
|
|
**Basic usage:**
|
|
\```bash
|
|
[command]
|
|
\```
|
|
|
|
**Common options:**
|
|
- `[option]`: [what it does]
|
|
- `[option]`: [what it does]
|
|
|
|
**Example:**
|
|
\```bash
|
|
[example command]
|
|
\```
|
|
|
|
### Feature 2: [Name]
|
|
|
|
**What it does:** [Description]
|
|
|
|
**Basic usage:**
|
|
\```bash
|
|
[command]
|
|
\```
|
|
|
|
**Common options:**
|
|
- `[option]`: [what it does]
|
|
- `[option]`: [what it does]
|
|
|
|
**Example:**
|
|
\```bash
|
|
[example command]
|
|
\```
|
|
|
|
## Common Workflows
|
|
|
|
### Workflow 1: [Name]
|
|
|
|
**Goal:** [What you're trying to achieve]
|
|
|
|
**Steps:**
|
|
1. [Step with command]
|
|
\```bash
|
|
[command]
|
|
\```
|
|
|
|
2. [Step with command]
|
|
\```bash
|
|
[command]
|
|
\```
|
|
|
|
3. [Step with command]
|
|
\```bash
|
|
[command]
|
|
\```
|
|
|
|
**Result:** [What you've accomplished]
|
|
|
|
### Workflow 2: [Name]
|
|
|
|
[Similar structure]
|
|
|
|
## Configuration
|
|
|
|
### Configuration File
|
|
|
|
**Location:** `[path]`
|
|
|
|
**Example:**
|
|
\```[format]
|
|
[configuration example]
|
|
\```
|
|
|
|
### Environment Variables
|
|
|
|
| Variable | Purpose | Example |
|
|
|----------|---------|---------|
|
|
| [VAR_NAME] | [description] | `[example value]` |
|
|
|
|
## Integration
|
|
|
|
### Integration with [Tool/Framework 1]
|
|
|
|
\```[language]
|
|
[integration example]
|
|
\```
|
|
|
|
### Integration with [Tool/Framework 2]
|
|
|
|
\```[language]
|
|
[integration example]
|
|
\```
|
|
|
|
## Troubleshooting
|
|
|
|
### Issue: [Problem]
|
|
**Symptoms:** [How you know]
|
|
**Cause:** [Why it happens]
|
|
**Solution:**
|
|
\```bash
|
|
[fix]
|
|
\```
|
|
|
|
### Issue: [Problem]
|
|
**Symptoms:** [How you know]
|
|
**Cause:** [Why it happens]
|
|
**Solution:**
|
|
\```bash
|
|
[fix]
|
|
\```
|
|
|
|
## Advanced Usage
|
|
|
|
### Advanced Feature 1: [Name]
|
|
[Description and example]
|
|
|
|
### Advanced Feature 2: [Name]
|
|
[Description and example]
|
|
|
|
## Best Practices
|
|
|
|
1. **[Practice 1]:** [Why and how]
|
|
2. **[Practice 2]:** [Why and how]
|
|
3. **[Practice 3]:** [Why and how]
|
|
|
|
## Resources
|
|
|
|
- Official Documentation: [link]
|
|
- GitHub Repository: [link]
|
|
- Tutorial: [link]
|
|
```
|
|
|
|
---
|
|
|
|
## Template Selection Guide
|
|
|
|
Choose your template based on:
|
|
|
|
| Skill Type | Primary Goal | Use Template |
|
|
|------------|--------------|--------------|
|
|
| Teaching a framework/library | Help users write code | Code Framework |
|
|
| Guiding through a process | Help users complete workflow | Workflow/Process |
|
|
| Quick information lookup | Provide reference material | Reference/Lookup |
|
|
| Using a specific tool | Help users operate tool | Tool/Utility |
|
|
|
|
## Customization Tips
|
|
|
|
1. **Remove unnecessary sections**: If a section doesn't apply, delete it
|
|
2. **Add domain-specific sections**: Include what matters for your skill
|
|
3. **Adjust examples**: Make examples relevant to actual use cases
|
|
4. **Set the right scope**: Focus on one clear purpose per skill
|
|
5. **Test trigger accuracy**: Ensure description matches when you want it to activate
|