claude-configs/skills/create-skill/templates/CLAUDE-template.md
Cal Corum 8a1d15911f Initial commit: Claude Code configuration backup
Version control Claude Code configuration including:
- Global instructions (CLAUDE.md)
- User settings (settings.json)
- Custom agents (architect, designer, engineer, etc.)
- Custom skills (create-skill templates and workflows)

Excludes session data, secrets, cache, and temporary files per .gitignore.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-02-03 16:34:21 -06:00

354 lines
5.8 KiB
Markdown

# Skill Name - Comprehensive Guide
## 🎯 PURPOSE: [HIGH-LEVEL GOAL IN CAPS]
**[Value proposition - what this skill enables and why it matters]**
This guide covers:
- [Major topic 1]
- [Major topic 2]
- [Major topic 3]
- [Major topic 4]
## 📚 WHAT IS [MAIN CONCEPT]?
### Definition
[Detailed explanation of the core concept, capability, or methodology]
### Key Concepts
- **Concept 1**: Detailed explanation
- **Concept 2**: Detailed explanation
- **Concept 3**: Detailed explanation
### [Main Approach] vs [Alternative Approach]
**The Problem [Alternative] Solves:**
- Problem 1
- Problem 2
- Problem 3
**Why [Main Approach] Is Different:**
- ✅ Advantage 1 with explanation
- ✅ Advantage 2 with explanation
- ✅ Advantage 3 with explanation
- ✅ Advantage 4 with explanation
**[Alternative] documentation when you have [better method] = [problem statement].**
## 🏗️ ARCHITECTURE / METHODOLOGY
### Overall Framework
[Detailed explanation of the methodology or architecture]
### Core Components
**Component 1:**
- Purpose
- How it works
- When to use
- Integration points
**Component 2:**
[Same structure]
### System Diagram / Workflow Overview
```
[ASCII diagram or structured breakdown of system]
```
## 🚀 THE [MAIN WORKFLOW NAME]
**[Brief description of the workflow approach]**
### Phase 0: [Setup/Foundation]
**Command:** `/command-name` (if applicable)
[Detailed instructions for this phase]
**Objectives:**
- Objective 1
- Objective 2
- Objective 3
**Output:**
- Output file 1 - Description
- Output file 2 - Description
- Automatically captured to [location]
**Notes:** [Important notes about this phase]
### Phase 1: [Next Phase Name]
**Command:** `/command-name`
[Detailed instructions]
**Objectives:**
- Objective 1
- Objective 2
**Output:** [What gets created]
### Phase 2: [Next Phase Name]
[Continue for all phases]
**🏁 Goal: [Summary of what the complete workflow achieves]**
## 🔧 OPTIONAL [ENHANCEMENT] COMMANDS
These enhance [aspect] throughout the process:
### `/command-name-1`
**When:** [When to use this command]
- Purpose and benefits
- What it does
- How it improves results
### `/command-name-2`
**When:** [When to use this command]
- Purpose and benefits
- What it does
- How it improves results
## 🎯 BEST PRACTICES
### [Category 1]
- **Practice 1** - Detailed explanation with rationale
- **Practice 2** - Detailed explanation with rationale
- **Practice 3** - Detailed explanation with rationale
### [Category 2]
- **Practice 1** - Detailed explanation
- **Practice 2** - Detailed explanation
### [Category 3]
- **Practice 1** - Detailed explanation
- **Practice 2** - Detailed explanation
## 🛠️ TECHNOLOGY STACK / TOOLS
### Core Technology
[Detailed description of primary technology]
**Key features:**
- Feature 1
- Feature 2
- Feature 3
### Supporting Tools
**Tool 1:**
- Purpose
- Integration
- Usage
**Tool 2:**
[Same structure]
### Configuration
[Standard configuration or setup instructions]
## 📊 [ADDITIONAL MAJOR SECTION]
[Deep dive into important aspect]
### Subsection 1
[Detailed content]
### Subsection 2
[Detailed content]
## 🤖 [AGENTS / AUTOMATION] (if applicable)
### Agent 1 (Name)
**Training:** [Specialization]
**Voice:** [ID]
**Configuration:** `path`
**Parallel Execution:** [Capabilities]
**Responsibilities:**
- Phase 1: [What agent does]
- Phase 2: [What agent does]
[Continue for each agent]
### Agent Collaboration Protocol
[How agents work together]
**Workflow Handoff:**
1. Agent 1 completes [work]
2. Agent 2 validates [artifacts]
3. Communication protocol
4. Parallel execution rules
## 🔗 INTEGRATION POINTS
### With Other Skills
- **Skill 1**: How they integrate
- **Skill 2**: How they integrate
### With Tools
- **Tool 1**: Integration details
- **Tool 2**: Integration details
### With Infrastructure
[How this skill integrates with PAI infrastructure]
## 🚨 CRITICAL WARNINGS
### Warning Category 1
**Rule:** [Critical rule]
**Rationale:** [Why this matters]
**Consequences of violation:**
- Consequence 1
- Consequence 2
### Warning Category 2
[Same structure]
## 💡 CORE PRINCIPLES
1. **Principle 1** - Detailed explanation with examples and rationale
2. **Principle 2** - Detailed explanation
3. **Principle 3** - Detailed explanation
[Continue for all principles]
## 🎓 EXAMPLES AND PATTERNS
### Example 1: [Scenario Name]
**Context:** [Situation description]
**Approach:**
```
Step-by-step walkthrough with commands/code
```
**Result:** [What was achieved]
**Lessons:** [What to learn from this]
### Example 2: [Scenario Name]
[Same structure]
## 📈 SUCCESS METRICS / VALIDATION
### How to Measure [Quality]
- Metric 1: Target value
- Metric 2: Target value
- Metric 3: Target value
### Validation Checklist
- [ ] Check 1
- [ ] Check 2
- [ ] Check 3
## 🔧 TROUBLESHOOTING
### Problem 1: [Common Issue]
**Symptoms:**
- Symptom 1
- Symptom 2
**Diagnosis:**
[How to identify the problem]
**Solution:**
[Step-by-step fix]
### Problem 2: [Common Issue]
[Same structure]
## 📚 SUPPLEMENTARY RESOURCES
### Internal Resources
- Path to related documentation
- Path to components
- Path to examples
### External Resources
- Official documentation links
- Community resources
- Learning materials
## 🎯 QUICK REFERENCE
### Common Commands
```bash
# Task 1
command-sequence
# Task 2
command-sequence
# Task 3
command-sequence
```
### Decision Tree
**When to use approach A:**
- Condition 1
- Condition 2
**When to use approach B:**
- Condition 1
- Condition 2
## 📊 APPENDIX
### Glossary
- **Term 1**: Definition
- **Term 2**: Definition
### Configuration Reference
[Detailed configuration options]
### API Reference
[If applicable - API documentation]
---
## 🎯 SUMMARY
**Key Takeaways:**
1. Takeaway 1
2. Takeaway 2
3. Takeaway 3
**Remember:**
- Critical point 1
- Critical point 2
- Critical point 3
**Next Steps:**
- Action 1
- Action 2
- Action 3