mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-17 09:46:06 +00:00
d5dfd7da21
* 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>
8.8 KiB
8.8 KiB
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
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
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
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
- Essential commands and patterns
- Simple troubleshooting workflows
- Copy-paste solutions for common tasks
Intermediate → Progress to Advanced Workflows
- Multi-agent coordination
- Complex project orchestration
- Session management patterns
Expert → Master Integration Patterns
- Framework integration strategies
- Performance optimization recipes
- Enterprise-scale architecture patterns
By Use Case
Web Development
- Frontend: Basic Examples → Integration Patterns
- Backend: Basic Examples → Integration Patterns
- Full-Stack: Advanced Workflows
Mobile Development
- React Native: Basic Examples → Integration Patterns
- Cross-Platform: Integration Patterns
DevOps & Infrastructure
- CI/CD: Basic Examples → Integration Patterns
- Monitoring: Advanced Workflows → Integration Patterns
Performance & Security
- Security: Basic Examples → Advanced Workflows
- Performance: Integration Patterns
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)
- Setup: Complete Installation Guide
- Basics: Practice Basic Examples
- Patterns: Learn Basic Usage Patterns
- Success: Can execute common development tasks independently
Phase 2: Coordination (Week 3-6)
- Agents: Understand Multi-Agent Patterns
- Workflows: Practice Complex Project Workflows
- Orchestration: Master Advanced Orchestration
- Success: Can coordinate complex multi-step projects
Phase 3: Integration (Month 2+)
- Frameworks: Learn Framework Integration
- Performance: Master Optimization Recipes
- Troubleshooting: Advanced Debugging Workflows
- Success: Can integrate SuperClaude with any development stack
Phase 4: Expertise (Month 3+)
- Architecture: Design custom integration patterns
- Contribution: Contribute to SuperClaude framework
- Leadership: Mentor community and solve complex problems
- Success: Framework development and community leadership
Quick Reference Matrix
| Task Type | Beginner | Intermediate | Expert |
|---|---|---|---|
| Analysis | Basic Analysis | Multi-Agent Analysis | Integration Analysis |
| Implementation | Simple Features | Complex Projects | Framework Integration |
| Testing | Basic Testing | Comprehensive Testing | Testing Integration |
| Troubleshooting | Common Issues | System Debugging | Distributed Debugging |
| Performance | Basic Optimization | System Optimization | Expert Optimization |
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 - Complete command documentation
- Agents Guide - Multi-agent coordination
- MCP Servers - Enhanced capabilities
- Advanced Workflows - Complex coordination patterns
Community:
- GitHub Discussions - Community support
- GitHub Issues - Bug reports and features
- Contributing Guide - Framework contribution
Advanced:
- Technical Architecture - Deep system understanding
- Troubleshooting Guide - Common issues and solutions
Your Journey: Start with Basic Examples, progress through Advanced Workflows, and master Integration Patterns. 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.