docs/developer-guide/README.md
A documentation suite for understanding and extending the SuperClaude Context-Oriented Configuration Framework.
This Developer Guide provides documentation for understanding SuperClaude's context architecture and how to extend it:
Purpose: Guidelines for contributing context files and framework improvements
Audience: Contributors and framework maintainers
Key Topics: Adding context files, naming conventions, documentation standards
Purpose: Understanding how context files work and are structured
Audience: Anyone wanting to understand or extend SuperClaude
Key Topics: Context file structure, import system, agent/command patterns
Purpose: Verifying installation and troubleshooting context file issues
Audience: Users and maintainers
Key Topics: File verification, common issues, diagnostic commands
Purpose: Comprehensive navigation guide and topic-based organization
Audience: All users seeking efficient information discovery
Key Features: Skill level pathways, cross-references, quality validation, usage guidelines
SuperClaude is a collection of .md instruction files that Claude Code reads to modify its behavior. It is NOT executing software.
IMPORTANT: SuperClaude is NOT a CLI tool or executable software. When you see /sc: commands in documentation, these are context trigger patterns you type in Claude Code conversations, not terminal commands.
Specialized instruction sets that provide domain expertise when activated by @agent-[name] or automatically by keywords.
Workflow patterns triggered by /sc:[command] context patterns (not CLI commands) that guide Claude Code through structured development tasks when you type them in Claude Code conversations.
External tools (actual software) that can be configured to provide additional capabilities like documentation lookup or code analysis.
All three documents are strategically cross-referenced, enabling seamless navigation between development workflows, architectural understanding, and testing procedures.
Unified technical vocabulary ensures clear communication across all documentation, with key terms defined consistently throughout comprehensive glossaries.
All code examples include proper documentation, error handling, and follow consistent formatting standards suitable for production use.
Security considerations are embedded throughout all documentation, from development practices to testing procedures to architectural design.
✅ Phase 1 Complete: Critical issues resolved, basic structure established
✅ Phase 2 Complete: Cross-document consistency, navigation improvements, security integration
✅ Phase 3 Complete: Advanced examples, visual diagrams, enhanced architecture documentation
✅ Phase 4 Complete: Accessibility improvements, comprehensive glossaries, skill level guidance, professional polish
# Check installation
ls ~/.claude/
# You'll see context files, not executable code
# View a command context
cat ~/.claude/commands/implement.md
# You'll see instructions for Claude, not code
# View an agent context
cat ~/.claude/agents/python-expert.md
# You'll see expertise definitions, not programs
.md files in ~/.claude/commands/.md files in ~/.claude/agents/.md files in ~/.claude/modes/No compilation, no testing, no deployment - just add context files and Claude Code will read them automatically.
We welcome contributions to improve documentation quality, accuracy, and completeness:
SuperClaude Framework: Building the future of AI-assisted development through intelligent orchestration and behavioral programming.
For the latest updates and community discussions, visit our GitHub repository.