About template
A template for documenting a skill, with sections for its overview, use cases, setup, concepts, patterns, and troubleshooting. Its sample text is placeholder content to replace with details of the actual skill.
Key features
- 01Overview and usage scenarios
- 02Quick-start example
- 03Core concepts and code samples
- 04Patterns and best practices
- 05Troubleshooting and references
Use cases
- 01Structure documentation for a new skill
- 02Add a quick-start section to a skill
- 03Organize practical guidance for a skill
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ g1joshi/ agent-skills --skill templateAfter installing, type/templatein Claude Code to confirm it loaded.
Details
From the project READMESkill Name
Brief overview of what this skill does and the key capabilities it provides.
When to Use
- Trigger phrase or scenario 1
- Trigger phrase or scenario 2
- Trigger phrase or scenario 3
Quick Start
// Minimal working example - copy-paste ready
// Include essential imports and setup
Core Concepts
Concept 1
Explanation of fundamental concept with practical context.
// Code example demonstrating the concept
Concept 2
Another essential concept with clear explanation.
// Practical code example
Common Patterns
Pattern Name
Problem: What challenge does this solve?
Solution:
// Recommended approach with comments
Best Practices
Do:
- Practice 1 with rationale
- Practice 2 with explanation
Don't:
- Anti-pattern 1 and why
- Anti-pattern 2 and the alternative
Troubleshooting
| Error | Cause | Solution |
|---|---|---|
| Error message | Why it happens | How to fix |
References
Comments
Markdown supported