diff --git a/.gitignore b/.gitignore index 1c3f3541..aea829a5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,19 +1,60 @@ -# Node modules -node_modules/ +# IDE and Editor files +.idea/ +.vscode/ +*.swp +*.swo +*~ -# Logs -logs -*.log -npm-debug.log* - -# Build output -dist/ -build/ - -# System files +# OS generated files .DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db + +# Temporary files +*.tmp +*.temp +*.log + +# Node.js (if needed for build scripts) +node_modules/ +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Python (if needed for automation) +__pycache__/ +*.py[cod] +*$py.class +*.so +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg # Environment variables .env +.env.local +.env.development.local +.env.test.local +.env.production.local -CLAUDE.md +# Project-specific +/docs/methodology-evolution/private-notes.md +/docs/temp/ +/build/ \ No newline at end of file diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..6de91045 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,129 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Repository Overview + +This is the **Self-Evolving BMAD (Breakthrough Method of Agile AI-driven Development) Framework** - an adaptive AI-orchestrated development methodology that continuously improves itself through project experience. The system enables rapid project planning, architecture design, and implementation while learning and optimizing its own processes. + +## Self-Improvement Strategy + +### Core Philosophy +- **Continuous Evolution**: The methodology improves with each project milestone +- **Milestone-Based Learning**: Git commits mark methodology evolution checkpoints +- **User-Approved Changes**: Major methodology changes require explicit approval +- **Rollback Capability**: Version control allows reverting to previous methodology states + +### Improvement Triggers +1. **Post-Milestone Retrospectives**: Automatic analysis after each phase completion +2. **Pattern Recognition**: Identification of successful vs. problematic workflows +3. **User Feedback**: Systematic incorporation of user insights +4. **Effectiveness Metrics**: Measurement of velocity, quality, and satisfaction + +## Architecture and Structure + +### Core Components + +1. **Personas** (`bmad-agent/personas/`) - Self-improving AI agent definitions: + - **Analyst (Mary)** - Research, brainstorming, project briefs + methodology analysis + - **PM (John)** - Product requirements documents (PRDs) + process optimization + - **Architect (Fred)** - System architecture + methodology architecture improvements + - **Design Architect (Jane)** - UI/UX specs + workflow design improvements + - **PO (Sarah)** - Validates cross-artifact coherence + methodology validation + - **Frontend Dev (Ellyn)** - NextJS/React/TypeScript + development process improvements + - **Full Stack Dev (James)** - General development + implementation optimization + - **Platform Engineer (Alex)** - Infrastructure + methodology infrastructure + - **Scrum Master (Bob)** - Story generation + process improvement facilitation + +2. **Tasks** (`bmad-agent/tasks/`) - Self-optimizing executable instruction sets +3. **Templates** (`bmad-agent/templates/`) - Adaptive document templates that improve with use +4. **Checklists** (`bmad-agent/checklists/`) - Evolving quality control and validation criteria +5. **Evolution Tracking** (`docs/methodology-evolution/`) - History and metrics of improvements + +### Key Design Patterns + +- **Adaptive Agent Architecture**: Each persona learns and improves its own capabilities +- **Self-Optimizing Workflows**: Processes automatically suggest improvements based on outcomes +- **Version-Controlled Methodology**: Git tracks methodology evolution with rollback capability +- **Approval-Gated Evolution**: Major changes require user confirmation before implementation +- **Metric-Driven Improvement**: Effectiveness measurements guide optimization decisions + +## Working with Self-Improving BMAD Agents + +### Milestone-Based Git Workflow + +Each major phase completion triggers: +1. **Retrospective Analysis**: What worked well? What needs improvement? +2. **Improvement Identification**: Specific changes to methodology/personas/tasks +3. **Approval Process**: Present changes to user for confirmation +4. **Implementation**: Apply approved improvements +5. **Git Commit**: Version control milestone with descriptive commit message + +### Commands for Self-Improvement + +- `git log --oneline --grep="Milestone"` - View methodology evolution history +- `git checkout ` - Rollback to previous methodology version +- `git diff HEAD~1 bmad-agent/` - Compare methodology changes between versions + +### Configuration Files + +- `ide-bmad-orchestrator.cfg.md` - Self-updating agent configurations +- `web-bmad-orchestrator-agent.cfg.md` - Adaptive web platform configurations +- `docs/methodology-evolution/improvement-log.md` - Track all methodology changes + +### Enhanced Template Syntax + +Templates now include self-improvement capabilities: +- `{{placeholder}}` - Variable substitution +- `[[LLM: instructions]]` - Hidden AI guidance that can be optimized +- `<>...<>` - Iterative sections with improvement tracking +- `^^CONDITION^^...^^END-CONDITION^^` - Conditional content based on effectiveness metrics +- `@{example}...@{end}` - Reference examples that update based on successful patterns +- `[[IMPROVE: suggestion]]` - Methodology improvement suggestions + +### Self-Evolving Workflow + +1. **Ideation**: Analyst creates project briefs + identifies research process improvements +2. **Requirements**: PM transforms briefs into PRDs + optimizes requirements gathering +3. **Design**: Design Architect creates UI/UX specs + refines design processes +4. **Architecture**: Architect designs system structure + improves technical workflows +5. **Validation**: PO ensures alignment + validates methodology improvements +6. **Implementation**: SM generates stories + optimizes development processes +7. **Retrospective**: All agents contribute to methodology evolution analysis + +## Development Protocol + +### Milestone Commits +Each significant phase generates a commit with format: `"Milestone X: [Phase Name] - [Key Improvements]"` + +### Improvement Process +1. **Identify**: What could work better? +2. **Analyze**: Why didn't it work optimally? +3. **Propose**: Specific improvements to methodology +4. **Approve**: Get user confirmation for major changes +5. **Implement**: Apply improvements to personas/tasks/templates +6. **Track**: Document changes in evolution log +7. **Commit**: Version control the improvements + +### Rollback Procedure +If methodology changes prove problematic: +1. `git log --oneline --grep="Milestone"` - Find last good milestone +2. `git checkout -- bmad-agent/` - Restore methodology files +3. `git commit -m "Rollback: Restore methodology to Milestone X"` + +## Effectiveness Metrics + +- **Velocity**: Time from idea to working implementation +- **Quality**: Reduction in bugs, rework, and user complaints +- **Satisfaction**: User feedback on methodology effectiveness +- **Learning Rate**: Speed of methodology improvement over time + +## Development Notes + +- **Always ask for approval** before making major methodology changes +- **Document all improvements** in the evolution log +- **Commit at milestones** to maintain version control checkpoints +- **Measure effectiveness** to guide optimization decisions +- **Embrace experimentation** while maintaining rollback capability + +This framework represents the first **self-evolving AI development methodology**, continuously optimizing itself through real-world application and user feedback. \ No newline at end of file diff --git a/docs/methodology-evolution/baseline-v1.0.md b/docs/methodology-evolution/baseline-v1.0.md new file mode 100644 index 00000000..e222ac30 --- /dev/null +++ b/docs/methodology-evolution/baseline-v1.0.md @@ -0,0 +1,85 @@ +# BMAD Methodology Baseline v1.0 + +This document establishes the baseline state of the BMAD methodology before implementing self-improvement capabilities. + +## Original BMAD Framework Structure + +### Static Components (Pre-Evolution) +- **Personas**: Fixed AI agent definitions without learning capabilities +- **Tasks**: Static instruction sets without optimization +- **Templates**: Unchanging document formats +- **Checklists**: Fixed quality control criteria +- **Workflow**: Linear process without adaptive improvements + +### Original Workflow +1. Analyst → Project Brief +2. PM → Product Requirements Document (PRD) +3. Design Architect → UI/UX Specifications +4. Architect → System Architecture +5. PO → Validation and Alignment +6. SM → Story Generation +7. Dev → Implementation + +### Limitations Identified +- **No Learning Mechanism**: Framework couldn't improve from experience +- **No Version Control**: No way to track methodology evolution +- **No Feedback Loop**: Successes and failures weren't captured for improvement +- **Static Instructions**: Personas couldn't adapt based on outcomes +- **No Rollback**: No way to revert problematic changes + +## Enhanced Framework v1.0 (Self-Improving) + +### New Capabilities Added +- **Adaptive Learning**: Each persona can analyze and improve its own processes +- **Milestone-Based Evolution**: Git commits track methodology improvements +- **Approval Workflow**: User confirmation required for major changes +- **Effectiveness Metrics**: Systematic measurement of framework performance +- **Rollback Capability**: Version control allows reverting to previous states + +### Enhanced Components +- **Self-Improving Personas**: Agents that learn and optimize their instructions +- **Adaptive Tasks**: Instruction sets that evolve based on effectiveness +- **Smart Templates**: Documents that improve through usage patterns +- **Evolving Checklists**: Quality criteria that adapt to new learnings +- **Optimizing Workflow**: Process that suggests and implements improvements + +### New Workflow with Self-Improvement +1. **Ideation**: Analyst creates briefs + analyzes research process improvements +2. **Requirements**: PM develops PRDs + optimizes requirements gathering +3. **Design**: Design Architect creates specs + refines design processes +4. **Architecture**: Architect designs systems + improves technical workflows +5. **Validation**: PO ensures alignment + validates methodology improvements +6. **Implementation**: SM generates stories + optimizes development processes +7. **Retrospective**: All agents contribute to methodology evolution analysis +8. **Evolution**: Apply approved improvements and commit changes + +## Success Criteria for v1.0 + +### Functional Requirements Met +- ✅ Self-improvement infrastructure established +- ✅ Git-based version control for methodology evolution +- ✅ Enhanced CLAUDE.md with improvement strategy +- ✅ Evolution tracking documentation created +- ✅ Approval workflow defined for major changes + +### Quality Metrics +- **Completeness**: All core self-improvement features implemented +- **Usability**: Clear instructions for methodology evolution +- **Maintainability**: Proper documentation and tracking systems +- **Flexibility**: Framework can adapt to different project types + +## Next Evolution Targets + +### Phase 2 Goals +- Implement improvement tracking systems +- Enhance persona instructions with self-improvement capabilities +- Integrate automated improvement suggestion mechanisms +- Create effectiveness measurement frameworks + +### Long-term Vision +- Fully autonomous methodology optimization +- Predictive improvement suggestions +- Cross-project learning and pattern recognition +- Industry-leading adaptive development framework + +This baseline establishes the foundation for the world's first **self-evolving AI development methodology**. \ No newline at end of file diff --git a/docs/methodology-evolution/improvement-log.md b/docs/methodology-evolution/improvement-log.md new file mode 100644 index 00000000..fb2de6dd --- /dev/null +++ b/docs/methodology-evolution/improvement-log.md @@ -0,0 +1,93 @@ +# BMAD Methodology Evolution Log + +This document tracks all improvements, changes, and evolution of the BMAD methodology framework. + +## Version History + +### v1.0 - Initial Self-Improving Framework (Milestone 1) +**Date**: Initial Implementation +**Commit**: TBD + +#### Changes Made: +- Transformed static BMAD framework into self-improving system +- Added milestone-based git workflow for methodology evolution +- Enhanced CLAUDE.md with self-improvement strategy +- Created evolution tracking infrastructure + +#### Key Improvements: +- **Continuous Evolution**: Methodology now improves with each project milestone +- **Version Control**: Git tracks methodology changes with rollback capability +- **Approval Process**: Major changes require user confirmation before implementation +- **Effectiveness Metrics**: Systematic measurement of methodology performance + +#### Impact Metrics: +- Baseline established for future comparison +- Framework prepared for adaptive learning + +--- + +## Improvement Templates + +### Post-Milestone Retrospective Template +```markdown +## Milestone X Retrospective - [Phase Name] + +### What Worked Well: +- [Successful patterns and processes] + +### What Needs Improvement: +- [Identified problems and inefficiencies] + +### Proposed Changes: +- [Specific methodology improvements] + +### User Approval Status: +- [ ] Approved +- [ ] Rejected +- [ ] Needs modification + +### Implementation Notes: +- [How changes were applied] + +### Effectiveness Metrics: +- Velocity: [measurement] +- Quality: [measurement] +- Satisfaction: [rating] +``` + +### Change Request Template +```markdown +## Change Request: [Title] + +### Problem Statement: +[What issue needs addressing] + +### Proposed Solution: +[Specific changes to methodology] + +### Expected Benefits: +[How this will improve the framework] + +### Risk Assessment: +[Potential downsides or complications] + +### Implementation Plan: +[How to apply the changes] + +### Approval Required: +- [ ] User approval needed for major change +- [ ] Minor optimization - auto-approve +``` + +## Metrics Tracking + +### Baseline Metrics (v1.0) +- **Setup Time**: Time to initialize self-improving framework +- **Documentation Quality**: Comprehensive CLAUDE.md with improvement strategy +- **User Satisfaction**: Framework meets requirements for self-evolution + +### Future Metrics to Track +- **Improvement Velocity**: Rate of methodology enhancements over time +- **Change Success Rate**: Percentage of improvements that provide value +- **Rollback Frequency**: How often we need to revert changes +- **User Engagement**: Level of participation in improvement process \ No newline at end of file