External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-17 17:56:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
SuperClaude/docs/reference/examples-cookbook.md
kazuki nakai d5dfd7da21
refactor(docs): normalize documentation naming to lowercase for PEP8 compliance (#434) 
* refactor(docs): rename directories to lowercase for PEP8 compliance

- Developer-Guide → developer-guide
- Getting-Started → getting-started
- Reference → reference
- Templates → templates
- User-Guide → user-guide
- User-Guide-jp → user-guide-jp
- User-Guide-kr → user-guide-kr
- User-Guide-zh → user-guide-zh

This change aligns with Python PEP8 package naming conventions.
All 43 files affected.

* refactor: rename root documentation files to lowercase

- CHANGELOG.md → changelog.md
- CODE_OF_CONDUCT.md → code_of_conduct.md
- CONTRIBUTING.md → contributing.md
- SECURITY.md → security.md

Aligns with Python package naming conventions (PEP8).
README files remain uppercase as per convention.

* refactor: move documentation files to docs/ for cleaner root

Moved OSS standard files to docs/:
- CHANGELOG.md → docs/CHANGELOG.md
- CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md
- CONTRIBUTING.md → docs/CONTRIBUTING.md
- SECURITY.md → docs/SECURITY.md

Root now contains only essential files:
✓ README files (表紙: en, ja, kr, zh)
✓ LICENSE (法的要件)
✓ Build configs (pyproject.toml, setup.py, MANIFEST.in)
✓ VERSION

Rationale:
Cleaner root structure following modern Python project conventions.
All detailed documentation consolidated in docs/ directory.

* refactor: update documentation links after restructure

Auto-updated internal documentation links to reflect new structure:
- docs/ subdirectories now lowercase (PEP8)
- Root files moved to docs/
- All cross-references updated

This commit includes linter-generated link updates.

* chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY)

* chore(docs): remove duplicated PR docs from repo root (moved under docs)

* docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity

* docs: update links to PM_AGENT.md after rename

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
2025-10-15 21:07:39 +05:30

172 lines
8.8 KiB
Markdown
Raw Blame History

# SuperClaude Examples Cookbook
**Status**: ✅ **Status: Current** - Comprehensive collection of practical SuperClaude usage examples organized by complexity and domain.
**Focused Recipe Collections**: The SuperClaude Examples Cookbook has been restructured into three focused collections for better usability and progressive learning.
## Recipe Collections Overview
### [Basic Examples Collection](./basic-examples.md)
**Essential commands and single-agent workflows**
- Copy-paste ready commands for immediate use
- Essential SuperClaude patterns and fundamentals
- Common development tasks and troubleshooting
- Perfect starting point for new users
**Best for**: New users, quick task execution, learning fundamentals
### [Advanced Workflows Collection](./advanced-workflows.md)
**Multi-agent coordination and complex orchestration**
- Multi-agent collaboration patterns
- Enterprise-scale project workflows
- Session management and persistence
- Complex system development patterns
**Best for**: Experienced users, enterprise projects, complex coordination
### [Integration Patterns Collection](./integration-patterns.md)
**Framework integration and cross-tool coordination**
- Framework-specific integration patterns
- Performance optimization recipes
- Cross-tool coordination strategies
- Monitoring and observability patterns
**Best for**: Expert users, system architects, performance optimization
## Quick Navigation Guide
### By Experience Level
**Beginner**
→ Start with [Basic Examples](./basic-examples.md)
- Essential commands and patterns
- Simple troubleshooting workflows
- Copy-paste solutions for common tasks
**Intermediate**
→ Progress to [Advanced Workflows](./advanced-workflows.md)
- Multi-agent coordination
- Complex project orchestration
- Session management patterns
**Expert**
→ Master [Integration Patterns](./integration-patterns.md)
- Framework integration strategies
- Performance optimization recipes
- Enterprise-scale architecture patterns
### By Use Case
**Web Development**
- Frontend: [Basic Examples](./basic-examples.md#frontend-component-development) → [Integration Patterns](./integration-patterns.md#react-ecosystem-integration)
- Backend: [Basic Examples](./basic-examples.md#api-development-basics) → [Integration Patterns](./integration-patterns.md#nodejs-backend-integration)
- Full-Stack: [Advanced Workflows](./advanced-workflows.md#complete-e-commerce-platform-development)
**Mobile Development**
- React Native: [Basic Examples](./basic-examples.md#copy-paste-quick-solutions) → [Integration Patterns](./integration-patterns.md#mobile-and-web-integration)
- Cross-Platform: [Integration Patterns](./integration-patterns.md#cross-platform-integration-patterns)
**DevOps & Infrastructure**
- CI/CD: [Basic Examples](./basic-examples.md#copy-paste-quick-solutions) → [Integration Patterns](./integration-patterns.md#devops-and-infrastructure-integration)
- Monitoring: [Advanced Workflows](./advanced-workflows.md#advanced-monitoring-and-observability) → [Integration Patterns](./integration-patterns.md#monitoring-and-observability-patterns)
**Performance & Security**
- Security: [Basic Examples](./basic-examples.md#basic-troubleshooting-examples) → [Advanced Workflows](./advanced-workflows.md#enterprise-scale-security-implementation)
- Performance: [Integration Patterns](./integration-patterns.md#performance-optimization-recipes)
## Verified Commands Reference
**Core Commands**:
- `/sc:brainstorm` - Interactive requirements discovery
- `/sc:analyze` - Codebase analysis and assessment
- `/sc:implement` - Feature implementation with best practices
- `/sc:troubleshoot` - Systematic problem diagnosis
- `/sc:test` - Comprehensive testing and validation
- `/sc:spawn` - Complex multi-agent coordination
- `/sc:load` / `/sc:save` - Session management
- `/sc:reflect` - Context analysis and optimization
**Verified Flags**:
- `--think`, `--think-hard`, `--ultrathink` - Analysis depth control
- `--uc` - Ultra-compressed token-efficient mode
- `--orchestrate` - Intelligent coordination mode
- `--c7`, `--serena`, `--all-mcp` - MCP server integration
- `--focus [domain]` - Domain-specific optimization
- `--scope [level]` - Analysis scope control
## Learning Progression Roadmap
### Phase 1: Foundation (Week 1-2)
1. **Setup**: Complete [Installation Guide](../getting-started/installation.md)
2. **Basics**: Practice [Basic Examples](./basic-examples.md#essential-one-liner-commands)
3. **Patterns**: Learn [Basic Usage Patterns](./basic-examples.md#basic-usage-patterns)
4. **Success**: Can execute common development tasks independently
### Phase 2: Coordination (Week 3-6)
1. **Agents**: Understand [Multi-Agent Patterns](./advanced-workflows.md#multi-agent-collaboration-patterns)
2. **Workflows**: Practice [Complex Project Workflows](./advanced-workflows.md#complex-project-workflows)
3. **Orchestration**: Master [Advanced Orchestration](./advanced-workflows.md#advanced-orchestration-patterns)
4. **Success**: Can coordinate complex multi-step projects
### Phase 3: Integration (Month 2+)
1. **Frameworks**: Learn [Framework Integration](./integration-patterns.md#framework-integration-patterns)
2. **Performance**: Master [Optimization Recipes](./integration-patterns.md#performance-optimization-recipes)
3. **Troubleshooting**: Advanced [Debugging Workflows](./integration-patterns.md#advanced-troubleshooting-workflows)
4. **Success**: Can integrate SuperClaude with any development stack
### Phase 4: Expertise (Month 3+)
1. **Architecture**: Design custom integration patterns
2. **Contribution**: Contribute to SuperClaude framework
3. **Leadership**: Mentor community and solve complex problems
4. **Success**: Framework development and community leadership
## Quick Reference Matrix
| Task Type | Beginner | Intermediate | Expert |
|-----------|----------|--------------|--------|
| **Analysis** | [Basic Analysis](./basic-examples.md#quick-analysis-commands) | [Multi-Agent Analysis](./advanced-workflows.md#performance-optimization-team) | [Integration Analysis](./integration-patterns.md#distributed-system-debugging) |
| **Implementation** | [Simple Features](./basic-examples.md#simple-feature-implementation) | [Complex Projects](./advanced-workflows.md#complex-project-workflows) | [Framework Integration](./integration-patterns.md#framework-integration-patterns) |
| **Testing** | [Basic Testing](./basic-examples.md#copy-paste-quick-solutions) | [Comprehensive Testing](./advanced-workflows.md#advanced-workflows) | [Testing Integration](./integration-patterns.md#advanced-testing-integration) |
| **Troubleshooting** | [Common Issues](./basic-examples.md#basic-troubleshooting-examples) | [System Debugging](./advanced-workflows.md#advanced-workflows) | [Distributed Debugging](./integration-patterns.md#advanced-troubleshooting-workflows) |
| **Performance** | [Basic Optimization](./basic-examples.md#quick-quality-improvements) | [System Optimization](./advanced-workflows.md#performance-optimization-strategies) | [Expert Optimization](./integration-patterns.md#performance-optimization-recipes) |
## Success Milestones
### ✅ Basic Proficiency
- [ ] Can install and configure SuperClaude
- [ ] Comfortable with 5-10 core commands
- [ ] Can complete simple workflows independently
- [ ] Understands basic flag usage
### ✅ Intermediate Mastery
- [ ] Masters multi-agent coordination
- [ ] Can orchestrate complex workflows
- [ ] Understands session management
- [ ] Comfortable with advanced flag combinations
### ✅ Expert Integration
- [ ] Can integrate any development framework
- [ ] Masters performance optimization
- [ ] Develops custom integration patterns
- [ ] Contributes to framework development
## Support Resources
**Documentation**:
- [Commands Reference](../user-guide/commands.md) - Complete command documentation
- [Agents Guide](../user-guide/agents.md) - Multi-agent coordination
- [MCP Servers](../user-guide/mcp-servers.md) - Enhanced capabilities
- [Advanced Workflows](./advanced-workflows.md) - Complex coordination patterns
**Community**:
- [GitHub Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions) - Community support
- [GitHub Issues](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues) - Bug reports and features
- [Contributing Guide](../CONTRIBUTING.md) - Framework contribution
**Advanced**:
- [Technical Architecture](../developer-guide/technical-architecture.md) - Deep system understanding
- [Troubleshooting Guide](./troubleshooting.md) - Common issues and solutions
---
**Your Journey**: Start with [Basic Examples](./basic-examples.md), progress through [Advanced Workflows](./advanced-workflows.md), and master [Integration Patterns](./integration-patterns.md). SuperClaude grows with you from simple commands to sophisticated development orchestration.
**Remember**: Every expert was once a beginner. Focus on practical application, experiment with different approaches, and leverage the community for support and learning.
Reference in New Issue View Git Blame Copy Permalink