myaidev-method 0.2.2 → 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/mcp/mcp-config.json +93 -10
- package/.claude/mcp/sparc-orchestrator-server.js +607 -0
- package/DEV_WORKFLOW_GUIDE.md +1353 -0
- package/MCP_INTEGRATION.md +373 -0
- package/README.md +378 -21
- package/bin/cli.js +39 -1
- package/dist/mcp/mcp-config.json +93 -10
- package/dist/mcp/sparc-orchestrator-server.js +607 -0
- package/package.json +22 -3
- package/src/lib/dev-workflow/agent-types.js +163 -0
- package/src/lib/dev-workflow/sparc-workflow.js +302 -0
- package/src/lib/dev-workflow/task-manager.js +313 -0
- package/src/scripts/dev-architect.js +99 -0
- package/src/scripts/dev-code.js +106 -0
- package/src/scripts/dev-docs.js +122 -0
- package/src/scripts/dev-review.js +117 -0
- package/src/scripts/dev-test.js +115 -0
- package/src/scripts/sparc-workflow.js +187 -0
- package/src/templates/claude/agents/dev-architect.md +436 -0
- package/src/templates/claude/agents/dev-coder.md +749 -0
- package/src/templates/claude/agents/dev-documenter.md +939 -0
- package/src/templates/claude/agents/dev-reviewer.md +1152 -0
- package/src/templates/claude/agents/dev-tester.md +600 -0
- package/src/templates/claude/commands/myai-dev-architect.md +80 -0
- package/src/templates/claude/commands/myai-dev-code.md +93 -0
- package/src/templates/claude/commands/myai-dev-docs.md +94 -0
- package/src/templates/claude/commands/myai-dev-review.md +96 -0
- package/src/templates/claude/commands/myai-dev-test.md +95 -0
- package/src/templates/claude/commands/myai-sparc-workflow.md +196 -0
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: myai-dev-code
|
|
3
|
+
description: Implement features with MyAIDev Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Implement features and write production-ready code using MyAIDev Method's systematic approach.
|
|
7
|
+
|
|
8
|
+
Invoke the MyAIDev Coder agent to implement features based on architecture specifications, following best practices and clean code principles.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
/myai-dev-code "Implement user authentication"
|
|
14
|
+
/myai-dev-code "Build payment processing system"
|
|
15
|
+
/myai-dev-code "Refactor database queries for performance"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Options
|
|
19
|
+
|
|
20
|
+
- Task description (required) - Clear description of the implementation task
|
|
21
|
+
- `--architecture <file>` - Path to architecture specification (default: `.myaidev-method/sparc/architecture.md`)
|
|
22
|
+
- `--test-driven` - Use TDD approach (write tests first)
|
|
23
|
+
- `--output-dir <path>` - Custom output directory (default: `.myaidev-method/sparc/code-output/`)
|
|
24
|
+
|
|
25
|
+
## What It Does
|
|
26
|
+
|
|
27
|
+
The coder agent will:
|
|
28
|
+
1. Read architecture specifications
|
|
29
|
+
2. Plan implementation approach
|
|
30
|
+
3. Write clean, modular code
|
|
31
|
+
4. Follow SOLID principles
|
|
32
|
+
5. Implement error handling
|
|
33
|
+
6. Add security measures
|
|
34
|
+
7. Include inline documentation
|
|
35
|
+
8. Create basic tests
|
|
36
|
+
|
|
37
|
+
## Output
|
|
38
|
+
|
|
39
|
+
Creates implementation files in `.myaidev-method/sparc/code-output/`:
|
|
40
|
+
- Feature implementation code
|
|
41
|
+
- Utility functions and helpers
|
|
42
|
+
- Configuration files
|
|
43
|
+
- Basic unit tests
|
|
44
|
+
- Implementation notes
|
|
45
|
+
|
|
46
|
+
## Code Quality Standards
|
|
47
|
+
|
|
48
|
+
All code follows:
|
|
49
|
+
- **SOLID Principles**: Single responsibility, modularity
|
|
50
|
+
- **Clean Code**: DRY, KISS, YAGNI
|
|
51
|
+
- **Security**: Input validation, error handling, no secrets
|
|
52
|
+
- **Testing**: Testable code with >80% coverage target
|
|
53
|
+
- **Documentation**: Clear comments and inline docs
|
|
54
|
+
|
|
55
|
+
## Examples
|
|
56
|
+
|
|
57
|
+
### Implement Authentication
|
|
58
|
+
```bash
|
|
59
|
+
/myai-dev-code "Implement JWT-based authentication with refresh tokens"
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Build API Endpoints
|
|
63
|
+
```bash
|
|
64
|
+
/myai-dev-code "Create REST API endpoints for user management"
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Refactor Existing Code
|
|
68
|
+
```bash
|
|
69
|
+
/myai-dev-code "Refactor payment processing to improve testability and error handling"
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Test-Driven Development
|
|
73
|
+
```bash
|
|
74
|
+
/myai-dev-code "Implement order checkout workflow" --test-driven
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Integration with SPARC Workflow
|
|
78
|
+
|
|
79
|
+
This is **Phase 2** of the MyAIDev Method SPARC workflow:
|
|
80
|
+
- **Previous Phase**: Architecture (`/myai-dev-architect`)
|
|
81
|
+
- **Current Phase**: Implementation
|
|
82
|
+
- **Next Phase**: Testing (`/myai-dev-test`)
|
|
83
|
+
- **Inputs**: Architecture specifications
|
|
84
|
+
- **Outputs**: Production-ready code
|
|
85
|
+
|
|
86
|
+
## MyAIDev Method Standards
|
|
87
|
+
|
|
88
|
+
All code follows MyAIDev Method conventions:
|
|
89
|
+
- Modular and maintainable
|
|
90
|
+
- Secure by design
|
|
91
|
+
- Well-documented
|
|
92
|
+
- Testable architecture
|
|
93
|
+
- Follows project patterns
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: myai-dev-docs
|
|
3
|
+
description: Generate comprehensive documentation with MyAIDev Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Generate comprehensive documentation using MyAIDev Method's systematic approach.
|
|
7
|
+
|
|
8
|
+
Invoke the MyAIDev Documenter agent to create API documentation, user guides, architecture docs, and technical specifications.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
/myai-dev-docs "Document authentication API"
|
|
14
|
+
/myai-dev-docs "Create user guide for checkout flow"
|
|
15
|
+
/myai-dev-docs "Generate API reference for payment module"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Options
|
|
19
|
+
|
|
20
|
+
- Task description (required) - Clear description of documentation requirements
|
|
21
|
+
- `--type <type>` - Documentation type: api, user-guide, architecture, technical (default: api)
|
|
22
|
+
- `--format <format>` - Output format: markdown, html, openapi, swagger (default: markdown)
|
|
23
|
+
- `--output-dir <path>` - Custom output directory (default: `.myaidev-method/sparc/documentation/`)
|
|
24
|
+
|
|
25
|
+
## What It Does
|
|
26
|
+
|
|
27
|
+
The documenter agent will:
|
|
28
|
+
1. Analyze code structure and interfaces
|
|
29
|
+
2. Extract API contracts and endpoints
|
|
30
|
+
3. Generate comprehensive documentation
|
|
31
|
+
4. Create usage examples and code samples
|
|
32
|
+
5. Document edge cases and error handling
|
|
33
|
+
6. Generate visual diagrams (architecture, data flow)
|
|
34
|
+
7. Create searchable API reference
|
|
35
|
+
8. Produce user-friendly guides
|
|
36
|
+
|
|
37
|
+
## Output
|
|
38
|
+
|
|
39
|
+
Creates documentation files in `.myaidev-method/sparc/documentation/`:
|
|
40
|
+
- API reference documentation
|
|
41
|
+
- User guides and tutorials
|
|
42
|
+
- Architecture documentation
|
|
43
|
+
- Code examples and snippets
|
|
44
|
+
- Mermaid diagrams
|
|
45
|
+
- OpenAPI/Swagger specs (if applicable)
|
|
46
|
+
|
|
47
|
+
## Documentation Standards
|
|
48
|
+
|
|
49
|
+
All documentation follows:
|
|
50
|
+
- **Clarity**: Simple language, clear examples, visual aids
|
|
51
|
+
- **Completeness**: All public APIs documented, edge cases covered
|
|
52
|
+
- **Accuracy**: Code examples tested, documentation synchronized with code
|
|
53
|
+
- **Accessibility**: Multiple formats, searchable, well-organized
|
|
54
|
+
- **Maintenance**: Version-controlled, update procedures documented
|
|
55
|
+
|
|
56
|
+
## Examples
|
|
57
|
+
|
|
58
|
+
### API Documentation
|
|
59
|
+
```bash
|
|
60
|
+
/myai-dev-docs "Document REST API endpoints for user management"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### User Guide
|
|
64
|
+
```bash
|
|
65
|
+
/myai-dev-docs "Create user guide for authentication system" --type user-guide
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Architecture Documentation
|
|
69
|
+
```bash
|
|
70
|
+
/myai-dev-docs "Document system architecture and design decisions" --type architecture
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### OpenAPI Specification
|
|
74
|
+
```bash
|
|
75
|
+
/myai-dev-docs "Generate OpenAPI spec for payment API" --format openapi
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Integration with SPARC Workflow
|
|
79
|
+
|
|
80
|
+
This is **Phase 5** of the MyAIDev Method SPARC workflow:
|
|
81
|
+
- **Previous Phase**: Review (`/myai-dev-review`)
|
|
82
|
+
- **Current Phase**: Documentation
|
|
83
|
+
- **Final Phase**: Complete
|
|
84
|
+
- **Inputs**: Reviewed and validated code
|
|
85
|
+
- **Outputs**: Comprehensive documentation suite
|
|
86
|
+
|
|
87
|
+
## MyAIDev Method Standards
|
|
88
|
+
|
|
89
|
+
All documentation follows MyAIDev Method conventions:
|
|
90
|
+
- Saved to `.myaidev-method/sparc/documentation/` directory
|
|
91
|
+
- Version controlled (Markdown format)
|
|
92
|
+
- Includes visual diagrams (Mermaid)
|
|
93
|
+
- Code examples tested and verified
|
|
94
|
+
- Multiple audience levels supported
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: myai-dev-review
|
|
3
|
+
description: Review code quality and security with MyAIDev Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Perform comprehensive code review using MyAIDev Method's systematic approach.
|
|
7
|
+
|
|
8
|
+
Invoke the MyAIDev Reviewer agent to analyze code quality, security vulnerabilities, performance issues, and best practices compliance.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
/myai-dev-review "Review authentication implementation"
|
|
14
|
+
/myai-dev-review "Security audit for payment processing"
|
|
15
|
+
/myai-dev-review "Performance review of database queries"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Options
|
|
19
|
+
|
|
20
|
+
- Task description (required) - Clear description of review scope
|
|
21
|
+
- `--security` - Focus on security analysis (OWASP Top 10)
|
|
22
|
+
- `--performance` - Focus on performance optimization
|
|
23
|
+
- `--output-dir <path>` - Custom output directory (default: `.myaidev-method/sparc/`)
|
|
24
|
+
|
|
25
|
+
## What It Does
|
|
26
|
+
|
|
27
|
+
The reviewer agent will:
|
|
28
|
+
1. Analyze code quality and maintainability
|
|
29
|
+
2. Check for security vulnerabilities (OWASP Top 10)
|
|
30
|
+
3. Review performance and optimization opportunities
|
|
31
|
+
4. Validate best practices compliance
|
|
32
|
+
5. Identify code smells and anti-patterns
|
|
33
|
+
6. Assess technical debt
|
|
34
|
+
7. Provide actionable recommendations
|
|
35
|
+
8. Generate comprehensive review report
|
|
36
|
+
|
|
37
|
+
## Output
|
|
38
|
+
|
|
39
|
+
Creates `.myaidev-method/sparc/review-report.md` containing:
|
|
40
|
+
- Executive summary with quality scores
|
|
41
|
+
- Critical/High/Medium/Low priority issues
|
|
42
|
+
- Security analysis (OWASP Top 10 compliance)
|
|
43
|
+
- Performance metrics and bottlenecks
|
|
44
|
+
- Code quality assessment
|
|
45
|
+
- Technical debt evaluation
|
|
46
|
+
- Testing recommendations
|
|
47
|
+
- Actionable improvement plan
|
|
48
|
+
|
|
49
|
+
## Review Standards
|
|
50
|
+
|
|
51
|
+
All reviews cover:
|
|
52
|
+
- **Code Quality**: Complexity, readability, maintainability
|
|
53
|
+
- **Security**: OWASP Top 10, vulnerability patterns
|
|
54
|
+
- **Performance**: Algorithm complexity, resource management
|
|
55
|
+
- **Best Practices**: SOLID principles, framework standards
|
|
56
|
+
- **Technical Debt**: Assessment, prioritization, remediation
|
|
57
|
+
|
|
58
|
+
## Examples
|
|
59
|
+
|
|
60
|
+
### General Code Review
|
|
61
|
+
```bash
|
|
62
|
+
/myai-dev-review "Review user authentication module for quality and security"
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Security-Focused Review
|
|
66
|
+
```bash
|
|
67
|
+
/myai-dev-review "Security audit of payment processing" --security
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Performance Review
|
|
71
|
+
```bash
|
|
72
|
+
/myai-dev-review "Review database layer for performance bottlenecks" --performance
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Pre-Production Review
|
|
76
|
+
```bash
|
|
77
|
+
/myai-dev-review "Final review before production deployment"
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Integration with SPARC Workflow
|
|
81
|
+
|
|
82
|
+
This is **Phase 4** of the MyAIDev Method SPARC workflow:
|
|
83
|
+
- **Previous Phase**: Testing (`/myai-dev-test`)
|
|
84
|
+
- **Current Phase**: Review
|
|
85
|
+
- **Next Phase**: Documentation (`/myai-dev-docs`)
|
|
86
|
+
- **Inputs**: Implemented and tested code
|
|
87
|
+
- **Outputs**: Comprehensive review report with recommendations
|
|
88
|
+
|
|
89
|
+
## MyAIDev Method Standards
|
|
90
|
+
|
|
91
|
+
All reviews follow MyAIDev Method conventions:
|
|
92
|
+
- Evidence-based analysis
|
|
93
|
+
- Actionable recommendations
|
|
94
|
+
- Priority-based issue tracking
|
|
95
|
+
- Security-first mindset
|
|
96
|
+
- Performance optimization focus
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: myai-dev-test
|
|
3
|
+
description: Write comprehensive tests with MyAIDev Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Write and execute comprehensive tests using MyAIDev Method's systematic approach.
|
|
7
|
+
|
|
8
|
+
Invoke the MyAIDev Tester agent to create unit tests, integration tests, and validate code quality with coverage analysis.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
/myai-dev-test "Test authentication system"
|
|
14
|
+
/myai-dev-test "Create integration tests for checkout flow"
|
|
15
|
+
/myai-dev-test "Improve test coverage for payment module"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Options
|
|
19
|
+
|
|
20
|
+
- Task description (required) - Clear description of testing requirements
|
|
21
|
+
- `--coverage` - Generate coverage report
|
|
22
|
+
- `--integration` - Focus on integration tests
|
|
23
|
+
- `--framework <name>` - Specify testing framework (jest, mocha, pytest, etc.)
|
|
24
|
+
- `--output-dir <path>` - Custom output directory (default: `.myaidev-method/sparc/test-results/`)
|
|
25
|
+
|
|
26
|
+
## What It Does
|
|
27
|
+
|
|
28
|
+
The tester agent will:
|
|
29
|
+
1. Analyze code to be tested
|
|
30
|
+
2. Create comprehensive test suites
|
|
31
|
+
3. Write unit tests for components
|
|
32
|
+
4. Write integration tests for workflows
|
|
33
|
+
5. Generate test coverage reports
|
|
34
|
+
6. Identify untested edge cases
|
|
35
|
+
7. Validate quality gates
|
|
36
|
+
8. Provide improvement recommendations
|
|
37
|
+
|
|
38
|
+
## Output
|
|
39
|
+
|
|
40
|
+
Creates test files in `.myaidev-method/sparc/test-results/`:
|
|
41
|
+
- Unit test files
|
|
42
|
+
- Integration test files
|
|
43
|
+
- Test report with metrics
|
|
44
|
+
- Coverage report
|
|
45
|
+
- Quality gates validation
|
|
46
|
+
- Recommendations for improvement
|
|
47
|
+
|
|
48
|
+
## Testing Standards
|
|
49
|
+
|
|
50
|
+
All tests follow:
|
|
51
|
+
- **Coverage Requirements**: 80%+ for critical paths, 60%+ overall
|
|
52
|
+
- **Test Patterns**: AAA (Arrange, Act, Assert)
|
|
53
|
+
- **Edge Cases**: Boundary conditions, error scenarios
|
|
54
|
+
- **Integration**: End-to-end workflow validation
|
|
55
|
+
- **Quality Gates**: Pre-commit, pre-merge, pre-deployment
|
|
56
|
+
|
|
57
|
+
## Examples
|
|
58
|
+
|
|
59
|
+
### Unit Testing
|
|
60
|
+
```bash
|
|
61
|
+
/myai-dev-test "Write unit tests for authentication module"
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Integration Testing
|
|
65
|
+
```bash
|
|
66
|
+
/myai-dev-test "Test complete checkout workflow" --integration
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Coverage Improvement
|
|
70
|
+
```bash
|
|
71
|
+
/myai-dev-test "Improve coverage for payment processing" --coverage
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Framework-Specific
|
|
75
|
+
```bash
|
|
76
|
+
/myai-dev-test "Create pytest tests for API endpoints" --framework pytest
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Integration with SPARC Workflow
|
|
80
|
+
|
|
81
|
+
This is **Phase 3** of the MyAIDev Method SPARC workflow:
|
|
82
|
+
- **Previous Phase**: Implementation (`/myai-dev-code`)
|
|
83
|
+
- **Current Phase**: Testing
|
|
84
|
+
- **Next Phase**: Review (`/myai-dev-review`)
|
|
85
|
+
- **Inputs**: Implemented code
|
|
86
|
+
- **Outputs**: Comprehensive test suite and coverage report
|
|
87
|
+
|
|
88
|
+
## MyAIDev Method Standards
|
|
89
|
+
|
|
90
|
+
All tests follow MyAIDev Method conventions:
|
|
91
|
+
- Comprehensive coverage (80%+ target)
|
|
92
|
+
- Clear test naming and organization
|
|
93
|
+
- Fast execution (<5s for unit tests)
|
|
94
|
+
- Isolated and independent tests
|
|
95
|
+
- Quality gate validation
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: myai-sparc-workflow
|
|
3
|
+
description: Execute complete SPARC development workflow with MyAIDev Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Execute the complete 5-phase SPARC development workflow using MyAIDev Method's systematic approach.
|
|
7
|
+
|
|
8
|
+
Orchestrates all development agents in sequence: Architecture → Implementation → Testing → Review → Documentation
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
/myai-sparc-workflow "Build user authentication system"
|
|
14
|
+
/myai-sparc-workflow "Create payment processing module"
|
|
15
|
+
/myai-sparc-workflow "Implement real-time chat feature"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Options
|
|
19
|
+
|
|
20
|
+
- Task description (required) - Clear description of the complete feature/system to build
|
|
21
|
+
- `--phases <phases>` - Specific phases to run (comma-separated): architecture,implementation,testing,review,documentation
|
|
22
|
+
- `--tech-stack <stack>` - Technology preferences (e.g., "node,postgres,redis")
|
|
23
|
+
- `--output-dir <path>` - Custom output directory (default: `.myaidev-method/sparc/`)
|
|
24
|
+
- `--test-framework <name>` - Testing framework preference (jest, mocha, pytest, etc.)
|
|
25
|
+
- `--skip-phase <phase>` - Skip specific phase (use with caution)
|
|
26
|
+
|
|
27
|
+
## SPARC Workflow Phases
|
|
28
|
+
|
|
29
|
+
The workflow executes these phases in sequence:
|
|
30
|
+
|
|
31
|
+
### 1. **Specification & Architecture** (`/myai-dev-architect`)
|
|
32
|
+
- Requirements analysis
|
|
33
|
+
- System design with Mermaid diagrams
|
|
34
|
+
- API specifications
|
|
35
|
+
- Data modeling
|
|
36
|
+
- Technology recommendations
|
|
37
|
+
- Security planning
|
|
38
|
+
|
|
39
|
+
**Output**: `.myaidev-method/sparc/architecture.md`
|
|
40
|
+
|
|
41
|
+
### 2. **Pseudocode & Implementation** (`/myai-dev-code`)
|
|
42
|
+
- Feature implementation based on architecture
|
|
43
|
+
- SOLID principles application
|
|
44
|
+
- Security best practices
|
|
45
|
+
- Error handling
|
|
46
|
+
- Inline documentation
|
|
47
|
+
|
|
48
|
+
**Output**: `.myaidev-method/sparc/code-output/`
|
|
49
|
+
|
|
50
|
+
### 3. **Architecture Validation & Testing** (`/myai-dev-test`)
|
|
51
|
+
- Unit test creation
|
|
52
|
+
- Integration test development
|
|
53
|
+
- Coverage analysis (80%+ target)
|
|
54
|
+
- Quality gate validation
|
|
55
|
+
- Test execution
|
|
56
|
+
|
|
57
|
+
**Output**: `.myaidev-method/sparc/test-results/`
|
|
58
|
+
|
|
59
|
+
### 4. **Refinement & Review** (`/myai-dev-review`)
|
|
60
|
+
- Code quality analysis
|
|
61
|
+
- Security audit (OWASP Top 10)
|
|
62
|
+
- Performance review
|
|
63
|
+
- Best practices validation
|
|
64
|
+
- Technical debt assessment
|
|
65
|
+
|
|
66
|
+
**Output**: `.myaidev-method/sparc/review-report.md`
|
|
67
|
+
|
|
68
|
+
### 5. **Completion & Documentation** (`/myai-dev-docs`)
|
|
69
|
+
- API documentation
|
|
70
|
+
- User guides
|
|
71
|
+
- Architecture documentation
|
|
72
|
+
- Code examples
|
|
73
|
+
- Deployment guides
|
|
74
|
+
|
|
75
|
+
**Output**: `.myaidev-method/sparc/documentation/`
|
|
76
|
+
|
|
77
|
+
## What It Does
|
|
78
|
+
|
|
79
|
+
The SPARC workflow orchestrator will:
|
|
80
|
+
1. Initialize `.myaidev-method/sparc/` directory structure
|
|
81
|
+
2. Create task tracking files in `.myaidev-method/tasks/`
|
|
82
|
+
3. Execute each phase sequentially with proper handoffs
|
|
83
|
+
4. Validate phase outputs before proceeding
|
|
84
|
+
5. Generate comprehensive workflow summary
|
|
85
|
+
6. Track progress and results
|
|
86
|
+
7. Handle errors with graceful phase rollback
|
|
87
|
+
8. Produce production-ready deliverables
|
|
88
|
+
|
|
89
|
+
## Directory Structure Created
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
.myaidev-method/
|
|
93
|
+
├── sparc/
|
|
94
|
+
│ ├── architecture.md # Phase 1 output
|
|
95
|
+
│ ├── code-output/ # Phase 2 output
|
|
96
|
+
│ │ ├── src/
|
|
97
|
+
│ │ └── ...
|
|
98
|
+
│ ├── test-results/ # Phase 3 output
|
|
99
|
+
│ │ ├── unit/
|
|
100
|
+
│ │ ├── integration/
|
|
101
|
+
│ │ └── coverage-report.md
|
|
102
|
+
│ ├── review-report.md # Phase 4 output
|
|
103
|
+
│ └── documentation/ # Phase 5 output
|
|
104
|
+
│ ├── api/
|
|
105
|
+
│ ├── user-guide/
|
|
106
|
+
│ └── architecture/
|
|
107
|
+
├── tasks/
|
|
108
|
+
│ └── workflow_[timestamp].json
|
|
109
|
+
└── workflows/
|
|
110
|
+
└── sparc_[timestamp].json
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Output
|
|
114
|
+
|
|
115
|
+
Creates a comprehensive workflow summary in `.myaidev-method/workflows/`:
|
|
116
|
+
- Complete workflow execution log
|
|
117
|
+
- Phase-by-phase results
|
|
118
|
+
- Quality metrics and coverage
|
|
119
|
+
- Review findings and recommendations
|
|
120
|
+
- Documentation index
|
|
121
|
+
- Next steps and maintenance guide
|
|
122
|
+
|
|
123
|
+
## Examples
|
|
124
|
+
|
|
125
|
+
### Complete Feature Development
|
|
126
|
+
```bash
|
|
127
|
+
/myai-sparc-workflow "Build JWT-based authentication system with refresh tokens"
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Specific Technology Stack
|
|
131
|
+
```bash
|
|
132
|
+
/myai-sparc-workflow "Create e-commerce checkout flow" --tech-stack "react,node,stripe,postgres"
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Run Specific Phases
|
|
136
|
+
```bash
|
|
137
|
+
/myai-sparc-workflow "Refactor payment module" --phases "architecture,review,documentation"
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Custom Test Framework
|
|
141
|
+
```bash
|
|
142
|
+
/myai-sparc-workflow "Build API endpoints" --test-framework pytest
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Workflow Benefits
|
|
146
|
+
|
|
147
|
+
- **Systematic Approach**: No missed steps, comprehensive coverage
|
|
148
|
+
- **Quality Assurance**: Built-in review and testing at every phase
|
|
149
|
+
- **Documentation**: Complete documentation generated automatically
|
|
150
|
+
- **Traceability**: Full workflow history and decision tracking
|
|
151
|
+
- **Best Practices**: SOLID, Clean Code, Security embedded in process
|
|
152
|
+
- **Reproducible**: Consistent results across projects and teams
|
|
153
|
+
|
|
154
|
+
## Integration with MyAIDev Method
|
|
155
|
+
|
|
156
|
+
This command orchestrates the complete MyAIDev Method development workflow:
|
|
157
|
+
- **Methodology**: SPARC (Specification, Pseudocode, Architecture, Refinement, Completion)
|
|
158
|
+
- **Agent Coordination**: Sequential execution with file-based handoffs
|
|
159
|
+
- **Quality Gates**: Validation at each phase transition
|
|
160
|
+
- **Outputs**: Production-ready code with comprehensive documentation
|
|
161
|
+
|
|
162
|
+
## Quality Standards
|
|
163
|
+
|
|
164
|
+
All phases follow MyAIDev Method standards:
|
|
165
|
+
- **Code Quality**: SOLID principles, Clean Code, DRY/KISS/YAGNI
|
|
166
|
+
- **Testing**: 80%+ coverage, integration tests, quality gates
|
|
167
|
+
- **Security**: OWASP Top 10 compliance, input validation, error handling
|
|
168
|
+
- **Documentation**: API docs, user guides, architecture specifications
|
|
169
|
+
- **Performance**: Optimization analysis, scalability planning
|
|
170
|
+
|
|
171
|
+
## Error Handling
|
|
172
|
+
|
|
173
|
+
The workflow includes robust error handling:
|
|
174
|
+
- **Phase Validation**: Verify outputs before proceeding to next phase
|
|
175
|
+
- **Graceful Degradation**: Continue with warnings when possible
|
|
176
|
+
- **Rollback Support**: Restore previous state on critical failures
|
|
177
|
+
- **Error Reports**: Detailed error logs in `.myaidev-method/workflows/`
|
|
178
|
+
- **Manual Override**: Skip or retry phases as needed
|
|
179
|
+
|
|
180
|
+
## Next Steps After Completion
|
|
181
|
+
|
|
182
|
+
1. **Review Outputs**: Examine all generated artifacts in `.myaidev-method/sparc/`
|
|
183
|
+
2. **Address Findings**: Review phase 4 report and address issues
|
|
184
|
+
3. **Integration**: Integrate code into your project structure
|
|
185
|
+
4. **Testing**: Run final integration tests
|
|
186
|
+
5. **Deployment**: Follow deployment guide in documentation
|
|
187
|
+
6. **Maintenance**: Use generated documentation for ongoing development
|
|
188
|
+
|
|
189
|
+
## MyAIDev Method Philosophy
|
|
190
|
+
|
|
191
|
+
The SPARC workflow embodies MyAIDev Method principles:
|
|
192
|
+
- **Specification First**: Clear requirements before implementation
|
|
193
|
+
- **Architecture Planning**: Design before coding
|
|
194
|
+
- **Testing Built-In**: Quality from the start
|
|
195
|
+
- **Continuous Review**: Iterative refinement
|
|
196
|
+
- **Documentation Integral**: Knowledge preservation
|