cexll/myclaude
1
0
Fork 0
mirror of https://github.com/cexll/myclaude.git synced 2026-02-14 03:31:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Optimize README structure - Solution A (modular)

Browse Source 
- Reduced main README from 290 to 114 lines (English & Chinese)
- Created docs/ directory with 6 comprehensive guides:
  - BMAD-WORKFLOW.md: Complete agile methodology
  - REQUIREMENTS-WORKFLOW.md: Lightweight workflow
  - DEVELOPMENT-COMMANDS.md: Command reference
  - PLUGIN-SYSTEM.md: Installation guide
  - QUICK-START.md: 5-minute tutorial
  - ADVANCED-AGENTS.md: GPT-5 integration

- Main README now focuses on:
  - Quick start (3-step installation)
  - Plugin module overview (table format)
  - Use cases (clear scenarios)
  - Key features (concise bullets)
  - Links to detailed documentation

- Follows Claude Code plugin style
- Improved readability and navigation
- Separated concerns by functionality

Fixes #13

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
swe-agent[bot]
2025-10-20 07:24:53 +00:00
parent 5b1190f8a3
commit 9dea5d37ef
8 changed files with 2004 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files

301
README.md
View File

@@ -2,288 +2,113 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Claude Code](https://img.shields.io/badge/Claude-Code-blue)](https://claude.ai/code)
[![Version](https://img.shields.io/badge/Version-3.2-green)](https://github.com/)
[![Version](https://img.shields.io/badge/Version-3.2-green)](https://github.com/cexll/myclaude)
[![Plugin Ready](https://img.shields.io/badge/Plugin-Ready-purple)](https://docs.claude.com/en/docs/claude-code/plugins)
> Enterprise-grade agile development workflow automation with multi-agent orchestration
> Enterprise-grade agile development automation with AI-powered multi-agent orchestration
[中文](README-zh.md)
## 🚀 BMAD Methodology: Agile Development Automation
**BMAD (Business-Minded Agile Development)** transforms your development process into a fully automated agile workflow with role-based AI agents and quality gates.
### One Command, Complete Workflow
```bash
/bmad-pilot "Build e-commerce checkout system with payment integration"
# Automated: Product → Architecture → Sprint → Dev → Review → QA
```
## 🎯 BMAD Workflow Architecture
```mermaid
graph LR
PO[Product Owner] -->|PRD 90+| Architect
Architect -->|Design 90+| SM[Scrum Master]
SM -->|Sprint Plan| Dev
Dev -->|Code| Review
Review -->|Pass/Fail| QA
QA -->|Tests| Done
```
### Key Features
- **🤖 6 Specialized Agents**: PO, Architect, SM, Dev, Review, QA
- **📊 Quality Gates**: 90% thresholds with automatic optimization
- **✅ Approval Points**: User confirmation at critical phases
- **📁 Persistent Artifacts**: All documents saved to `./.claude/specs/`
- **🔄 Iterative Refinement**: Automatic improvement until quality met
## 📋 BMAD Agents & Roles
| Agent | Role | Quality Gate | Output |
|-------|------|--------------|--------|
| **bmad-po** (Sarah) | Product requirements gathering | 90/100 PRD score | `01-product-requirements.md` |
| **bmad-architect** (Winston) | Technical design & architecture | 90/100 design score | `02-system-architecture.md` |
| **bmad-sm** (Mike) | Sprint planning & task breakdown | User approval | `03-sprint-plan.md` |
| **bmad-dev** (Alex) | Feature implementation | Code completion | Implementation files |
| **bmad-review** | Independent code review | Pass/Risk/Fail | `04-dev-reviewed.md` |
| **bmad-qa** (Emma) | Testing & quality assurance | Test execution | `05-qa-report.md` |
[中文文档](README_CN.md) | [Documentation](docs/)
## 🚀 Quick Start
### Installation Methods
#### Method 1: Plugin System (Recommended) 🎯
### Installation
**Plugin System (Recommended)**
```bash
# List available plugins
/plugin github.com/cexll/myclaude
```
#### Method 2: Traditional Installation
**Traditional Installation**
```bash
# Clone the repository
git clone https://github.com/your-repo/claude-code-workflows.git
cd claude-code-workflows
# Install everything with make
git clone https://github.com/cexll/myclaude.git
cd myclaude
make install
# Or deploy specific workflows
make deploy-bmad # Deploy BMAD workflow only
make deploy-requirements # Deploy Requirements workflow only
make deploy-all # Deploy all commands and agents
```
### Basic BMAD Workflow
### Basic Usage
```bash
# Full agile workflow with all phases
/bmad-pilot "User authentication system with OAuth2 and MFA"
# Full agile workflow
/bmad-pilot "Build user authentication with OAuth2 and MFA"
# Skip testing for quick prototypes
/bmad-pilot "Admin dashboard" --skip-tests
# Lightweight development
/requirements-pilot "Implement JWT token refresh"
# Direct development (skip sprint planning)
/bmad-pilot "Bug fix for login issue" --direct-dev
# Skip repository scanning (use existing context)
/bmad-pilot "Add feature" --skip-scan
# Direct development commands
/code "Add API rate limiting"
```
### Workflow Artifacts
## 📦 Plugin Modules
Each BMAD run creates structured documentation:
| Plugin | Description | Key Commands |
|--------|-------------|--------------|
| **[bmad-agile-workflow](docs/BMAD-WORKFLOW.md)** | Complete BMAD methodology with 6 specialized agents | `/bmad-pilot` |
| **[requirements-driven-workflow](docs/REQUIREMENTS-WORKFLOW.md)** | Streamlined requirements-to-code workflow | `/requirements-pilot` |
| **[development-essentials](docs/DEVELOPMENT-COMMANDS.md)** | Core development slash commands | `/code` `/debug` `/test` `/optimize` |
| **[advanced-ai-agents](docs/ADVANCED-AGENTS.md)** | GPT-5 deep reasoning integration | Agent: `gpt5` |
```
.claude/specs/user-authentication/
├── 00-repository-context.md # Repository analysis
├── 01-product-requirements.md # PRD with business goals
├── 02-system-architecture.md # Technical design
├── 03-sprint-plan.md # Sprint tasks
├── 04-dev-reviewed.md # Code review report (NEW v3.1)
└── 05-qa-report.md # Test results
```
## 💡 Use Cases
## 🎨 BMAD Output Style
**BMAD Workflow** - Full agile process automation
- Product requirements → Architecture design → Sprint planning → Development → Code review → QA testing
- Quality gates with 90% thresholds
- Automated document generation
The BMAD workflow uses a specialized output style that:
- Creates phase-separated contexts
- Manages agent handoffs
- Tracks quality scores
- Handles approval gates
- Supports Codex CLI integration
**Requirements Workflow** - Fast prototyping
- Requirements generation → Implementation → Review → Testing
- Lightweight and practical
## ⚡ v3.2 Plugin System
**Development Commands** - Daily coding
- Direct implementation, debugging, testing, optimization
- No workflow overhead
### 🔌 Native Plugin Support (NEW)
This project now includes native Claude Code plugin support with 4 ready-to-use plugin packages:
## 🎯 Key Features
#### Available Plugins
- **🤖 Role-Based Agents**: Specialized AI agents for each development phase
- **📊 Quality Gates**: Automatic quality scoring with iterative refinement
- **✅ Approval Points**: User confirmation at critical workflow stages
- **📁 Persistent Artifacts**: All specs saved to `.claude/specs/`
- **🔌 Plugin System**: Native Claude Code plugin support
- **🔄 Flexible Workflows**: Choose full agile or lightweight development
| Plugin | Description | Commands | Agents |
|--------|------------|----------|--------|
| **bmad-agile-workflow** | Full BMAD methodology with role-based agents | `/bmad-pilot` | bmad-po, bmad-architect, bmad-sm, bmad-dev, bmad-qa |
| **requirements-driven-development** | Streamlined requirements workflow | `/requirements-pilot` | requirements-generate, requirements-code, requirements-review |
| **development-essentials** | Core development commands | `/code`, `/debug`, `/test`, `/optimize` | code, bugfix, debug, develop |
| **advanced-ai-agents** | GPT-5 deep analysis integration | - | gpt5 |
## 📚 Documentation
#### Using Plugins
- **[BMAD Workflow Guide](docs/BMAD-WORKFLOW.md)** - Complete methodology and agent roles
- **[Requirements Workflow](docs/REQUIREMENTS-WORKFLOW.md)** - Lightweight development process
- **[Development Commands](docs/DEVELOPMENT-COMMANDS.md)** - Slash command reference
- **[Plugin System](docs/PLUGIN-SYSTEM.md)** - Installation and configuration
- **[Quick Start Guide](docs/QUICK-START.md)** - Get started in 5 minutes
## 🛠️ Installation Methods
**Method 1: Plugin Install** (One command)
```bash
# List all available plugins
/plugin list
# Get detailed information about a plugin
/plugin info bmad-agile-workflow
# Install a plugin to activate its commands and agents
/plugin install requirements-driven-development
# Remove an installed plugin
/plugin remove development-essentials
/plugin install bmad-agile-workflow
```
#### Plugin Configuration
Plugins are defined in `.claude-plugin/marketplace.json` following the Claude Code plugin specification. Each plugin includes:
- Commands (slash commands)
- Agents (specialized AI agents)
- Metadata (version, author, keywords)
- Category classification
## ⚡ v3.1 Features
### Independent Code Review Agent
- **bmad-review**: Automated review between Dev and QA
- **Dual Version Support**:
- Standard: Native Claude Code review
- Enhanced: GPT-5 via Codex CLI
- **Three-tier Status**: Pass / Pass with Risk / Fail
### Enhanced Workflow
- Dev → Review → QA quality chain
- Automatic Sprint plan updates
- Targeted QA test recommendations
## 📊 Quality Scoring Systems
### PRD Quality (100 points)
- Business Value: 30
- Functional Requirements: 25
- User Experience: 20
- Technical Constraints: 15
- Scope & Priorities: 10
### Architecture Quality (100 points)
- Design Quality: 30
- Technology Selection: 25
- Scalability: 20
- Security: 15
- Feasibility: 10
### Review Status
- **Pass**: No issues, proceed to QA
- **Pass with Risk**: Non-critical issues
- **Fail**: Must return to Dev
## 🔧 Advanced Usage
### Repository Context
BMAD automatically scans your repository to understand:
- Technology stack
- Project structure
- Existing patterns
- Dependencies
- Conventions
### Interactive Refinement
Each phase supports iterative improvement:
```
PO: "Here's the PRD (Score: 75/100)"
User: "Add mobile support and offline mode"
PO: "Updated PRD (Score: 92/100) ✅"
```
### Approval Gates
Critical phases require explicit confirmation:
```
Architect: "Technical design complete (Score: 93/100)"
System: "Ready to proceed? (yes/no)"
User: yes
```
---
## 🏭 Requirements-Driven Workflow
An alternative lightweight workflow for simpler projects:
**Method 2: Make Commands** (Selective installation)
```bash
/requirements-pilot "Implement JWT authentication"
# Automated: Requirements → Code → Review → Test
make deploy-bmad # BMAD workflow only
make deploy-requirements # Requirements workflow only
make deploy-all # Everything
```
### Features
- 90% quality gates
- Automatic optimization loops
- Implementation-focused specs
- Pragmatic over architectural
**Method 3: Manual Setup**
- Copy `/commands/*.md` to `~/.config/claude/commands/`
- Copy `/agents/*.md` to `~/.config/claude/agents/`
## 🛠️ Other Commands
### Development Commands
- `/ask` - Technical consultation
- `/code` - Direct implementation
- `/debug` - Systematic debugging
- `/test` - Testing strategies
- `/review` - Code validation
- `/optimize` - Performance tuning
- `/bugfix` - Bug resolution
- `/refactor` - Code improvement
- `/docs` - Documentation
- `/think` - Advanced analysis
### Manual Workflow Example
```bash
/ask "Design patterns for real-time messaging"
/code "Implement WebSocket server"
/test "Create integration tests"
/review "Validate security"
```
Run `make help` for all options.
## 📄 License
MIT License - see [LICENSE](LICENSE) file
MIT License - see [LICENSE](LICENSE)
## 🙋 Support
- **Documentation**: Check `/commands/` and `/agents/` directories
- **Plugin Guide**: See [PLUGIN_README.md](PLUGIN_README.md) for plugin system details
- **Issues**: GitHub issues for bugs and features
- **Makefile Help**: Run `make help` for all deployment options
- **Claude Code Docs**: [Plugin System](https://docs.claude.com/en/docs/claude-code/plugins)
### Available Make Commands
```bash
make install # Install everything to Claude Code
make deploy-bmad # Deploy BMAD workflow only
make deploy-requirements # Deploy Requirements workflow only
make deploy-commands # Deploy all slash commands
make deploy-agents # Deploy all agent configurations
make test-bmad # Test BMAD workflow sample
make test-requirements # Test Requirements workflow sample
make clean # Clean generated artifacts
make help # Show all available commands
```
- **Issues**: [GitHub Issues](https://github.com/cexll/myclaude/issues)
- **Documentation**: [docs/](docs/)
- **Plugin Guide**: [PLUGIN_README.md](PLUGIN_README.md)
---
**Transform your development with BMAD** - One command, complete agile workflow, quality assured.
*Install with `/plugin install bmad-agile-workflow` or use traditional installation methods.*
*Let specialized AI agents handle specialized work.*
**Transform your development with AI-powered automation** - One command, complete workflow, quality assured.