npx machina-cli add skill NickCrew/claude-cortex/.template --openclawSkill Title
Brief overview paragraph explaining what this skill provides, its purpose, and its scope. Include key concepts and what makes this skill valuable.
When to Use This Skill
Provide 5-10 specific scenarios when this skill should be activated:
- Scenario 1: Specific use case with clear trigger
- Scenario 2: Another distinct situation
- Scenario 3: Related but different context
- Scenario 4: Edge case or advanced usage
- Scenario 5: Integration with other tools/frameworks
Core Concepts
Brief introduction to foundational concepts needed to understand this skill.
Concept 1: Foundation
Explanation of first essential concept with simple example:
// Simple, clear example demonstrating concept
// Include comments explaining key points
Key points:
- Important aspect 1
- Important aspect 2
- Important aspect 3
Concept 2: Building Blocks
Second essential concept with progression from basic to intermediate:
// Example showing concept application
// Demonstrate best practices
When to use:
- Use case 1
- Use case 2
- Use case 3
Common Patterns
Pattern 1: [Pattern Name]
Problem: Describe the problem this pattern solves
Solution: Explain the pattern approach
Example:
// Complete, working example
// Well-commented to explain approach
// Include edge cases if relevant
function examplePattern() {
// Implementation details
// Show best practices
}
Pros:
- Advantage 1
- Advantage 2
- Advantage 3
Cons:
- Limitation 1
- Limitation 2
When to use: Specific criteria for applying this pattern
Pattern 2: [Pattern Name]
Problem: Second problem domain
Solution: Alternative or complementary approach
Example:
// Different approach showing variety
// Demonstrate trade-offs
Comparison: How this pattern differs from Pattern 1
Advanced Usage
This section provides deeper patterns for complex scenarios. Load only when needed.
Advanced Pattern 1: [Complex Scenario]
Context for when advanced usage is necessary:
// More sophisticated example
// Show integration with multiple concepts
// Demonstrate production-ready code
class AdvancedExample {
// Complete implementation
// Include error handling
// Show performance considerations
}
Considerations:
- Performance impact
- Scalability concerns
- Security implications
- Maintenance burden
Advanced Pattern 2: [Edge Cases]
Handling edge cases and uncommon scenarios:
// Edge case handling
// Defensive programming
// Graceful degradation
Integration Examples
Integrating with [Related Technology 1]
// Show how this skill integrates with other systems
// Practical, real-world example
Integrating with [Related Technology 2]
// Different integration scenario
// Demonstrate flexibility
Best Practices Summary
Quick reference for implementing this skill effectively:
Do's
- Do this for best results
- Always consider this aspect
- Prefer this approach when possible
- Validate this condition before proceeding
- Document this information for maintainability
Don'ts
- Avoid this anti-pattern
- Don't forget this critical step
- Never do this in production
- Don't overlook this edge case
- Avoid this common mistake
Performance Tips
- Optimization technique 1
- Optimization technique 2
- Caching strategy
- Resource management
Security Considerations
- Security practice 1
- Security practice 2
- Input validation requirements
- Authentication/authorization concerns
Common Pitfalls
Pitfall 1: [Common Mistake]
Problem: Description of what goes wrong
Why it happens: Explanation of root cause
Solution: How to avoid or fix
// Incorrect approach (anti-pattern)
// badExample();
// Correct approach
// goodExample();
Pitfall 2: [Another Mistake]
Problem: Second common issue
Solution: Prevention strategy
Testing Strategies
Unit Testing
// Example test cases
// Show test structure
// Demonstrate assertions
describe('Feature', () => {
it('should handle expected case', () => {
// Test implementation
});
it('should handle edge case', () => {
// Edge case testing
});
});
Integration Testing
// Integration test example
// Show testing across boundaries
Real-World Examples
Example 1: [Practical Scenario]
Context: Real-world situation description
Implementation:
// Complete, production-ready example
// Include error handling
// Show configuration
// Demonstrate best practices
class RealWorldExample {
// Full implementation
// Comments explaining decisions
// Edge case handling
}
Results: Outcome and benefits achieved
Example 2: [Different Scenario]
Context: Alternative use case
Implementation:
// Different approach for different context
Lessons learned: Insights from this implementation
Troubleshooting
Issue 1: [Common Problem]
Symptoms: What the user observes
Causes: Typical root causes
Solutions:
- First attempt solution
- Alternative approach
- Last resort option
Prevention: How to avoid this issue
Issue 2: [Another Problem]
Symptoms: Observable behavior
Diagnostic steps:
- Check this first
- Verify this condition
- Investigate this aspect
Resolution: How to fix
Tools and Resources
Recommended Tools
- Tool 1: What it does and when to use
- Tool 2: Alternative tool and trade-offs
- Tool 3: Complementary tool
Libraries and Frameworks
- Library 1: Purpose and integration approach
- Library 2: Alternative library comparison
Documentation Links
Further Reading
- Article/book: Brief description
- Tutorial: What it covers
- Video course: Key takeaways
Version History
- 1.0.0 (2024-10-17): Initial release
- Core patterns implemented
- Examples validated
- Best practices documented
Related Skills
This skill works well with:
- related-skill-1: How they complement each other
- related-skill-2: When to use together
- related-skill-3: Integration points
Maintenance Notes
Author commitment: Expected update frequency and maintenance approach
Contribution welcome: Areas where community contributions would be valuable
Known limitations: Current gaps or planned improvements
Deprecation policy: How breaking changes will be handled
License
This skill is licensed under the MIT License. See LICENSE file for details.
Author Contact
- Name: Your Name
- Email: your.email@example.com
- GitHub: @yourusername
- Website: https://yourwebsite.com (optional)
For issues or questions about this skill, please:
- Check documentation above
- Search existing GitHub issues
- Open new issue with
community-skill:your-skill-namelabel - Contact author directly for urgent matters
Source
git clone https://github.com/NickCrew/claude-cortex/blob/main/skills/community/.template/SKILL.mdView on GitHub Overview
Provides a modular blueprint for building AI agent capabilities. It outlines use cases, core concepts, design patterns, and integration examples to guide implementation and documentation. It helps teams deploy consistent, production-ready skills.
How This Skill Works
The skill template uses a predefined structure with sections like When to Use This Skill, Core Concepts, Common Patterns, and Integration Examples to organize knowledge. Teams fill in real content and implementations, then reuse the same patterns across multiple skills for consistency and scalability.
When to Use It
- Scenario 1: Specific use case with clear trigger
- Scenario 2: Another distinct situation
- Scenario 3: Related but different context
- Scenario 4: Edge case or advanced usage
- Scenario 5: Integration with other tools/frameworks
Quick Start
- Step 1: Review the SKILL.md template and identify trigger scenarios
- Step 2: Populate the sections with concrete descriptions, code examples, and integration details
- Step 3: Validate with test cases and document the skill for reuse
Best Practices
- Do this for best results
- Always consider this aspect
- Prefer this approach when possible
- Validate this condition before proceeding
- Document this information for maintainability
Example Use Cases
- Example: Basic skeleton for a new skill
- Example: Pattern-based integration with a tool
- Example: Advanced usage with edge-case handling
- Example: Defensive programming in production
- Example: Documentation-driven development for skills