External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-29 16:16:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

📚 Complete documentation restructure and content cleanup

Browse Source 
- Standardize documentation structure across all sections
- Fix CLI confusion and streamline user guidance
- Remove fictional content and align with actual functionality
- Improve technical architecture documentation
- Update installation and quick-start guides
- Enhance reference materials and examples

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
2025-08-22 19:18:44 +02:00
parent f7cf87c5ad
commit 850e5a69a6
16 changed files with 99 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
Docs/User-Guide/agents.md
View File

@@ -1,8 +1,10 @@
# SuperClaude Agents Guide 🤖
SuperClaude provides 14 domain specialist agents that Claude Code can invoke for specialized expertise.
## ✅ Verification Status
- **
- **Last Tested**: 2025-01-16
- **Agent Count**: 14 specialists available
- **Last Tested**: 2025-01-16
- **Test Environment**: Linux/Windows/macOS
- **Agent Activation**: ✅ All Verified
@@ -501,7 +503,7 @@ For troubleshooting help, see:
- [Common Issues](../Reference/common-issues.md) - Quick fixes for frequent problems
- [Troubleshooting Guide](../Reference/troubleshooting.md) - Comprehensive problem resolution
### Common Issues (< 2 minutes)
### Common Issues
- **No agent activation**: Use domain keywords: "security", "performance", "frontend"
- **Wrong agents selected**: Check trigger keywords in agent documentation
- **Too many agents**: Focus keywords on primary domain or use `/sc:focus [domain]`
@@ -552,35 +554,24 @@ For troubleshooting help, see:
"implement server-side authentication" # Backend focus - triggers backend-architect
```
### Progressive Support Levels
### Support Levels
**Level 1: Quick Fix (< 2 min)**
**Quick Fix:**
- Use explicit domain keywords from agent trigger table
- Try restarting Claude Code session
- Focus on single domain to avoid confusion
**Level 2: Detailed Help (5-15 min)**
```bash
# Agent-specific diagnostics
/sc:help agents # List available agents
/sc:explain "agent selection process" # Understand routing
# Review trigger keywords for target agents
```
**Detailed Help:**
- See [Common Issues Guide](../Reference/common-issues.md) for agent installation problems
- Review trigger keywords for target agents
**Level 3: Expert Support (30+ min)**
```bash
# Deep agent analysis
SuperClaude install --diagnose
# Check agent coordination patterns
# Review multi-domain keyword strategies
```
- See [Diagnostic Reference Guide](../Reference/diagnostic-reference.md) for agent coordination analysis
**Expert Support:**
- Use `SuperClaude install --diagnose`
- See [Diagnostic Reference Guide](../Reference/diagnostic-reference.md) for coordination analysis
**Level 4: Community Support**
- Report agent issues at [GitHub Issues](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
**Community Support:**
- Report issues at [GitHub Issues](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
- Include examples of expected vs actual agent activation
- Describe the type of task and desired agent combination
### Success Validation
@@ -646,40 +637,21 @@ After applying agent fixes, test with:
| `/sc:test` | quality-engineer | security-engineer, performance-engineer |
| `/sc:explain` | learning-guide | technical-writer, domain specialists |
### Most Effective Agent Combinations
### Effective Agent Combinations
**Development Workflows**:
```bash
# Web application (4-5 agents)
frontend-architect + backend-architect + security-engineer + quality-engineer + devops-architect
# API development (3-4 agents)
backend-architect + security-engineer + technical-writer + quality-engineer
# Data platform (3-4 agents)
python-expert + performance-engineer + security-engineer + system-architect
```
- Web application: frontend-architect + backend-architect + security-engineer + quality-engineer + devops-architect
- API development: backend-architect + security-engineer + technical-writer + quality-engineer
- Data platform: python-expert + performance-engineer + security-engineer + system-architect
**Analysis Workflows**:
```bash
# Security audit (3-4 agents)
security-engineer + quality-engineer + root-cause-analyst + technical-writer
# Performance investigation (3-4 agents)
performance-engineer + root-cause-analyst + system-architect + devops-architect
# Legacy assessment (4-5 agents)
refactoring-expert + system-architect + quality-engineer + security-engineer + technical-writer
```
- Security audit: security-engineer + quality-engineer + root-cause-analyst + technical-writer
- Performance investigation: performance-engineer + root-cause-analyst + system-architect + devops-architect
- Legacy assessment: refactoring-expert + system-architect + quality-engineer + security-engineer + technical-writer
**Communication Workflows**:
```bash
# Technical documentation (3-4 agents)
technical-writer + requirements-analyst + domain experts + learning-guide
# Educational content (3-4 agents)
learning-guide + technical-writer + frontend-architect + quality-engineer
```
- Technical documentation: technical-writer + requirements-analyst + domain experts + learning-guide
- Educational content: learning-guide + technical-writer + frontend-architect + quality-engineer
## Best Practices 💡
@@ -813,7 +785,7 @@ Add "documented", "explained", or "tutorial" to requests for automatic technical
**What Not to Worry About**:
- Manual agent selection or configuration
- Complex routing rules or agent management
- Agent performance tuning or optimization
- Agent configuration or coordination
- Micromanaging agent interactions
---
@@ -845,9 +817,9 @@ Start with natural language descriptions. Notice which agents activate and why.
Observe agent coordination patterns. Understand how complexity and domain keywords influence agent selection. Begin optimizing request phrasing for better coordination.
**Month 2+: Expert Coordination**
Master multi-domain requests that trigger optimal agent combinations. Leverage troubleshooting techniques for perfect agent selection. Use advanced patterns for complex workflows.
Master multi-domain requests that trigger optimal agent combinations. Leverage troubleshooting techniques for effective agent selection. Use advanced patterns for complex workflows.
**The SuperClaude Advantage:**
Experience the power of 13 specialized AI experts working in perfect coordination, all through simple, natural language requests. No configuration, no management, just intelligent collaboration that scales with your needs.
Experience the power of 13 specialized AI experts working in coordinated response, all through simple, natural language requests. No configuration, no management, just intelligent collaboration that scales with your needs.
🎯 **Ready to experience intelligent agent coordination? Start with `/sc:implement` and discover the magic of specialized AI collaboration.**

13
Docs/User-Guide/commands.md
View File

@@ -14,7 +14,7 @@ SuperClaude provides 21 commands for Claude Code: `/sc:*` commands for workflows
```bash
# Terminal: Verify installation
python3 -m SuperClaude --version
# Alternative: SuperClaude --version (if installed globally)
# Claude Code CLI verification: claude --version
# Claude Code: Test commands
/sc:brainstorm "test project" # Should ask discovery questions
@@ -74,12 +74,11 @@ SuperClaude provides behavioral context files that Claude Code reads to adopt sp
python3 -m SuperClaude --version
# Example output: SuperClaude 4.0.0
# Alternative version check (if installed globally)
SuperClaude --version
# Example output: SuperClaude 4.0.0
# Claude Code CLI version check
claude --version
# Check MCP server connectivity
SuperClaude install --list-components | grep mcp
# Check installed components
python3 -m SuperClaude install --list-components | grep mcp
# Example output: Shows installed MCP components
```
@@ -297,7 +296,7 @@ SuperClaude install --list-components | grep mcp
**Command Issues:**
- **Command not found**: Verify installation: `python3 -m SuperClaude --version`
- **No response**: Restart Claude Code session
- **Slow performance**: Use `--no-mcp` to test without MCP servers
- **Processing delays**: Use `--no-mcp` to test without MCP servers
**Quick Fixes:**
- Reset session: `/sc:load` to reinitialize

8
Docs/User-Guide/mcp-servers.md
View File

@@ -8,7 +8,7 @@ MCP (Model Context Protocol) servers extend Claude Code's capabilities through s
- **What MCP servers are**: External Node.js processes that provide additional tools
- **What they aren't**: Built-in SuperClaude functionality
- **How activation works**: Claude reads instructions to use appropriate servers based on context
- **Why they're powerful**: Real tools that extend Claude Code's native capabilities
- **What they provide**: Real tools that extend Claude Code's native capabilities
**Core Servers:**
- **context7**: Official library documentation and patterns
@@ -66,7 +66,7 @@ MCP (Model Context Protocol) servers extend Claude Code's capabilities through s
### magic ✨
**Purpose**: Modern UI component generation from 21st.dev patterns
**Triggers**: UI requests, `/ui` commands, component development
**Requirements**: Node.js 16+, TWENTYFIRST_API_KEY (⚠️ EXPERIMENTAL - verify service exists)
**Requirements**: Node.js 16+, TWENTYFIRST_API_KEY ()
```bash
# Automatic activation
@@ -94,7 +94,7 @@ export TWENTYFIRST_API_KEY="your_key_here"
### morphllm-fast-apply 🔄
**Purpose**: Efficient pattern-based code transformations
**Triggers**: Multi-file edits, refactoring, framework migrations
**Requirements**: Node.js 16+, MORPH_API_KEY (⚠️ EXPERIMENTAL - verify service exists)
**Requirements**: Node.js 16+, MORPH_API_KEY
```bash
# Automatic activation
@@ -261,7 +261,7 @@ echo 'export MORPH_API_KEY="your_key"' >> ~/.bashrc
**Essential Reading:**
- [Commands Guide](commands.md) - Commands that activate MCP servers
- [Quick Start Guide](../Getting-Started/quick-start.md) - First MCP experience
- [Quick Start Guide](../Getting-Started/quick-start.md) - MCP setup guide
**Advanced Usage:**
- [Behavioral Modes](modes.md) - Mode-MCP coordination

24
Docs/User-Guide/modes.md
View File

@@ -12,7 +12,7 @@ Test modes by using `/sc:` commands - they activate automatically based on task
| **📋 Task Management** | Complex coordination | >3 steps, >2 directories | Phase breakdown, memory persistence | Multi-step operations, project management |
| **🎯 Orchestration** | Intelligent tool selection | Multi-tool ops, high resource usage | Optimal tool routing, parallel execution | Complex analysis, performance optimization |
| **⚡ Token Efficiency** | Compressed communication | High context usage, `--uc` flag | Symbol systems, estimated 30-50% token reduction | Resource constraints, large operations |
| **🎨 Standard** | Balanced default | Simple tasks, no complexity triggers | Clear professional communication | General development, straightforward tasks |
---
@@ -172,7 +172,7 @@ Task Management Approach:
- **Intelligent Tool Routing**: Selects optimal MCP servers and native tools for each task type
- **Resource Awareness**: Adapts approach based on system constraints and availability
- **Parallel Optimization**: Identifies independent operations for concurrent execution
- **Performance Focus**: Maximizes speed and effectiveness through coordinated tool usage
- **Coordination Focus**: Optimizes tool selection and usage through coordinated execution
- **Adaptive Fallback**: Switches tools gracefully when preferred options are unavailable
**Example Experience:**
@@ -184,7 +184,7 @@ Orchestration Approach:
⚡ Phase 2: Morphllm (pattern edits) + Magic (UI components)
🧪 Phase 3: Playwright (testing) + Context7 (documentation patterns)
🔄 Parallel execution: 3 tools working simultaneously
📈 Efficiency gain: 60% faster than sequential approach"
\"
```
**Works Best With:**
@@ -209,7 +209,7 @@ Orchestration Approach:
- **Technical Abbreviation**: Context-aware compression for repeated technical terms
- **Structured Density**: Bullet points, tables, and concise formatting over verbose paragraphs
- **Information Preservation**: Maintains ≥95% information quality despite compression
- **Scannable Format**: Optimizes for quick comprehension and task completion
- **Structured Format**: Organized for clarity and task completion
**Example Experience:**
```
@@ -408,11 +408,11 @@ For troubleshooting help, see:
- [Common Issues](../Reference/common-issues.md) - Quick fixes for frequent problems
- [Troubleshooting Guide](../Reference/troubleshooting.md) - Comprehensive problem resolution
### Common Issues (< 2 minutes)
### Common Issues
- **Mode not activating**: Use manual flags: `--brainstorm`, `--introspect`, `--uc`
- **Wrong mode active**: Check complexity triggers and keywords in request
- **Mode switching unexpectedly**: Normal behavior based on task evolution
- **Performance impact**: Modes optimize performance, shouldn't slow execution
- **Execution impact**: Modes optimize tool usage, shouldn't affect execution
- **Mode conflicts**: Check flag priority rules in [Flags Guide](flags.md)
### Immediate Fixes
@@ -523,7 +523,7 @@ After applying mode fixes, test with:
- **Mode not activating** → Use manual flags: `--brainstorm`, `--introspect`, `--uc`
- **Wrong mode active** → Check complexity triggers and keywords in request
- **Mode switching unexpectedly** → Normal behavior based on task evolution
- **Performance impact** → Modes optimize performance, shouldn't slow execution
- **Execution impact** → Modes optimize tool usage, shouldn't affect execution
- **Mode conflicts** → Check flag priority rules in [Flags Guide](flags.md)
## Frequently Asked Questions
@@ -545,8 +545,8 @@ A: Yes, use manual flags to override automatic detection:
/sc:command --uc # Compress output
```
**Q: Do modes affect performance?**
A: Modes enhance performance through optimization:
**Q: Do modes affect execution?**
A: Modes optimize tool usage through coordination:
- **Token Efficiency**: 30-50% context reduction
- **Orchestration**: Parallel processing
- **Task Management**: Prevents rework through systematic planning
@@ -561,7 +561,7 @@ A: Yes, modes are designed to complement each other:
## Summary
SuperClaude's 6 behavioral modes create an **intelligent adaptation system** that matches your needs automatically:
SuperClaude's 5 behavioral modes create an **intelligent adaptation system** that matches your needs automatically:
- **🧠 Brainstorming**: Transforms vague ideas into clear requirements
- **🔍 Introspection**: Provides transparent reasoning for learning and debugging
@@ -579,7 +579,7 @@ SuperClaude's 6 behavioral modes create an **intelligent adaptation system** tha
**Learning Progression:**
**🌱 Essential (Week 1)**
- [Quick Start Guide](../Getting-Started/quick-start.md) - Experience modes naturally
- [Quick Start Guide](../Getting-Started/quick-start.md) - Mode activation examples
- [Commands Reference](commands.md) - Commands automatically activate modes
- [Installation Guide](../Getting-Started/installation.md) - Set up behavioral modes
@@ -591,7 +591,7 @@ SuperClaude's 6 behavioral modes create an **intelligent adaptation system** tha
**🌲 Advanced (Month 2+)**
- [MCP Servers](mcp-servers.md) - Mode integration with enhanced capabilities
- [Session Management](session-management.md) - Task Management mode workflows
- [Getting Started](../Getting-Started/quick-start.md) - Mode optimization strategies
- [Getting Started](../Getting-Started/quick-start.md) - Mode usage patterns
**🔧 Expert**
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Mode implementation details