mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-18 02:06:36 +00:00
d5dfd7da21
* refactor(docs): rename directories to lowercase for PEP8 compliance - Developer-Guide → developer-guide - Getting-Started → getting-started - Reference → reference - Templates → templates - User-Guide → user-guide - User-Guide-jp → user-guide-jp - User-Guide-kr → user-guide-kr - User-Guide-zh → user-guide-zh This change aligns with Python PEP8 package naming conventions. All 43 files affected. * refactor: rename root documentation files to lowercase - CHANGELOG.md → changelog.md - CODE_OF_CONDUCT.md → code_of_conduct.md - CONTRIBUTING.md → contributing.md - SECURITY.md → security.md Aligns with Python package naming conventions (PEP8). README files remain uppercase as per convention. * refactor: move documentation files to docs/ for cleaner root Moved OSS standard files to docs/: - CHANGELOG.md → docs/CHANGELOG.md - CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md - CONTRIBUTING.md → docs/CONTRIBUTING.md - SECURITY.md → docs/SECURITY.md Root now contains only essential files: ✓ README files (表紙: en, ja, kr, zh) ✓ LICENSE (法的要件) ✓ Build configs (pyproject.toml, setup.py, MANIFEST.in) ✓ VERSION Rationale: Cleaner root structure following modern Python project conventions. All detailed documentation consolidated in docs/ directory. * refactor: update documentation links after restructure Auto-updated internal documentation links to reflect new structure: - docs/ subdirectories now lowercase (PEP8) - Root files moved to docs/ - All cross-references updated This commit includes linter-generated link updates. * chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY) * chore(docs): remove duplicated PR docs from repo root (moved under docs) * docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity * docs: update links to PM_AGENT.md after rename --------- Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
172 lines
8.1 KiB
Markdown
172 lines
8.1 KiB
Markdown
# SuperClaude Framework Developer Guide
|
|
|
|
A documentation suite for understanding and extending the SuperClaude Context-Oriented Configuration Framework.
|
|
|
|
## Documentation Overview
|
|
|
|
This Developer Guide provides documentation for understanding SuperClaude's context architecture and how to extend it:
|
|
|
|
### [Contributing Code Guide](contributing-code.md)
|
|
**Purpose**: Guidelines for contributing context files and framework improvements
|
|
**Audience**: Contributors and framework maintainers
|
|
**Key Topics**: Adding context files, naming conventions, documentation standards
|
|
|
|
### [Context Architecture Guide](technical-architecture.md)
|
|
**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
|
|
|
|
### [Verification & Troubleshooting Guide](testing-debugging.md)
|
|
**Purpose**: Verifying installation and troubleshooting context file issues
|
|
**Audience**: Users and maintainers
|
|
**Key Topics**: File verification, common issues, diagnostic commands
|
|
|
|
### [Documentation Index](documentation-index.md)
|
|
**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
|
|
|
|
## Quick Navigation
|
|
|
|
### For New Contributors
|
|
1. Start with [Contributing Code Guide](contributing-code.md#development-setup) for environment setup
|
|
2. Review [Technical Architecture Guide](technical-architecture.md#architecture-overview) for system understanding
|
|
3. Use [Testing & Debugging Guide](testing-debugging.md#quick-start-testing-tutorial) for testing basics
|
|
|
|
### For System Architects
|
|
1. Begin with [Technical Architecture Guide](technical-architecture.md) for complete system design
|
|
2. Reference [Contributing Code Guide](contributing-code.md#architecture-overview) for component patterns
|
|
3. Review [Testing & Debugging Guide](testing-debugging.md#integration-testing) for validation frameworks
|
|
|
|
### For Testing Engineers
|
|
1. Start with [Testing & Debugging Guide](testing-debugging.md) for comprehensive testing procedures
|
|
2. Reference [Contributing Code Guide](contributing-code.md#development-workflow) for development integration
|
|
3. Use [Technical Architecture Guide](technical-architecture.md#quality-framework) for architecture context
|
|
|
|
## Key Framework Concepts
|
|
|
|
### Context-Oriented Configuration
|
|
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.
|
|
|
|
### Agent Context Files
|
|
Specialized instruction sets that provide domain expertise when activated by `@agent-[name]` or automatically by keywords.
|
|
|
|
### Command Context Files
|
|
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.
|
|
|
|
### MCP Integration
|
|
External tools (actual software) that can be configured to provide additional capabilities like documentation lookup or code analysis.
|
|
|
|
## What SuperClaude Is NOT
|
|
|
|
- ❌ **Not Software**: No code executes, no processes run
|
|
- ❌ **Not Testable**: Context files are instructions, not functions
|
|
- ❌ **Not Optimizable**: No performance to measure or improve
|
|
- ❌ **Not Persistent**: Each Claude conversation is independent
|
|
|
|
## Documentation Features
|
|
|
|
### Cross-Referenced Integration
|
|
All three documents are strategically cross-referenced, enabling seamless navigation between development workflows, architectural understanding, and testing procedures.
|
|
|
|
### Accessibility & Inclusivity
|
|
- **Screen Reader Support**: Full navigation guidance and diagram descriptions
|
|
- **Skill Level Pathways**: Clear progression from beginner to advanced
|
|
- **Comprehensive Glossaries**: 240+ technical terms with detailed definitions
|
|
- **Learning Resources**: Time estimates and prerequisite guidance
|
|
|
|
### Consistent Terminology
|
|
Unified technical vocabulary ensures clear communication across all documentation, with key terms defined consistently throughout comprehensive glossaries.
|
|
|
|
### Comprehensive Code Examples
|
|
All code examples include proper documentation, error handling, and follow consistent formatting standards suitable for production use.
|
|
|
|
### Security-First Approach
|
|
Security considerations are embedded throughout all documentation, from development practices to testing procedures to architectural design.
|
|
|
|
### Professional Quality Standards
|
|
- **WCAG 2.1 Compliant**: Full accessibility standards compliance
|
|
- **Technical Accuracy**: All examples tested and verified
|
|
- **Framework Integration**: Documentation quality matches framework sophistication
|
|
- **Community Focus**: Inclusive design for developers of all abilities
|
|
|
|
## Document Status
|
|
|
|
✅ **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
|
|
|
|
### Accessibility & Quality Enhancements (Phase 4)
|
|
- **240+ Glossary Terms**: Comprehensive technical definitions across all documents
|
|
- **Screen Reader Support**: Full accessibility with navigation guidance and diagram descriptions
|
|
- **Skill Level Pathways**: Clear learning progressions from beginner to advanced
|
|
- **Professional Polish**: Documentation quality aligned with framework sophistication
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
- Python 3.8+ (for installation tool)
|
|
- Claude Code installed
|
|
- Optional: Node.js 16+ for MCP servers
|
|
|
|
### Understanding the Framework
|
|
```bash
|
|
# 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
|
|
```
|
|
|
|
### Extending SuperClaude
|
|
1. **Add Commands**: Create new `.md` files in `~/.claude/commands/`
|
|
2. **Add Agents**: Create new `.md` files in `~/.claude/agents/`
|
|
3. **Add Modes**: Create new `.md` files in `~/.claude/modes/`
|
|
|
|
No compilation, no testing, no deployment - just add context files and Claude Code will read them automatically.
|
|
|
|
## Support and Resources
|
|
|
|
### Documentation Issues
|
|
- **Broken Links**: Report cross-reference issues in GitHub issues
|
|
- **Unclear Content**: Request clarification through GitHub discussions
|
|
- **Missing Information**: Suggest improvements through pull requests
|
|
|
|
### Development Support
|
|
- **Technical Questions**: Use GitHub discussions for architecture and implementation questions
|
|
- **Bug Reports**: Submit detailed issues with reproduction steps
|
|
- **Feature Requests**: Propose enhancements through GitHub issues
|
|
|
|
### Community Resources
|
|
- **[GitHub Repository](https://github.com/SuperClaude-Org/SuperClaude_Framework)**: Main development and collaboration hub
|
|
|
|
## Contributing to Documentation
|
|
|
|
We welcome contributions to improve documentation quality, accuracy, and completeness:
|
|
|
|
### Documentation Standards
|
|
- **Clarity**: Write for your target audience skill level
|
|
- **Consistency**: Follow established terminology and formatting
|
|
- **Completeness**: Provide working examples and complete procedures
|
|
- **Cross-References**: Link related concepts across documents
|
|
|
|
### Submission Process
|
|
1. Fork the repository and create a feature branch
|
|
2. Make documentation improvements following our standards
|
|
3. Test all code examples and verify cross-references
|
|
4. Submit pull request with clear description of changes
|
|
|
|
---
|
|
|
|
**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](https://github.com/SuperClaude-Org/SuperClaude_Framework). |