Files
gh-francyjglisboa-agent-ski…/references/templates/README-activation-template.md
2025-11-29 18:27:25 +08:00

345 lines
5.9 KiB
Markdown

# {{Skill Name}}
**Version:** {{version}}
**Type:** {{Simple Skill / Skill Suite}}
**Created by:** Agent-Skill-Creator v{{version}}
---
## Overview
{{Brief description of what the skill does and why it's useful}}
### Key Features
- {{Feature 1}}
- {{Feature 2}}
- {{Feature 3}}
---
## Installation
```bash
# Installation instructions
{{installation-commands}}
```
---
## 🎯 Skill Activation
This skill uses a **3-Layer Activation System** for reliable detection.
### ✅ Phrases That Activate This Skill
The skill will automatically activate when you use phrases like:
#### Primary Activation Phrases
1. **"{{keyword-phrase-1}}"**
- Example: "{{example-1}}"
2. **"{{keyword-phrase-2}}"**
- Example: "{{example-2}}"
3. **"{{keyword-phrase-3}}"**
- Example: "{{example-3}}"
#### Workflow-Based Activation
4. **"{{workflow-phrase-1}}"**
- Example: "{{example-4}}"
5. **"{{workflow-phrase-2}}"**
- Example: "{{example-5}}"
#### Domain-Specific Activation
6. **"{{domain-phrase-1}}"**
- Example: "{{example-6}}"
7. **"{{domain-phrase-2}}"**
- Example: "{{example-7}}"
#### Natural Language Variations
8. **"{{natural-variation-1}}"**
- Example: "{{example-8}}"
9. **"{{natural-variation-2}}"**
- Example: "{{example-9}}"
10. **"{{natural-variation-3}}"**
- Example: "{{example-10}}"
### ❌ Phrases That Do NOT Activate
To prevent false positives, this skill will **NOT** activate for:
1. **{{counter-case-1}}**
- Example: "{{counter-example-1}}"
- Reason: {{reason-1}}
2. **{{counter-case-2}}**
- Example: "{{counter-example-2}}"
- Reason: {{reason-2}}
3. **{{counter-case-3}}**
- Example: "{{counter-example-3}}"
- Reason: {{reason-3}}
### 💡 Activation Tips
To ensure reliable activation:
**DO:**
- ✅ Use action verbs: {{verb-examples}}
- ✅ Be specific about: {{context-requirements}}
- ✅ Mention: {{entity-keywords}}
- ✅ Include context: {{context-examples}}
**DON'T:**
- ❌ Use vague phrases like "{{vague-example}}"
- ❌ Omit key entities like "{{missing-entity}}"
- ❌ Be too generic: "{{generic-example}}"
### 🎯 Example Activation Patterns
**Pattern 1:** {{Pattern-description-1}}
```
User: "{{example-query-1}}"
Result: ✅ Skill activates via {{layer-name}}
```
**Pattern 2:** {{Pattern-description-2}}
```
User: "{{example-query-2}}"
Result: ✅ Skill activates via {{layer-name}}
```
**Pattern 3:** {{Pattern-description-3}}
```
User: "{{example-query-3}}"
Result: ✅ Skill activates via {{layer-name}}
```
---
## Usage
### Basic Usage
```{{language}}
{{basic-usage-example}}
```
### Advanced Usage
```{{language}}
{{advanced-usage-example}}
```
### Real-World Examples
#### Example 1: {{Example-title-1}}
**User Query:**
```
"{{example-query-1}}"
```
**Skill Actions:**
1. {{action-step-1}}
2. {{action-step-2}}
3. {{action-step-3}}
**Output:**
```{{format}}
{{example-output-1}}
```
#### Example 2: {{Example-title-2}}
**User Query:**
```
"{{example-query-2}}"
```
**Skill Actions:**
1. {{action-step-1}}
2. {{action-step-2}}
3. {{action-step-3}}
**Output:**
```{{format}}
{{example-output-2}}
```
---
## Features
### Feature 1: {{Feature-name}}
{{Description of feature 1}}
**Activation:**
- "{{feature-1-query}}"
**Example:**
```{{language}}
{{feature-1-example}}
```
### Feature 2: {{Feature-name}}
{{Description of feature 2}}
**Activation:**
- "{{feature-2-query}}"
**Example:**
```{{language}}
{{feature-2-example}}
```
---
## Configuration
### Optional Configuration
{{Configuration-instructions}}
```{{format}}
{{configuration-example}}
```
---
## Troubleshooting
### Issue: Skill Not Activating
**Symptoms:** Your query doesn't activate the skill
**Solutions:**
1. ✅ Use one of the activation phrases listed above
2. ✅ Include action verbs: {{verb-list}}
3. ✅ Mention specific entities: {{entity-list}}
4. ✅ Provide context: "{{context-example}}"
**Example Fix:**
```
❌ "{{vague-query}}"
✅ "{{specific-query}}"
```
### Issue: Wrong Skill Activates
**Symptoms:** A different skill activates instead
**Solutions:**
1. Be more specific about this skill's domain
2. Use domain-specific keywords: {{domain-keywords}}
3. Add context that distinguishes from other skills
**Example Fix:**
```
❌ "{{ambiguous-query}}"
✅ "{{specific-query-with-context}}"
```
---
## Testing
### Activation Test Suite
You can verify activation with these test queries:
```markdown
1. "{{test-query-1}}" → Should activate ✅
2. "{{test-query-2}}" → Should activate ✅
3. "{{test-query-3}}" → Should activate ✅
4. "{{test-query-4}}" → Should activate ✅
5. "{{test-query-5}}" → Should activate ✅
6. "{{test-query-6}}" → Should NOT activate ❌
7. "{{test-query-7}}" → Should NOT activate ❌
```
---
## FAQ
### Q: Why isn't the skill activating for my query?
**A:** Make sure your query includes:
- Action verb ({{verb-examples}})
- Entity/object ({{entity-examples}})
- Specific context ({{context-examples}})
See the "Activation Tips" section above.
### Q: How do I know which phrases will activate the skill?
**A:** Check the "Phrases That Activate This Skill" section above for 10+ tested examples.
### Q: Can I use variations of the activation phrases?
**A:** Yes! The skill uses regex patterns and Claude's NLU, so natural variations will work. For example:
- "{{variation-1}}" ✅
- "{{variation-2}}" ✅
- "{{variation-3}}" ✅
---
## Technical Details
### Architecture
{{Architecture-description}}
### Components
- **{{Component-1}}**: {{Description}}
- **{{Component-2}}**: {{Description}}
- **{{Component-3}}**: {{Description}}
### Dependencies
```{{format}}
{{dependencies-list}}
```
---
## Contributing
{{Contributing-guidelines}}
---
## License
{{License-information}}
---
## Changelog
### v{{version}} ({{date}})
- {{change-1}}
- {{change-2}}
- {{change-3}}
---
## Support
For issues or questions:
- {{support-contact}}
---
**Generated by:** Agent-Skill-Creator v{{version}}
**Last Updated:** {{date}}
**Activation System:** 3-Layer (Keywords + Patterns + Description)