mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
📚 Major documentation cleanup: Fix CLI confusion and streamline content
## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
@@ -1,30 +1,7 @@
|
||||
# SuperClaude Behavioral Modes Guide 🧠
|
||||
|
||||
## ✅ Verification Status
|
||||
- **SuperClaude Version**: v4.0+ Compatible
|
||||
- **Last Tested**: 2025-01-16
|
||||
- **Test Environment**: Linux/Windows/macOS
|
||||
- **Mode Activation**: ✅ All Verified
|
||||
|
||||
## 🧪 Testing Mode Activation
|
||||
|
||||
Before using this guide, verify modes activate correctly:
|
||||
|
||||
```bash
|
||||
# Test Brainstorming mode
|
||||
/sc:brainstorm "vague project idea"
|
||||
# Expected: Should ask discovery questions, not give immediate solutions
|
||||
|
||||
# Test Task Management mode
|
||||
/sc:implement "complex multi-file feature"
|
||||
# Expected: Should break down into phases and coordinate steps
|
||||
|
||||
# Test Token Efficiency mode
|
||||
/sc:analyze large-project/ --uc
|
||||
# Expected: Should use symbols and compressed output format
|
||||
```
|
||||
|
||||
**If tests fail**: Modes activate automatically based on request complexity - check behavior patterns below
|
||||
## ✅ Quick Verification
|
||||
Test modes by using `/sc:` commands - they activate automatically based on task complexity. For full command reference, see [Commands Guide](commands.md).
|
||||
|
||||
## Quick Reference Table
|
||||
|
||||
@@ -33,15 +10,15 @@ Before using this guide, verify modes activate correctly:
|
||||
| **🧠 Brainstorming** | Interactive discovery | "brainstorm", "maybe", vague requests | Socratic questions, requirement elicitation | New project planning, unclear requirements |
|
||||
| **🔍 Introspection** | Meta-cognitive analysis | Error recovery, "analyze reasoning" | Transparent thinking markers (🤔, 🎯, 💡) | Debugging, learning, optimization |
|
||||
| **📋 Task Management** | Complex coordination | >3 steps, >2 directories | Phase breakdown, memory persistence | Multi-step operations, project management |
|
||||
| **🎯 Orchestration** | Intelligent tool selection | Multi-tool ops, >75% resources | Optimal tool routing, parallel execution | Complex analysis, performance optimization |
|
||||
| **⚡ Token Efficiency** | Compressed communication | >75% context usage, `--uc` flag | Symbol systems, 30-50% token reduction | Resource constraints, large operations |
|
||||
| **🎯 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 |
|
||||
|
||||
---
|
||||
|
||||
## Getting Started (2-Minute Overview)
|
||||
|
||||
**Modes activate automatically** - you don't need to think about them. They adapt Claude Code's behavior based on your task complexity and context.
|
||||
**Modes activate through behavioral instructions** - Claude Code reads context files to determine which mode behaviors to adopt based on your task patterns and complexity.
|
||||
|
||||
**Quick Examples:**
|
||||
```bash
|
||||
@@ -187,7 +164,7 @@ Task Management Approach:
|
||||
|
||||
**Auto-Activation Triggers:**
|
||||
- Multi-tool operations requiring sophisticated coordination
|
||||
- Performance constraints (>75% resource usage)
|
||||
- Performance constraints (high resource usage)
|
||||
- Parallel execution opportunities (>3 independent files/operations)
|
||||
- Complex routing decisions with multiple valid tool approaches
|
||||
|
||||
@@ -219,10 +196,10 @@ Orchestration Approach:
|
||||
|
||||
### ⚡ Token Efficiency Mode - Compressed Communication
|
||||
|
||||
**Purpose**: Achieve 30-50% token reduction through symbol systems while preserving information quality.
|
||||
**Purpose**: Achieve estimated 30-50% token reduction through symbol systems while preserving information quality.
|
||||
|
||||
**Auto-Activation Triggers:**
|
||||
- Context usage >75% approaching limits
|
||||
- High context usage approaching limits
|
||||
- Large-scale operations requiring resource efficiency
|
||||
- User explicit flags: `--uc`, `--ultracompressed`
|
||||
- Complex analysis workflows with multiple outputs
|
||||
@@ -331,7 +308,7 @@ Standard Approach: Consistent, professional baseline for all tasks
|
||||
|
||||
**When Modes Activate:**
|
||||
1. **Complexity Threshold**: >3 files → Task Management
|
||||
2. **Resource Pressure**: >75% usage → Token Efficiency
|
||||
2. **Resource Pressure**: High context usage → Token Efficiency
|
||||
3. **Multi-Tool Need**: Complex analysis → Orchestration
|
||||
4. **Uncertainty**: Vague requirements → Brainstorming
|
||||
5. **Error Recovery**: Problems → Introspection
|
||||
@@ -405,7 +382,7 @@ Standard Approach: Consistent, professional baseline for all tasks
|
||||
| **Complex Scope** | >3 files or >2 directories | 📋 Task Management | Phase coordination |
|
||||
| **Multi-Tool Need** | Analysis + Implementation | 🎯 Orchestration | Tool optimization |
|
||||
| **Error Recovery** | "This isn't working as expected" | 🔍 Introspection | Transparent reasoning |
|
||||
| **Resource Pressure** | >75% context usage | ⚡ Token Efficiency | Symbol compression |
|
||||
| **Resource Pressure** | High context usage | ⚡ Token Efficiency | Symbol compression |
|
||||
| **Simple Task** | "Fix this function" | 🎨 Standard | Clear, direct approach |
|
||||
|
||||
### Manual Override Commands
|
||||
@@ -425,7 +402,11 @@ Standard Approach: Consistent, professional baseline for all tasks
|
||||
|
||||
---
|
||||
|
||||
## 🚨 Quick Troubleshooting
|
||||
## Troubleshooting
|
||||
|
||||
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)
|
||||
- **Mode not activating**: Use manual flags: `--brainstorm`, `--introspect`, `--uc`
|
||||
@@ -610,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
|
||||
- [Best Practices](../Reference/quick-start-practices.md) - Mode optimization strategies
|
||||
- [Getting Started](../Getting-Started/quick-start.md) - Mode optimization strategies
|
||||
|
||||
**🔧 Expert**
|
||||
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Mode implementation details
|
||||
@@ -620,4 +601,4 @@ SuperClaude's 6 behavioral modes create an **intelligent adaptation system** tha
|
||||
- **Brainstorming**: [Requirements Discovery Patterns](../Reference/examples-cookbook.md#requirements)
|
||||
- **Task Management**: [Session Management Guide](session-management.md)
|
||||
- **Orchestration**: [MCP Servers Guide](mcp-servers.md)
|
||||
- **Token Efficiency**: [Performance Optimization](../Reference/quick-start-practices.md#efficiency)
|
||||
- **Token Efficiency**: [Command Fundamentals](commands.md#token-efficiency)
|
||||
Reference in New Issue
Block a user