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

109
Docs/commands-guide.md
View File

@@ -1,36 +1,71 @@
# SuperClaude Commands Guide 🛠️
## 💡 Don't Overthink It - SuperClaude Picks the Right Tools
**The truth about these 15 commands**: You don't need to memorize them. Just start with `/analyze` or `/build` and let SuperClaude figure out the rest!
**Here's how it actually works:**
- Type `/` in Claude Code → See available commands
- Use basic ones like `/analyze`, `/build`, `/improve`
- **SuperClaude automatically picks the best tools and experts** for each situation
- More commands become useful as you get comfortable
**Auto-activation is the secret sauce** 🪄 - SuperClaude detects what you're trying to do and activates the right specialists (security expert, performance optimizer, etc.) without you managing any of it.
---
## Quick "Just Try These" List 🚀
**Start here** (no reading required):
```bash
/help # See what's available
/analyze src/ # Smart analysis of your code
/build # Intelligent project building
/improve messy-file.js # Clean up code automatically
/troubleshoot "error" # Get help with problems
```
**That's honestly enough to get started.** Everything else below is here when you get curious about what other tools are available.
---
A practical guide to all 15 SuperClaude slash commands. We'll be honest about what works well and what's still rough around the edges.
## Quick Reference 📋
| Command | Purpose | Best For |
|---------|---------|----------|
| `/analyze` | Code analysis | Finding issues, understanding codebases |
| `/build` | Project building | Compilation, bundling, deployment prep |
| `/cleanup` | Technical debt | Removing dead code, organizing files |
| `/design` | System design | Architecture planning, API design |
| `/document` | Documentation | README files, code comments, guides |
| `/estimate` | Project estimation | Time/effort planning, complexity analysis |
| `/explain` | Educational help | Learning concepts, understanding code |
| `/git` | Git operations | Smart commits, branch management |
| `/improve` | Code enhancement | Refactoring, optimization, quality fixes |
| `/index` | Command help | Finding the right command for your task |
| `/load` | Context loading | Project analysis, codebase understanding |
| `/spawn` | Complex orchestration | Multi-step operations, workflow automation |
| `/task` | Project management | Long-term feature planning, task tracking |
| `/test` | Testing | Running tests, coverage analysis |
| `/troubleshoot` | Problem solving | Debugging, issue investigation |
*(You really don't need to memorize this - just pick what sounds useful)*
| Command | Purpose | Auto-Activates | Best For |
|---------|---------|-----------------|----------|
| `/analyze` | Smart code analysis | Security/performance experts | Finding issues, understanding codebases |
| `/build` | Intelligent building | Frontend/backend specialists | Compilation, bundling, deployment prep |
| `/improve` | Automatic code cleanup | Quality experts | Refactoring, optimization, quality fixes |
| `/troubleshoot` | Problem investigation | Debug specialists | Debugging, issue investigation |
| `/test` | Smart testing | QA experts | Running tests, coverage analysis |
| `/document` | Auto documentation | Writing specialists | README files, code comments, guides |
| `/git` | Enhanced git workflows | DevOps specialists | Smart commits, branch management |
| `/design` | System design help | Architecture experts | Architecture planning, API design |
| `/explain` | Learning assistant | Teaching specialists | Learning concepts, understanding code |
| `/cleanup` | Debt reduction | Refactoring experts | Removing dead code, organizing files |
| `/scan` | Security/quality scans | Security experts | Vulnerability detection, compliance |
| `/load` | Context understanding | Analysis experts | Project analysis, codebase understanding |
| `/estimate` | Smart estimation | Planning experts | Time/effort planning, complexity analysis |
| `/spawn` | Complex workflows | Orchestration system | Multi-step operations, workflow automation |
| `/task` | Project management | Planning system | Long-term feature planning, task tracking |
**Pro tip**: Just try the ones that sound useful. SuperClaude will automatically activate the right experts and tools for each situation! 🎯
## Development Commands 🔨
### `/build` - Project Building
**What it does**: Builds, compiles, and packages projects with smart error handling.
**The easy way**: Just type `/build` and SuperClaude figures out your build system automatically! 🎯
**When to use it**:
- You need to compile/bundle your project
- Build process is failing and you want help debugging
- Setting up build optimization
- You need to compile/bundle your project (just try `/build`)
- Build process is failing and you want help debugging
- Setting up build optimization (it auto-detects what you need)
- Preparing for deployment
**Basic syntax**:
@@ -97,14 +132,16 @@ A practical guide to all 15 SuperClaude slash commands. We'll be honest about wh
## Analysis Commands 🔍
### `/analyze` - Code Analysis
### `/analyze` - Code Analysis
**What it does**: Comprehensive analysis of code quality, security, performance, and architecture.
**The magic**: SuperClaude automatically detects what kind of analysis you need and activates the right experts! 🔍
**When to use it**:
- Understanding unfamiliar codebases
- Finding security vulnerabilities
- Performance bottleneck hunting
- Code quality assessment
- Understanding unfamiliar codebases (just point it at any folder)
- Finding security vulnerabilities (security expert auto-activates)
- Performance bottleneck hunting (performance expert jumps in)
- Code quality assessment (quality specialist takes over)
**Basic syntax**:
```bash
@@ -634,24 +671,30 @@ A practical guide to all 15 SuperClaude slash commands. We'll be honest about wh
## Final Notes 📝
**Remember:**
- Commands work best when you're specific about what you want
- Use `--preview` and `--safe` flags liberally
- Start small (single files) before running on entire projects
- These commands enhance your workflow, they don't replace understanding your tools
**The real truth about these commands** 💯:
- **Just try them** - You don't need to study this guide first
- **Start with the basics** - `/analyze`, `/build`, `/improve` cover most needs
- **Let auto-activation work** - SuperClaude picks the right experts automatically
- **Experiment freely** - Use `--preview` if you want to see what would happen first
**Still rough around the edges:**
- Complex orchestration (spawn, task) may not work perfectly
- Some analysis depends heavily on your project setup
- Some analysis depends heavily on your project setup
- Error handling could be better in some commands
**Getting better all the time:**
- We actively improve commands based on user feedback
- Newer commands (analyze, improve) tend to work better
- Documentation and examples are constantly being updated
- Auto-activation keeps getting smarter
**Don't stress about memorizing this** 🧘‍♂️
- SuperClaude is designed to be discoverable through use
- Type `/` to see available commands
- Commands suggest what they can do when you use `--help`
- The intelligent routing handles most of the complexity
**Need help?** Check the GitHub issues or create a new one if you're stuck! 🚀
---
*Happy coding! We hope these commands make your development workflow a bit smoother. 🙂*
*Happy coding! Just remember - you can skip most of this guide and learn by doing. 🎯*