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

docs: Transform documentation to emphasize simplicity and auto-activation

Browse Source 
Update all Docs/ guides to lead with "just start using it" approach while
keeping comprehensive information available. Key changes:

- Add prominent "Simple Truth" and "Just Start Here" sections
- Emphasize intelligent routing and auto-activation throughout
- Reframe detailed guides as optional curiosity rather than required study
- Use casual, humble developer tone with emojis for clarity
- Transform "learn first" to "discover through use" messaging
- Make auto-expert selection and flag activation prominent
- Remove any marketing language in favor of honest, straightforward content

Files updated: superclaude-user-guide.md, commands-guide.md, flags-guide.md,
personas-guide.md, installation-guide.md

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
2025-07-14 16:51:40 +02:00
parent 3bd577672a
commit f97f48244c
5 changed files with 349 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
Docs/superclaude-user-guide.md
View File

@@ -1,6 +1,28 @@
# SuperClaude User Guide 🚀
A comprehensive guide to understanding and using SuperClaude v3.0 effectively. This is your starting point for getting the most out of the framework.
## 🎯 The Simple Truth
**Behind the apparent complexity, SuperClaude is actually simple to use.**
You don't need to learn all the commands, flags, and personas. Just start using it! 🎈
SuperClaude has an **intelligent routing system** that figures out what you need automatically:
- Type `/analyze some-code/` → It picks the right analysis tools
- Ask about security → Security expert auto-activates
- Work on frontend → UI specialist takes over
- Debug something → Investigation mode kicks in
**Learning emerges during use** - you'll naturally discover what works without studying manuals first.
The detailed guides below? They're here **when you want to understand** what just happened or dive deeper. But honestly? Most of the time you can just wing it. 😊
---
**TL;DR**: Install it, try `/analyze` or `/build` on your code, watch the magic happen.
---
A comprehensive guide to understanding and using SuperClaude v3.0 effectively. But remember - you can skip straight to trying it out!
## Table of Contents 📖
@@ -18,43 +40,74 @@ A comprehensive guide to understanding and using SuperClaude v3.0 effectively. T
---
## 🚀 Just Start Here
**Want to skip the reading and jump right in?** Here's your 2-minute getting started:
```bash
# Try these commands in Claude Code:
/help # See what's available
/analyze README.md # SuperClaude analyzes your project
/build # Smart build with auto-optimization
/improve messy-file.js # Clean up code automatically
```
**What just happened?** SuperClaude automatically:
- Picked the right tools for each task 🛠️
- Activated appropriate experts (security, performance, etc.) 🎭
- Applied intelligent flags and optimizations ⚡
- Provided evidence-based suggestions 📊
**See how easy that was?** No studying required - SuperClaude figures out the complexity so you don't have to.
Want to understand how it works? Keep reading. Want to just keep experimenting? Go for it! 🎯
---
## Welcome & Overview 👋
### What is SuperClaude Really? 🤔
SuperClaude is an enhancement framework for Claude Code that adds specialized capabilities through commands, smart personas, and external integrations. Think of it as giving Claude a toolkit and some expert consultants to help with development work.
SuperClaude makes Claude Code smarter for development work. Instead of generic responses, you get specialized help from different experts (security, performance, frontend, etc.) who know their stuff.
**The honest truth**: We just released v3.0 and it's fresh out of beta. It works pretty well for what it does, but you should expect some rough edges as we continue improving things. We built this because we wanted Claude Code to be more helpful for real software development workflows.
**The magic part?** You don't need to manage any of this complexity. Just use normal commands like `/analyze` or `/build` and SuperClaude automatically figures out which experts to involve and what tools to use. 🪄
### What SuperClaude Adds ✨
**🛠️ 15 Specialized Commands**
**🛠️ 15 Specialized Commands** *(that auto-activate intelligently)*
- Development tools: `/build`, `/dev-setup`, `/design`
- Analysis tools: `/analyze`, `/review`, `/troubleshoot`
- Quality tools: `/improve`, `/scan`, `/test`
- Plus utilities for documentation, git, deployment, and more
- **You just use them** - SuperClaude handles the complexity automatically
**🎭 11 Smart Personas**
**🎭 11 Smart Personas** *(that know when to jump in)*
- AI specialists that adapt behavior for different domains
- Auto-activate based on your requests (security expert for security tasks, etc.)
- Manual control when you need a specific perspective
- **Auto-activate based on your requests** (security expert for security tasks, etc.)
- Manual control available, but usually not needed
- Think of it as having a whole dev team that knows when to help
**🔧 MCP Server Integration**
**🔧 MCP Server Integration** *(smart external tools)*
- Context7: Official library documentation lookup
- Sequential: Complex multi-step analysis
- Magic: Modern UI component generation
- Playwright: Browser automation and testing
- **Auto-connects when needed** - you don't manage this stuff
**📋 Enhanced Task Management**
**📋 Enhanced Task Management** *(happens behind the scenes)*
- Progress tracking with TodoRead/TodoWrite
- Multi-session project management with `/task`
- Complex orchestration with `/spawn`
- Iterative improvement with `/loop`
- **Mostly automatic** - SuperClaude tracks what you're doing
**⚡ Token Optimization**
**⚡ Token Optimization** *(smart efficiency)*
- Smart compression when context gets full
- Symbol system for efficient communication
- Performance optimization for large operations
- **Automatic activation** when needed for large projects
### Current Status (v3.0) 📊
@@ -78,26 +131,31 @@ We're pretty happy with v3 as a foundation, but there's definitely room for impr
### How It Works 🔄
SuperClaude enhances Claude Code through a combination of:
**The simple version**: You type something like `/analyze auth.js` and SuperClaude figures out the rest.
1. **Documentation-driven behavior** - Framework files guide Claude's responses
2. **Intelligent routing** - The orchestrator system decides which tools and personas to use
3. **Auto-activation** - Commands, flags, and personas activate based on context
4. **External integrations** - MCP servers provide specialized capabilities
5. **Quality gates** - Validation and optimization throughout the process
**The slightly more detailed version**:
The beauty is that most of this happens automatically. You make a request, SuperClaude figures out the best approach, and executes with appropriate tools and expertise.
1. **Smart routing** - Analyzes what you're asking for
2. **Auto-expert selection** - Picks the right specialist (security, performance, etc.)
3. **Tool coordination** - Connects to external systems when helpful
4. **Quality assurance** - Makes sure suggestions are solid
**You don't see any of this complexity** - it just feels like Claude got way smarter about development stuff.
The beauty is that most of this happens automatically. You make a request, SuperClaude figures out the best approach, and executes with appropriate tools and expertise. No configuration, no setup, no learning curve - just better results. ✨
### Quick Feature Overview 🎯
| Component | What It Does | Learn More |
| Component | What It Does | Learn More *(optional!)* |
|-----------|--------------|------------|
| **Commands** | 15 specialized tools for development tasks | [Commands Guide](commands-guide.md) |
| **Flags** | Modifiers that change command behavior | [Flags Guide](flags-guide.md) |
| **Personas** | 11 AI specialists for different domains | [Personas Guide](personas-guide.md) |
| **MCP Servers** | External integrations for docs, UI, testing | [This guide](#core-components-🧩) |
| **Modes** | 3 operational modes for different needs | [This guide](#the-three-operational-modes-🎭) |
| **Orchestrator** | Intelligent routing and optimization | [This guide](#the-orchestrator-system-🎯) |
| **Commands** | 15 specialized tools that auto-activate | [Commands Guide](commands-guide.md) |
| **Flags** | Modifiers that mostly activate automatically | [Flags Guide](flags-guide.md) |
| **Personas** | 11 AI specialists that know when to help | [Personas Guide](personas-guide.md) |
| **MCP Servers** | External integrations that connect when useful | [This guide](#core-components-🧩) |
| **Modes** | 3 operational modes for different workflows | [This guide](#the-three-operational-modes-🎭) |
| **Orchestrator** | The smart routing that makes it all work | [This guide](#the-orchestrator-system-🎯) |
**Remember**: You can use SuperClaude effectively without reading any of these guides. They're here when you get curious about how the magic works! 🎪
---