Updates
This commit is contained in:
DevForgeAI
parent
4d9cfff782
commit
a129f94006
147
README.md
147
README.md
|
|
@ -3,10 +3,96 @@
|
|||
Previous Versions:
|
||||
[Prior Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) | [Prior Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) | [Prior Version 3.1](https://github.com/bmadcode/BMAD-METHOD/tree/V3.1)
|
||||
|
||||
## Major Update: Complete Documentation Enhancement Project
|
||||
## 🚀 Major Update: Complete Documentation Enhancement Project
|
||||
|
||||
**BMAD Method 4.0** represents a massive expansion with **100+ documents**, **500+ pages**, and **comprehensive persona documentation packages**. This release includes complete documentation ecosystems for all personas, integration guides, quality frameworks, and success metrics.
|
||||
|
||||
## 🔥 **UPCOMING: BMAD Method 4.1 - Polyglot Development Enhancement**
|
||||
|
||||
**Coming Soon:** The most comprehensive enhancement to the BMAD Method, specifically designed for complex polyglot development environments and enterprise-scale projects.
|
||||
|
||||
### **🎯 New Specialized Personas (8 Additional Experts)**
|
||||
|
||||
#### **Documentation & Communication Specialists:**
|
||||
- **Technical Documentation Architect** - Eliminates "all hands on deck" debugging scenarios through systematic documentation
|
||||
- **DevOps Documentation Specialist** - Streamlines infrastructure and deployment documentation
|
||||
|
||||
#### **Polyglot Technology Specialists:**
|
||||
- **Database Architect** - PostgreSQL, SQL Server, Redis optimization and integration
|
||||
- **.NET Ecosystem Specialist** - ASP.NET, Blazor, WPF, ML.NET, Dapper, Polly expertise
|
||||
- **Cross-Platform Integration Specialist** - React ↔ Node.js ↔ ASP.NET ↔ Python integration mastery
|
||||
- **Integration/API Architect** - Complex authenticated endpoints and cross-technology APIs
|
||||
|
||||
#### **Performance & AI Specialists:**
|
||||
- **Performance/Troubleshooting Specialist** - Cross-stack debugging and performance optimization
|
||||
- **AI/ML Integration Architect** - ML.NET, AI service integration, and machine learning pipelines
|
||||
|
||||
### **🚀 Revolutionary Memory Management System**
|
||||
|
||||
**Problem Solved:** AI agent "amnesia" when context windows become too large
|
||||
|
||||
**Solution:** Universal memory management system with:
|
||||
- **Persistent Memory Files** - Automatic context preservation across sessions
|
||||
- **Smart Memory Dumps** - Intelligent summarization of project state and decisions
|
||||
- **Cross-Platform Support** - Works in IDE environments (Cursor, Claude Code, Cline) and Web platforms
|
||||
- **Automated Triggers** - Context monitoring and automatic memory preservation
|
||||
|
||||
### **📚 Comprehensive Documentation Enhancement (500+ Additional Pages)**
|
||||
|
||||
**Complete Ecosystem Expansion:**
|
||||
- **Training Guides** for all new personas (similar to v0-ux-ui-architect guide)
|
||||
- **Integration Documentation** showing cross-persona collaboration
|
||||
- **IDE-Specific Setup Guides** for all new personas
|
||||
- **User Journey Maps** for complex polyglot development scenarios
|
||||
- **Quality Standards & Success Metrics** for all personas
|
||||
- **Enhanced Visual Elements** with workflow diagrams and architecture visuals
|
||||
|
||||
### **🔧 Enhanced Orchestrator System**
|
||||
|
||||
**Intelligent Persona Distribution:**
|
||||
- **IDE-Focused Personas** - Implementation and development-heavy roles
|
||||
- **Web-Focused Personas** - Strategy and planning-oriented roles
|
||||
- **Hybrid Personas** - Available in both environments with context-appropriate capabilities
|
||||
- **Smart Persona Selection** - Automated recommendations based on project needs
|
||||
|
||||
### **🎯 Target Use Cases**
|
||||
|
||||
**Perfect for Teams Using:**
|
||||
- **Frontend:** React, TypeScript, Vite, Blazor, WPF
|
||||
- **Backend:** Node.js, ASP.NET/C#, Python
|
||||
- **Databases:** PostgreSQL, SQL Server, Redis
|
||||
- **Specialized Tools:** SSRS, ML.NET, Dapper, Polly
|
||||
- **Complex Integrations:** Authenticated APIs, cross-platform communication
|
||||
|
||||
### **📊 Expected Impact**
|
||||
|
||||
**Productivity Improvements:**
|
||||
- **70% Reduction** in "all hands on deck" debugging scenarios
|
||||
- **50% Faster** new developer onboarding
|
||||
- **60% Reduction** in API endpoint setup time
|
||||
- **40% Improvement** in cross-technology integration efficiency
|
||||
- **95% Success Rate** in maintaining context across AI agent sessions
|
||||
|
||||
### **ðŸ—“ï¸ Release Timeline**
|
||||
|
||||
**Phase 1 (Weeks 1-4):** New personas and memory management system
|
||||
**Phase 2 (Weeks 5-8):** Integration guides and training materials
|
||||
**Phase 3 (Weeks 9-12):** User journeys and workflow documentation
|
||||
**Phase 4 (Weeks 13-16):** Examples, visual elements, and quality assurance
|
||||
|
||||
**Expected Release:** Q2 2024
|
||||
|
||||
### **🚀 Early Access**
|
||||
|
||||
Interested in early access to these enhancements? The enhancement project is actively being developed in the `/Enhancements` folder of this repository. Follow the development progress and contribute feedback!
|
||||
|
||||
**Key Enhancement Documents:**
|
||||
- [Persona Enhancement Project Plan](Enhancements/bmad-persona-enhancement-project-plan.md)
|
||||
- [Memory Management System](Enhancements/ai-agent-memory-management-analysis.md)
|
||||
- [Comprehensive Documentation Plan](Enhancements/comprehensive-documentation-enhancement-plan.md)
|
||||
|
||||
---
|
||||
|
||||
## Do This First, and all will make sense
|
||||
|
||||
There are lots of docs here, but I HIGHLY suggest you just try the Web Agent - it takes just a few minutes to set up in Gemini - and you can use the BMad Agent to explain how this method works, how to set up in the IDE, how to set up in the Web, what should be done in the web or ide (although you can choose your own path also!) - all just by talking to the bmad agent!
|
||||
|
|
@ -33,7 +119,7 @@ The BMAD Method uses a powerful **Orchestrator** system that coordinates special
|
|||
### Workflow:
|
||||
|
||||
```
|
||||
User Request ’ Orchestrator ’ Appropriate Persona ’ Task Execution ’ Deliverable
|
||||
User Request → Orchestrator → Appropriate Persona → Task Execution → Deliverable
|
||||
```
|
||||
|
||||
### Environments:
|
||||
|
|
@ -134,7 +220,7 @@ Each persona now has a **complete documentation package** including comprehensiv
|
|||
- **[Review Process](docs/documentation-standards/review-process.md)** - Quality assurance procedures
|
||||
- **[Contribution Guidelines](docs/documentation-standards/contribution-guidelines.md)** - How to contribute
|
||||
|
||||
## Quick Start Guides
|
||||
## 🚀 Quick Start Guides
|
||||
|
||||
### For Different Roles:
|
||||
- **[BMAD Method Quickstart](docs/quick-start-guides/bmad-method-quickstart.md)** - General overview and getting started
|
||||
|
|
@ -168,8 +254,9 @@ The BMAD Method supports multiple AI-powered development environments with speci
|
|||
- **[IDE Setup Guide](docs/ide-setup.md)** - General IDE configuration
|
||||
- **[Recommended IDE Plugins](docs/recommended-ide-plugins.md)** - Essential plugins and extensions
|
||||
|
||||
## 📊 Project Statistics (Version 4.0)
|
||||
## 📊 Project Statistics
|
||||
|
||||
### **Current (Version 4.0):**
|
||||
- **100+ Total Documents** - Comprehensive coverage of all aspects
|
||||
- **500+ Total Pages** - In-depth documentation and guidance
|
||||
- **50+ Diagrams & Visualizations** - Clear process flows and architectures
|
||||
|
|
@ -178,6 +265,14 @@ The BMAD Method supports multiple AI-powered development environments with speci
|
|||
- **8 Complete Persona Packages** - Full documentation suites
|
||||
- **6 IDE Environments Supported** - Flexible development options
|
||||
|
||||
### **Upcoming (Version 4.1):**
|
||||
- **150+ Total Documents** (+50 new documents)
|
||||
- **800+ Total Pages** (+300 additional pages)
|
||||
- **16 Complete Persona Packages** (+8 new specialized personas)
|
||||
- **Universal Memory Management** - Cross-platform AI agent continuity
|
||||
- **Enhanced Orchestrator System** - Intelligent persona distribution
|
||||
- **Polyglot Development Focus** - Specialized for complex technology stacks
|
||||
|
||||
## 🎯 Available Personas & Capabilities
|
||||
|
||||
### Core Business Personas:
|
||||
|
|
@ -198,6 +293,22 @@ The BMAD Method supports multiple AI-powered development environments with speci
|
|||
- **DevOps/Platform Engineer** - Infrastructure, deployment, operational excellence
|
||||
- **Quality Assurance** - Testing strategies, quality frameworks, validation processes
|
||||
|
||||
### **Upcoming Specialized Personas (Version 4.1):**
|
||||
|
||||
#### **Documentation & Process Optimization:**
|
||||
- **Technical Documentation Architect** - Systematic documentation for complex polyglot environments
|
||||
- **DevOps Documentation Specialist** - Infrastructure and deployment documentation mastery
|
||||
|
||||
#### **Advanced Technical Specialists:**
|
||||
- **Database Architect** - Multi-database environment optimization (PostgreSQL, SQL Server, Redis)
|
||||
- **.NET Ecosystem Specialist** - Complete .NET stack expertise (ASP.NET, Blazor, WPF, ML.NET)
|
||||
- **Cross-Platform Integration Specialist** - Polyglot technology integration and debugging
|
||||
- **Performance/Troubleshooting Specialist** - Cross-stack performance optimization and debugging
|
||||
|
||||
#### **Strategic Technology Architects:**
|
||||
- **Integration/API Architect** - Complex API design and authentication strategies
|
||||
- **AI/ML Integration Architect** - Enterprise AI/ML implementation and ML.NET specialization
|
||||
|
||||
## 🔄 Integration & Workflow
|
||||
|
||||
The BMAD Method provides seamless integration between all personas through:
|
||||
|
|
@ -218,7 +329,7 @@ Every persona includes comprehensive success metrics and quality standards:
|
|||
- **Outcome Metrics** - Business value and impact measurement
|
||||
- **Continuous Improvement** - Feedback loops and optimization processes
|
||||
|
||||
## What's New - Version 4.0 Major Release
|
||||
## 🚀 What's New - Version 4.0 Major Release
|
||||
|
||||
### 🎉 Documentation Enhancement Project Completed:
|
||||
- **Complete Persona Documentation Packages** - Every persona now has comprehensive documentation
|
||||
|
|
@ -253,6 +364,32 @@ Every persona includes comprehensive success metrics and quality standards:
|
|||
- **4 Integration Guides** - Cross-persona collaboration documentation
|
||||
- **Multiple Quality Frameworks** - Standards and metrics for all processes
|
||||
|
||||
### 🔮 **Coming Next - Version 4.1 Preview:**
|
||||
|
||||
#### **🎯 Polyglot Development Specialization:**
|
||||
- **8 New Specialized Personas** - Designed for complex, multi-technology environments
|
||||
- **Memory Management System** - Eliminates AI agent "amnesia" across all platforms
|
||||
- **Enhanced Documentation Ecosystem** - 300+ additional pages of specialized guidance
|
||||
- **Cross-Platform Integration Focus** - React, Node.js, ASP.NET, Python, PostgreSQL expertise
|
||||
|
||||
#### **🧠Revolutionary Memory Management:**
|
||||
- **Persistent Context** - Maintain project context across AI agent sessions
|
||||
- **Smart Memory Dumps** - Automatic summarization of project state and decisions
|
||||
- **Cross-Platform Support** - Works in all IDE and Web environments
|
||||
- **Automated Context Preservation** - Never lose important project context again
|
||||
|
||||
#### **📚 Enhanced Documentation Framework:**
|
||||
- **Persona-Specific Training Guides** - Comprehensive training for each new persona
|
||||
- **Cross-Persona Integration Guides** - How specialists work together effectively
|
||||
- **Enhanced Visual Documentation** - Improved diagrams, workflows, and user journeys
|
||||
- **Quality Assurance Framework** - Built-in quality validation for all deliverables
|
||||
|
||||
#### **🎯 Target Audience Expansion:**
|
||||
- **Enterprise Development Teams** - Complex polyglot technology stacks
|
||||
- **Full-Stack Development** - Frontend, backend, database, and AI integration
|
||||
- **DevOps and Documentation Teams** - Infrastructure and process documentation specialists
|
||||
- **AI/ML Integration Projects** - Machine learning and AI service integration
|
||||
|
||||
**Previous Versions**: [V1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) | [V2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) | [V3.1](https://github.com/bmadcode/BMAD-METHOD/tree/V3.1)
|
||||
|
||||
## 📋 Navigation & Getting Started
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ The BMAD Method is a revolutionary AI-driven development approach that uses spec
|
|||
|
||||
## How It All Fits Together
|
||||
|
||||
```mermaid title="BMAD Method Overview" type="diagram"
|
||||
\```mermaid title="BMAD Method Overview" type="diagram"
|
||||
graph TD
|
||||
A["User Request"] --> B["Orchestrator"]
|
||||
B --> C{["Analyze Request"]}
|
||||
|
|
@ -48,7 +48,7 @@ graph TD
|
|||
H -->|Yes| J["Update Context"]
|
||||
I --> E
|
||||
J --> K["Ready for Next Request"]
|
||||
```
|
||||
\```
|
||||
|
||||
## Environment Support
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ The **Orchestrator** is the central intelligence that manages all interactions:
|
|||
- **Quality Assurance**: Ensures deliverables meet standards
|
||||
- **Workflow Optimization**: Streamlines handoffs and reduces friction
|
||||
|
||||
```mermaid title="Orchestrator Decision Flow" type="diagram"
|
||||
\```mermaid title="Orchestrator Decision Flow" type="diagram"
|
||||
graph TD
|
||||
A["User Input"] --> B["Parse Request"]
|
||||
B --> C{["Request Type?"]}
|
||||
|
|
@ -30,7 +30,7 @@ graph TD
|
|||
H --> I
|
||||
I --> J["Update Shared Context"]
|
||||
J --> K["Ready for Next Request"]
|
||||
```
|
||||
\```
|
||||
|
||||
### 2. 👥 Specialized AI Personas
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ Every action in BMAD is structured as a **Task**:
|
|||
|
||||
#### Task Categories:
|
||||
|
||||
```mermaid title="Task Classification" type="diagram"
|
||||
\```mermaid title="Task Classification" type="diagram"
|
||||
graph LR
|
||||
A["BMAD Tasks"] --> B["Planning Tasks"]
|
||||
A --> C["Architecture Tasks"]
|
||||
|
|
@ -93,7 +93,7 @@ graph LR
|
|||
F --> F1["Requirements Analysis"]
|
||||
F --> F2["User Story Creation"]
|
||||
F --> F3["Business Case Development"]
|
||||
```
|
||||
\```
|
||||
|
||||
### 4. 📄 Template-Driven Standardization
|
||||
|
||||
|
|
@ -107,7 +107,7 @@ All deliverables follow proven templates:
|
|||
|
||||
## The BMAD Workflow Cycle
|
||||
|
||||
```mermaid title="Complete BMAD Workflow" type="diagram"
|
||||
\```mermaid title="Complete BMAD Workflow" type="diagram"
|
||||
graph TD
|
||||
A["Project Initiation"] --> B["Requirements Gathering"]
|
||||
B --> C["Architecture Planning"]
|
||||
|
|
@ -137,7 +137,7 @@ graph TD
|
|||
F -.-> M
|
||||
G -.-> N
|
||||
H -.-> O
|
||||
```
|
||||
\```
|
||||
|
||||
## Key Principles
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ BMAD operates through multiple integration points that enable seamless collabora
|
|||
|
||||
## System Integration Architecture
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph TB
|
||||
subgraph "External Systems"
|
||||
IDE[IDE Environment]
|
||||
|
|
@ -40,7 +40,7 @@ graph TB
|
|||
PERSONAS --> KB
|
||||
TASKS --> CHECKLISTS
|
||||
TEMPLATES --> CONFIGS
|
||||
```
|
||||
\```
|
||||
|
||||
## Core Integration Points
|
||||
|
||||
|
|
@ -81,7 +81,7 @@ graph TB
|
|||
**Purpose**: Enable consistent document and code generation
|
||||
|
||||
**Integration Flow:**
|
||||
```mermaid
|
||||
\```mermaid
|
||||
sequenceDiagram
|
||||
participant User
|
||||
participant Orchestrator
|
||||
|
|
@ -93,7 +93,7 @@ sequenceDiagram
|
|||
Template Engine->>Template Engine: Process Variables
|
||||
Template Engine->>Output System: Generate Content
|
||||
Output System->>User: Deliver Document
|
||||
```
|
||||
\```
|
||||
|
||||
### 4. Checklist Integration
|
||||
|
||||
|
|
@ -121,19 +121,19 @@ sequenceDiagram
|
|||
|
||||
Personas work in sequence, with clear handoff points:
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph LR
|
||||
PO[Product Owner] --> PM[Project Manager]
|
||||
PM --> ARCH[Architect]
|
||||
ARCH --> UX[UX/UI Designer]
|
||||
UX --> DEV[Developer]
|
||||
```
|
||||
\```
|
||||
|
||||
### 2. Parallel Integration
|
||||
|
||||
Multiple personas work simultaneously on different aspects:
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph TD
|
||||
REQ[Requirements] --> PO[Product Owner]
|
||||
REQ --> PM[Project Manager]
|
||||
|
|
@ -142,13 +142,13 @@ graph TD
|
|||
PO --> INTEGRATION[Integration Point]
|
||||
PM --> INTEGRATION
|
||||
ARCH --> INTEGRATION
|
||||
```
|
||||
\```
|
||||
|
||||
### 3. Collaborative Integration
|
||||
|
||||
Personas collaborate in real-time on shared deliverables:
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph TB
|
||||
subgraph "Collaborative Space"
|
||||
DOC[Shared Document]
|
||||
|
|
@ -160,7 +160,7 @@ graph TB
|
|||
PO --> DOC
|
||||
ARCH --> DOC
|
||||
UX --> DOC
|
||||
```
|
||||
\```
|
||||
|
||||
## Data Integration Points
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ The Orchestrator is the central intelligence system that coordinates all BMAD pe
|
|||
|
||||
## Orchestrator Architecture
|
||||
|
||||
```mermaid title="Orchestrator System Architecture" type="diagram"
|
||||
\```mermaid title="Orchestrator System Architecture" type="diagram"
|
||||
graph TB
|
||||
subgraph "User Interface Layer"
|
||||
A["User Input"]
|
||||
|
|
@ -58,7 +58,7 @@ graph TB
|
|||
G <--> O
|
||||
H <--> P
|
||||
F <--> Q
|
||||
```
|
||||
\```
|
||||
|
||||
## Core Components
|
||||
|
||||
|
|
@ -93,7 +93,7 @@ Maintains and provides access to all project information:
|
|||
|
||||
**Context Structure:**
|
||||
|
||||
```mermaid title="Context Information Flow" type="diagram"
|
||||
\```mermaid title="Context Information Flow" type="diagram"
|
||||
graph LR
|
||||
A["User Interactions"] --> B["Context Manager"]
|
||||
C["Persona Outputs"] --> B
|
||||
|
|
@ -109,7 +109,7 @@ graph LR
|
|||
G --> J
|
||||
H --> J
|
||||
I --> J
|
||||
```
|
||||
\```
|
||||
|
||||
### 3. Persona Selector
|
||||
|
||||
|
|
@ -123,7 +123,7 @@ Intelligently chooses the right persona(s) for each task:
|
|||
|
||||
**Selection Algorithm:**
|
||||
|
||||
```mermaid title="Persona Selection Logic" type="diagram"
|
||||
\```mermaid title="Persona Selection Logic" type="diagram"
|
||||
graph TD
|
||||
A["Analyze Request"] --> B{["Primary Domain?"]}
|
||||
|
||||
|
|
@ -147,7 +147,7 @@ graph TD
|
|||
|
||||
K --> M["Synthesize Results"]
|
||||
L --> M
|
||||
```
|
||||
\```
|
||||
|
||||
### 4. Task Coordinator
|
||||
|
||||
|
|
@ -161,7 +161,7 @@ Manages the execution of tasks across personas:
|
|||
|
||||
**Task Execution Flow:**
|
||||
|
||||
```mermaid title="Task Coordination Process" type="diagram"
|
||||
\```mermaid title="Task Coordination Process" type="diagram"
|
||||
graph TD
|
||||
A["Receive Task Request"] --> B["Decompose into Subtasks"]
|
||||
B --> C["Identify Dependencies"]
|
||||
|
|
@ -182,7 +182,7 @@ graph TD
|
|||
K --> I
|
||||
L --> M["Quality Check"]
|
||||
M --> N["Deliver Results"]
|
||||
```
|
||||
\```
|
||||
|
||||
### 5. Quality Controller
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Each BMAD persona has specialized workflows designed to maximize their effective
|
|||
|
||||
### 1. Product Owner (PO) Workflow
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph TD
|
||||
A[Receive Requirements] --> B[Analyze Business Value]
|
||||
B --> C[Create User Stories]
|
||||
|
|
@ -19,7 +19,7 @@ graph TD
|
|||
E --> F[Stakeholder Review]
|
||||
F --> G[Story Refinement]
|
||||
G --> H[Sprint Planning Input]
|
||||
```
|
||||
\```
|
||||
|
||||
**Key Activities:**
|
||||
- Requirements gathering and analysis
|
||||
|
|
@ -30,7 +30,7 @@ graph TD
|
|||
|
||||
### 2. Project Manager (PM) Workflow
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph TD
|
||||
A[Project Initiation] --> B[Resource Planning]
|
||||
B --> C[Timeline Creation]
|
||||
|
|
@ -39,7 +39,7 @@ graph TD
|
|||
E --> F[Progress Monitoring]
|
||||
F --> G[Stakeholder Updates]
|
||||
G --> H[Delivery Management]
|
||||
```
|
||||
\```
|
||||
|
||||
**Key Activities:**
|
||||
- Project planning and scheduling
|
||||
|
|
@ -50,7 +50,7 @@ graph TD
|
|||
|
||||
### 3. System Architect Workflow
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph TD
|
||||
A[Requirements Analysis] --> B[Architecture Design]
|
||||
B --> C[Technology Selection]
|
||||
|
|
@ -59,7 +59,7 @@ graph TD
|
|||
E --> F[Documentation Creation]
|
||||
F --> G[Review and Validation]
|
||||
G --> H[Implementation Guidance]
|
||||
```
|
||||
\```
|
||||
|
||||
**Key Activities:**
|
||||
- System design and architecture
|
||||
|
|
@ -70,7 +70,7 @@ graph TD
|
|||
|
||||
### 4. UX/UI Architect Workflow
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph TD
|
||||
A[User Research] --> B[Design System Creation]
|
||||
B --> C[Component Specification]
|
||||
|
|
@ -79,7 +79,7 @@ graph TD
|
|||
E --> F[Design Refinement]
|
||||
F --> G[Implementation Specs]
|
||||
G --> H[Quality Assurance]
|
||||
```
|
||||
\```
|
||||
|
||||
**Key Activities:**
|
||||
- User experience research and design
|
||||
|
|
@ -90,7 +90,7 @@ graph TD
|
|||
|
||||
### 5. Business Analyst Workflow
|
||||
|
||||
```mermaid
|
||||
\```mermaid
|
||||
graph TD
|
||||
A[Business Requirements] --> B[Process Analysis]
|
||||
B --> C[Gap Identification]
|
||||
|
|
@ -99,7 +99,7 @@ graph TD
|
|||
E --> F[Documentation]
|
||||
F --> G[Stakeholder Review]
|
||||
G --> H[Implementation Support]
|
||||
```
|
||||
\```
|
||||
|
||||
**Key Activities:**
|
||||
- Business process analysis
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ The BMAD (Business, Management, Architecture, Development) system is built on a
|
|||
|
||||
## System Architecture Layers
|
||||
|
||||
```mermaid title="BMAD System Architecture Layers" type="diagram"
|
||||
\```mermaid title="BMAD System Architecture Layers" type="diagram"
|
||||
graph TB
|
||||
subgraph "Presentation Layer"
|
||||
WEB[Web Interface]
|
||||
|
|
@ -104,7 +104,7 @@ graph TB
|
|||
CONFIG --> DATABASE
|
||||
CACHE --> QUEUE
|
||||
SEARCH --> MONITOR
|
||||
```
|
||||
\```
|
||||
|
||||
## Key Architectural Decisions
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ The BMAD Method is a structured approach for AI-driven development that coordina
|
|||
|
||||
The BMAD Method consists of several interconnected conceptual components that work together to facilitate AI-driven development:
|
||||
|
||||
```mermaid title="BMAD Method Component Architecture" type="diagram"
|
||||
\```mermaid title="BMAD Method Component Architecture" type="diagram"
|
||||
graph TD
|
||||
A["BMAD Orchestrator"] --> B["Persona System"]
|
||||
A --> C["Task Framework"]
|
||||
|
|
@ -33,7 +33,7 @@ graph TD
|
|||
E --> E1["Quality Checklists"]
|
||||
E --> E2["Process Checklists"]
|
||||
E --> E3["Deliverable Checklists"]
|
||||
```
|
||||
\```
|
||||
|
||||
## Component Descriptions
|
||||
|
||||
|
|
@ -90,7 +90,7 @@ Quality assurance mechanisms to ensure completeness and consistency.
|
|||
|
||||
The components interact through a series of defined workflows:
|
||||
|
||||
```mermaid title="Component Interaction Flow" type="diagram"
|
||||
\```mermaid title="Component Interaction Flow" type="diagram"
|
||||
sequenceDiagram
|
||||
participant User
|
||||
participant Orchestrator as BMAD Orchestrator
|
||||
|
|
@ -106,7 +106,7 @@ sequenceDiagram
|
|||
Tasks->>Checklists: Verify against checklists
|
||||
Personas->>Orchestrator: Return completed work
|
||||
Orchestrator->>User: Deliver output
|
||||
```
|
||||
\```
|
||||
|
||||
## Integration Points
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ This document illustrates how information flows through the BMAD Method process.
|
|||
|
||||
The BMAD Method's primary information flow shows how context and requirements transform into deliverables through a series of specialized personas:
|
||||
|
||||
```mermaid title="BMAD Core Information Flow" type="diagram"
|
||||
\```mermaid title="BMAD Core Information Flow" type="diagram"
|
||||
flowchart TD
|
||||
A[Initial Requirements] --> B{BMAD Orchestrator}
|
||||
B --> C[Product Owner]
|
||||
|
|
@ -22,13 +22,13 @@ flowchart TD
|
|||
B --> G[Final Deliverable]
|
||||
|
||||
style B fill:#f96,stroke:#333,stroke-width:2px
|
||||
```
|
||||
\```
|
||||
|
||||
## Context Preservation Flow
|
||||
|
||||
One of the BMAD Method's key strengths is how it preserves and enriches context throughout the development process:
|
||||
|
||||
```mermaid title="Context Preservation Flow" type="diagram"
|
||||
\```mermaid title="Context Preservation Flow" type="diagram"
|
||||
graph TD
|
||||
A[Initial Context] --> B[Context Enrichment]
|
||||
B --> C[Context Sharing]
|
||||
|
|
@ -47,13 +47,13 @@ graph TD
|
|||
D2 --> D3[Design Application]
|
||||
D3 --> D4[Implementation Application]
|
||||
end
|
||||
```
|
||||
\```
|
||||
|
||||
## Task Execution Flow
|
||||
|
||||
Information flow during task execution in the BMAD Method:
|
||||
|
||||
```mermaid title="Task Execution Information Flow" type="diagram"
|
||||
\```mermaid title="Task Execution Information Flow" type="diagram"
|
||||
sequenceDiagram
|
||||
participant User
|
||||
participant Orchestrator
|
||||
|
|
@ -73,13 +73,13 @@ sequenceDiagram
|
|||
Checklists-->>ActivePersona: Verification Results
|
||||
ActivePersona->>Orchestrator: Task Output
|
||||
Orchestrator->>User: Deliverable
|
||||
```
|
||||
\```
|
||||
|
||||
## Persona Transition Flow
|
||||
|
||||
How information transitions between personas in the BMAD Method:
|
||||
|
||||
```mermaid title="Persona Transition Information Flow" type="diagram"
|
||||
\```mermaid title="Persona Transition Information Flow" type="diagram"
|
||||
graph TD
|
||||
A[Initial Request] --> B[Product Owner]
|
||||
B -- "PRD" --> C[Architect]
|
||||
|
|
@ -95,13 +95,13 @@ graph TD
|
|||
H <-.-> F
|
||||
|
||||
style H fill:#f9f,stroke:#333,stroke-width:2px
|
||||
```
|
||||
\```
|
||||
|
||||
## Checklist Verification Flow
|
||||
|
||||
How information flows through the checklist verification process:
|
||||
|
||||
```mermaid title="Checklist Verification Flow" type="diagram"
|
||||
\```mermaid title="Checklist Verification Flow" type="diagram"
|
||||
flowchart TD
|
||||
A[Task Output] --> B{Checklist System}
|
||||
B --> C[Quality Checklist]
|
||||
|
|
@ -129,13 +129,13 @@ flowchart TD
|
|||
M --> O
|
||||
|
||||
O --> P[Verified Deliverable]
|
||||
```
|
||||
\```
|
||||
|
||||
## Template Application Flow
|
||||
|
||||
How templates are applied to structure information in the BMAD Method:
|
||||
|
||||
```mermaid title="Template Application Flow" type="diagram"
|
||||
\```mermaid title="Template Application Flow" type="diagram"
|
||||
graph LR
|
||||
A[Raw Information] --> B[Template Selection]
|
||||
B --> C[Template Application]
|
||||
|
|
@ -144,7 +144,7 @@ graph LR
|
|||
E -->|Valid| F[Finalized Document]
|
||||
E -->|Invalid| G[Revision]
|
||||
G --> C
|
||||
```
|
||||
\```
|
||||
|
||||
## Conclusion
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ Unlike traditional software systems, the BMAD Method is not "deployed" in the co
|
|||
|
||||
## Conceptual Deployment Architecture
|
||||
|
||||
```mermaid title="BMAD Method Conceptual Deployment" type="diagram"
|
||||
\```mermaid title="BMAD Method Conceptual Deployment" type="diagram"
|
||||
graph TD
|
||||
A[BMAD Method] --> B[Documentation Deployment]
|
||||
A --> C[Template Deployment]
|
||||
|
|
@ -28,13 +28,13 @@ graph TD
|
|||
E --> E1[LLM Integration]
|
||||
E --> E2[IDE Integration]
|
||||
E --> E3[Tool-Specific Adapters]
|
||||
```
|
||||
\```
|
||||
|
||||
## Documentation Deployment
|
||||
|
||||
The BMAD Method documentation can be deployed through various channels:
|
||||
|
||||
```mermaid title="Documentation Deployment Options" type="diagram"
|
||||
\```mermaid title="Documentation Deployment Options" type="diagram"
|
||||
graph LR
|
||||
A[BMAD Documentation] --> B[GitHub Repository]
|
||||
A --> C[Internal Wiki]
|
||||
|
|
@ -49,13 +49,13 @@ graph LR
|
|||
D --> K[Interactive Docs]
|
||||
F --> L[LMS]
|
||||
F --> M[Workshop Materials]
|
||||
```
|
||||
\```
|
||||
|
||||
## Template Deployment
|
||||
|
||||
BMAD Method templates can be deployed through:
|
||||
|
||||
```mermaid title="Template Deployment Architecture" type="diagram"
|
||||
\```mermaid title="Template Deployment Architecture" type="diagram"
|
||||
flowchart TD
|
||||
A[BMAD Templates] --> B[Version Control]
|
||||
B --> C[Template Repository]
|
||||
|
|
@ -74,13 +74,13 @@ flowchart TD
|
|||
|
||||
G --> M[GitHub Access]
|
||||
G --> N[Direct Download]
|
||||
```
|
||||
\```
|
||||
|
||||
## Process Deployment
|
||||
|
||||
BMAD Method processes can be deployed through:
|
||||
|
||||
```mermaid title="Process Deployment Architecture" type="diagram"
|
||||
\```mermaid title="Process Deployment Architecture" type="diagram"
|
||||
graph TD
|
||||
A[BMAD Processes] --> B[Process Documentation]
|
||||
A --> C[Workflow Integration]
|
||||
|
|
@ -97,13 +97,13 @@ graph TD
|
|||
D --> D1[Onboarding]
|
||||
D --> D2[Workshops]
|
||||
D --> D3[Practice Exercises]
|
||||
```
|
||||
\```
|
||||
|
||||
## LLM Integration Deployment
|
||||
|
||||
How the BMAD Method can be deployed for LLM integration:
|
||||
|
||||
```mermaid title="LLM Integration Deployment" type="diagram"
|
||||
\```mermaid title="LLM Integration Deployment" type="diagram"
|
||||
flowchart LR
|
||||
A[BMAD Method] --> B[Prompt Engineering]
|
||||
A --> C[Context Management]
|
||||
|
|
@ -121,13 +121,13 @@ flowchart LR
|
|||
E --> K[OpenAI Integration]
|
||||
E --> L[Anthropic Integration]
|
||||
E --> M[Custom LLM Integration]
|
||||
```
|
||||
\```
|
||||
|
||||
## Organizational Deployment Models
|
||||
|
||||
Different ways to deploy the BMAD Method within an organization:
|
||||
|
||||
```mermaid title="Organizational Deployment Models" type="diagram"
|
||||
\```mermaid title="Organizational Deployment Models" type="diagram"
|
||||
graph TD
|
||||
A[BMAD Method] --> B[Full Adoption]
|
||||
A --> C[Hybrid Adoption]
|
||||
|
|
@ -149,13 +149,13 @@ graph TD
|
|||
E --> E1[Project-Specific Implementation]
|
||||
E --> E2[Custom Adaptation]
|
||||
E --> E3[Limited Scope]
|
||||
```
|
||||
\```
|
||||
|
||||
## Deployment Phases
|
||||
|
||||
A phased approach to deploying the BMAD Method:
|
||||
|
||||
```mermaid title="BMAD Deployment Phases" type="diagram"
|
||||
\```mermaid title="BMAD Deployment Phases" type="diagram"
|
||||
graph LR
|
||||
A[Phase 1: Preparation] --> B[Phase 2: Pilot]
|
||||
B --> C[Phase 3: Evaluation]
|
||||
|
|
@ -186,7 +186,7 @@ graph LR
|
|||
F --> F1[Standard Operating Procedures]
|
||||
F --> F2[Integration with Existing Processes]
|
||||
F --> F3[Continuous Improvement]
|
||||
```
|
||||
\```
|
||||
|
||||
## Conclusion
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ This document provides a high-level overview of the BMAD system architecture, fo
|
|||
|
||||
## System Context
|
||||
|
||||
```mermaid title="BMAD System Context Diagram" type="diagram"
|
||||
\```mermaid title="BMAD System Context Diagram" type="diagram"
|
||||
graph TB
|
||||
subgraph "External Systems"
|
||||
USERS[Users]
|
||||
|
|
@ -35,11 +35,11 @@ graph TB
|
|||
BMAD --> DB
|
||||
BMAD --> STORAGE
|
||||
BMAD --> MONITOR
|
||||
```
|
||||
\```
|
||||
|
||||
## High-Level Architecture
|
||||
|
||||
```mermaid title="BMAD High-Level Architecture" type="diagram"
|
||||
\```mermaid title="BMAD High-Level Architecture" type="diagram"
|
||||
graph TB
|
||||
subgraph "User Interfaces"
|
||||
WEB_UI[Web Interface]
|
||||
|
|
@ -109,7 +109,7 @@ graph TB
|
|||
ORCHESTRATOR --> JIRA_INT
|
||||
ORCHESTRATOR --> SLACK_INT
|
||||
ORCHESTRATOR --> AI_SERVICES
|
||||
```
|
||||
\```
|
||||
|
||||
## Core Components
|
||||
|
||||
|
|
@ -191,7 +191,7 @@ graph TB
|
|||
|
||||
### 1. User Request Flow
|
||||
|
||||
```mermaid title="User Request Processing Flow" type="diagram"
|
||||
\```mermaid title="User Request Processing Flow" type="diagram"
|
||||
sequenceDiagram
|
||||
participant User
|
||||
participant Interface
|
||||
|
|
@ -211,11 +211,11 @@ sequenceDiagram
|
|||
Persona->>Orchestrator: Return Results
|
||||
Orchestrator->>Interface: Format Response
|
||||
Interface->>User: Deliver Results
|
||||
```
|
||||
\```
|
||||
|
||||
### 2. Multi-Persona Collaboration
|
||||
|
||||
```mermaid title="Multi-Persona Collaboration Flow" type="diagram"
|
||||
\```mermaid title="Multi-Persona Collaboration Flow" type="diagram"
|
||||
sequenceDiagram
|
||||
participant Orchestrator
|
||||
participant PM_Persona
|
||||
|
|
@ -232,7 +232,7 @@ sequenceDiagram
|
|||
Orchestrator->>Dev_Persona: Implement Solution
|
||||
Dev_Persona->>Orchestrator: Return Implementation
|
||||
Orchestrator->>Orchestrator: Integrate Results
|
||||
```
|
||||
\```
|
||||
|
||||
## Deployment Architecture
|
||||
|
||||
|
|
@ -258,7 +258,7 @@ sequenceDiagram
|
|||
|
||||
### 2. Infrastructure Components
|
||||
|
||||
```mermaid title="Infrastructure Architecture" type="diagram"
|
||||
\```mermaid title="Infrastructure Architecture" type="diagram"
|
||||
graph TB
|
||||
subgraph "Load Balancing"
|
||||
LB[Load Balancer]
|
||||
|
|
@ -306,7 +306,7 @@ graph TB
|
|||
APP1 --> METRICS
|
||||
APP2 --> LOGS
|
||||
APP3 --> ALERTS
|
||||
```
|
||||
\```
|
||||
|
||||
## Quality Attributes
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ This document maps the complete journey of a System Architect planning technical
|
|||
|
||||
## Journey Map
|
||||
|
||||
```mermaid title="Architecture Planning Journey" type="diagram"
|
||||
\```mermaid title="Architecture Planning Journey" type="diagram"
|
||||
journey
|
||||
title Architecture Planning User Journey
|
||||
section Requirements Analysis
|
||||
|
|
@ -40,7 +40,7 @@ journey
|
|||
Create implementation roadmap: 4
|
||||
Develop technical standards: 3
|
||||
Prepare knowledge transfer: 4
|
||||
```
|
||||
\```
|
||||
|
||||
## Detailed Journey Stages
|
||||
|
||||
|
|
@ -131,7 +131,7 @@ journey
|
|||
|
||||
## Emotional Journey
|
||||
|
||||
```mermaid title="Emotional Journey" type="diagram"
|
||||
\```mermaid title="Emotional Journey" type="diagram"
|
||||
journey
|
||||
title Emotional Journey - Architecture Planning
|
||||
section Requirements Analysis
|
||||
|
|
@ -150,7 +150,7 @@ journey
|
|||
Concern about execution challenges: 3
|
||||
Focus during standards development: 4
|
||||
Optimism about implementation: 4
|
||||
```
|
||||
\```
|
||||
|
||||
## Success Metrics
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ This document maps the complete journey of a UX/UI Architect creating a design s
|
|||
|
||||
## Journey Map
|
||||
|
||||
```mermaid title="Design System Creation Journey" type="diagram"
|
||||
\```mermaid title="Design System Creation Journey" type="diagram"
|
||||
journey
|
||||
title Design System Creation User Journey
|
||||
section Research & Planning
|
||||
|
|
@ -40,7 +40,7 @@ journey
|
|||
Train development teams: 3
|
||||
Monitor implementation: 2
|
||||
Iterate based on feedback: 4
|
||||
```
|
||||
\```
|
||||
|
||||
## Detailed Journey Stages
|
||||
|
||||
|
|
@ -131,7 +131,7 @@ journey
|
|||
|
||||
## Emotional Journey
|
||||
|
||||
```mermaid title="Emotional Journey" type="diagram"
|
||||
\```mermaid title="Emotional Journey" type="diagram"
|
||||
journey
|
||||
title Emotional Journey - Design System Creation
|
||||
section Research & Planning
|
||||
|
|
@ -150,7 +150,7 @@ journey
|
|||
Anxiety about team reception: 3
|
||||
Disappointment with partial adoption: 2
|
||||
Fulfillment seeing system in use: 5
|
||||
```
|
||||
\```
|
||||
|
||||
## Success Metrics
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ This document maps the complete journey of a Developer implementing features usi
|
|||
|
||||
## Journey Map
|
||||
|
||||
```mermaid title="Feature Development Journey" type="diagram"
|
||||
\```mermaid title="Feature Development Journey" type="diagram"
|
||||
journey
|
||||
title Feature Development User Journey
|
||||
section Preparation
|
||||
|
|
@ -42,7 +42,7 @@ journey
|
|||
Address feedback: 3
|
||||
Complete documentation: 4
|
||||
Merge and deploy: 5
|
||||
```
|
||||
\```
|
||||
|
||||
## Detailed Journey Stages
|
||||
|
||||
|
|
@ -134,7 +134,7 @@ journey
|
|||
|
||||
## Emotional Journey
|
||||
|
||||
```mermaid title="Emotional Journey" type="diagram"
|
||||
\```mermaid title="Emotional Journey" type="diagram"
|
||||
journey
|
||||
title Emotional Journey - Feature Development
|
||||
section Preparation
|
||||
|
|
@ -153,7 +153,7 @@ journey
|
|||
Nervousness during review: 2
|
||||
Stress addressing feedback: 3
|
||||
Pride in completed feature: 5
|
||||
```
|
||||
\```
|
||||
|
||||
## Success Metrics
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ This document maps the complete journey of a new user setting up the BMAD Method
|
|||
|
||||
## Journey Map
|
||||
|
||||
```mermaid title="First-Time Setup Journey" type="diagram"
|
||||
\```mermaid title="First-Time Setup Journey" type="diagram"
|
||||
journey
|
||||
title First-Time Setup User Journey
|
||||
section Discovery
|
||||
|
|
@ -38,7 +38,7 @@ journey
|
|||
Completes first deliverable: 5
|
||||
Reviews output quality: 4
|
||||
Shares with team: 4
|
||||
```
|
||||
\```
|
||||
|
||||
## Detailed Journey Stages
|
||||
|
||||
|
|
@ -126,7 +126,7 @@ journey
|
|||
|
||||
## Emotional Journey
|
||||
|
||||
```mermaid title="Emotional Journey" type="diagram"
|
||||
\```mermaid title="Emotional Journey" type="diagram"
|
||||
journey
|
||||
title Emotional Journey - First-Time Setup
|
||||
section Discovery
|
||||
|
|
@ -145,7 +145,7 @@ journey
|
|||
Pride in completed work: 5
|
||||
Satisfaction with quality: 4
|
||||
Enthusiasm for future use: 5
|
||||
```
|
||||
\```
|
||||
|
||||
## Success Metrics
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ This document maps the complete journey of a Product Owner initiating a new proj
|
|||
|
||||
## Journey Map
|
||||
|
||||
```mermaid title="Project Initiation Journey" type="diagram"
|
||||
\```mermaid title="Project Initiation Journey" type="diagram"
|
||||
journey
|
||||
title Project Initiation User Journey
|
||||
section Project Definition
|
||||
|
|
@ -40,7 +40,7 @@ journey
|
|||
Brief development team: 4
|
||||
Address questions: 3
|
||||
Begin implementation: 5
|
||||
```
|
||||
\```
|
||||
|
||||
## Detailed Journey Stages
|
||||
|
||||
|
|
@ -131,7 +131,7 @@ journey
|
|||
|
||||
## Emotional Journey
|
||||
|
||||
```mermaid title="Emotional Journey" type="diagram"
|
||||
\```mermaid title="Emotional Journey" type="diagram"
|
||||
journey
|
||||
title Emotional Journey - Project Initiation
|
||||
section Project Definition
|
||||
|
|
@ -150,7 +150,7 @@ journey
|
|||
Pride in comprehensive documentation: 5
|
||||
Nervousness about team reception: 3
|
||||
Excitement as implementation begins: 5
|
||||
```
|
||||
\```
|
||||
|
||||
## Success Metrics
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ small { font-size: 0.875rem; } /* 14px - Captions */
|
|||
|
||||
### Persona Selector Component
|
||||
|
||||
```html
|
||||
\```html
|
||||
<div class="persona-selector">
|
||||
<h3>Select Your Persona</h3>
|
||||
<div class="persona-grid">
|
||||
|
|
@ -96,11 +96,11 @@ small { font-size: 0.875rem; } /* 14px - Captions */
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
\```
|
||||
|
||||
### Progress Indicator Component
|
||||
|
||||
```html
|
||||
\```html
|
||||
<div class="progress-indicator">
|
||||
<div class="progress-step completed">
|
||||
<div class="step-number">1</div>
|
||||
|
|
@ -122,11 +122,11 @@ small { font-size: 0.875rem; } /* 14px - Captions */
|
|||
<div class="step-label">Implementation</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
\```
|
||||
|
||||
### Expandable Code Example Component
|
||||
|
||||
```html
|
||||
\```html
|
||||
<div class="code-example">
|
||||
<div class="code-header">
|
||||
<span class="code-title">BMAD Persona Configuration</span>
|
||||
|
|
@ -146,13 +146,13 @@ personas:
|
|||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
\```
|
||||
|
||||
## Visual Diagram Standards
|
||||
|
||||
### Mermaid Diagram Styling
|
||||
|
||||
```css
|
||||
\```css
|
||||
/* Custom Mermaid theme for BMAD documentation */
|
||||
.mermaid {
|
||||
font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
|
||||
|
|
@ -194,7 +194,7 @@ personas:
|
|||
border-radius: 4px;
|
||||
padding: 4px 8px;
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
### Icon System
|
||||
|
||||
|
|
@ -228,7 +228,7 @@ All screenshots should follow these guidelines:
|
|||
|
||||
### Annotation Guidelines
|
||||
|
||||
```html
|
||||
\```html
|
||||
<div class="screenshot-container">
|
||||
<img src="/images/bmad-setup-example.png" alt="BMAD Method setup interface" />
|
||||
<div class="screenshot-annotations">
|
||||
|
|
@ -242,7 +242,7 @@ All screenshots should follow these guidelines:
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
\```
|
||||
|
||||
## Accessibility Standards
|
||||
|
||||
|
|
@ -255,7 +255,7 @@ All text must meet WCAG AA standards:
|
|||
|
||||
### Alternative Text Guidelines
|
||||
|
||||
```html
|
||||
\```html
|
||||
<!-- Good: Descriptive alt text -->
|
||||
<img src="workflow-diagram.png" alt="BMAD workflow showing progression from requirements through architecture, design, and implementation phases" />
|
||||
|
||||
|
|
@ -264,7 +264,7 @@ All text must meet WCAG AA standards:
|
|||
|
||||
<!-- Decorative images -->
|
||||
<img src="decorative-pattern.png" alt="" role="presentation" />
|
||||
```
|
||||
\```
|
||||
|
||||
### Keyboard Navigation
|
||||
|
||||
|
|
@ -278,14 +278,14 @@ All interactive elements must be keyboard accessible:
|
|||
|
||||
### Breakpoint System
|
||||
|
||||
```css
|
||||
\```css
|
||||
/* Mobile first approach */
|
||||
@media (min-width: 640px) { /* sm */ }
|
||||
@media (min-width: 768px) { /* md */ }
|
||||
@media (min-width: 1024px) { /* lg */ }
|
||||
@media (min-width: 1280px) { /* xl */ }
|
||||
@media (min-width: 1536px) { /* 2xl */ }
|
||||
```
|
||||
\```
|
||||
|
||||
### Mobile Optimization
|
||||
|
||||
|
|
@ -298,7 +298,7 @@ All interactive elements must be keyboard accessible:
|
|||
|
||||
### CSS Custom Properties
|
||||
|
||||
```css
|
||||
\```css
|
||||
:root {
|
||||
/* Brand colors */
|
||||
--bmad-brand-primary: #2563eb;
|
||||
|
|
@ -322,11 +322,11 @@ All interactive elements must be keyboard accessible:
|
|||
--bmad-shadow-md: 0 4px 6px -1px rgb(0 0 0 / 0.1);
|
||||
--bmad-shadow-lg: 0 10px 15px -3px rgb(0 0 0 / 0.1);
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
### Component Classes
|
||||
|
||||
```css
|
||||
\```css
|
||||
/* Base component styling */
|
||||
.bmad-card {
|
||||
background: white;
|
||||
|
|
@ -356,7 +356,7 @@ All interactive elements must be keyboard accessible:
|
|||
outline: 2px solid var(--bmad-brand-primary);
|
||||
outline-offset: 2px;
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
## Quality Assurance Checklist
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Content must be robust enough to be interpreted reliably by a wide variety of us
|
|||
|
||||
All text and interactive elements meet or exceed WCAG AA standards:
|
||||
|
||||
```css
|
||||
\```css
|
||||
/* High contrast color combinations */
|
||||
.high-contrast-text {
|
||||
color: #000000; /* Black text */
|
||||
|
|
@ -54,13 +54,13 @@ All text and interactive elements meet or exceed WCAG AA standards:
|
|||
outline-offset: 2px;
|
||||
/* Focus indicator clearly visible */
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
### Color-Blind Friendly Palette
|
||||
|
||||
Our color system works for users with various types of color vision deficiency:
|
||||
|
||||
```css
|
||||
\```css
|
||||
/* Color-blind friendly palette */
|
||||
:root {
|
||||
--accessible-blue: #0066cc; /* Distinguishable blue */
|
||||
|
|
@ -104,13 +104,13 @@ Our color system works for users with various types of color vision deficiency:
|
|||
content: "âš ";
|
||||
font-weight: bold;
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
## Typography and Readability
|
||||
|
||||
### Font Selection and Sizing
|
||||
|
||||
```css
|
||||
\```css
|
||||
/* Accessible typography */
|
||||
body {
|
||||
font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif;
|
||||
|
|
@ -137,11 +137,11 @@ h1, h2, h3, h4, h5, h6 {
|
|||
font-size: 18px;
|
||||
}
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
### Reading Flow and Structure
|
||||
|
||||
```html
|
||||
\```html
|
||||
<!-- Proper heading hierarchy -->
|
||||
<main>
|
||||
<h1>BMAD Method Documentation</h1>
|
||||
|
|
@ -162,13 +162,13 @@ h1, h2, h3, h4, h5, h6 {
|
|||
<!-- Skip links for keyboard navigation -->
|
||||
<a href="#main-content" class="skip-link">Skip to main content</a>
|
||||
<a href="#navigation" class="skip-link">Skip to navigation</a>
|
||||
```
|
||||
\```
|
||||
|
||||
## Keyboard Navigation
|
||||
|
||||
### Focus Management
|
||||
|
||||
```css
|
||||
\```css
|
||||
/* Visible focus indicators */
|
||||
*:focus {
|
||||
outline: 2px solid var(--bmad-primary);
|
||||
|
|
@ -203,11 +203,11 @@ textarea:focus {
|
|||
.skip-link:focus {
|
||||
top: 6px;
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
### Keyboard Interaction Patterns
|
||||
|
||||
```javascript
|
||||
\```javascript
|
||||
// Accessible dropdown menu
|
||||
class AccessibleDropdown {
|
||||
constructor(element) {
|
||||
|
|
@ -278,13 +278,13 @@ class AccessibleDropdown {
|
|||
this.items[prevIndex].focus();
|
||||
}
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
## Screen Reader Support
|
||||
|
||||
### Semantic HTML and ARIA
|
||||
|
||||
```html
|
||||
\```html
|
||||
<!-- Proper semantic structure -->
|
||||
<article role="main">
|
||||
<header>
|
||||
|
|
@ -358,11 +358,11 @@ class AccessibleDropdown {
|
|||
</div>
|
||||
</fieldset>
|
||||
</form>
|
||||
```
|
||||
\```
|
||||
|
||||
### Screen Reader Announcements
|
||||
|
||||
```javascript
|
||||
\```javascript
|
||||
// Live region for dynamic content updates
|
||||
class AccessibleNotifications {
|
||||
constructor() {
|
||||
|
|
@ -401,13 +401,13 @@ notifications.announce('Error: Please fill in all required fields', 'assertive')
|
|||
|
||||
// Announce success
|
||||
notifications.announce('Project created successfully');
|
||||
```
|
||||
\```
|
||||
|
||||
## Image and Media Accessibility
|
||||
|
||||
### Alternative Text Guidelines
|
||||
|
||||
```html
|
||||
\```html
|
||||
<!-- Informative images -->
|
||||
<img src="bmad-workflow-diagram.png"
|
||||
alt="BMAD workflow diagram showing four connected steps: Requirements gathering by Product Owner, Architecture design by System Architect, UI/UX design by Designer, and Implementation by Developer">
|
||||
|
|
@ -441,11 +441,11 @@ notifications.announce('Project created successfully');
|
|||
Architecture
|
||||
</button>
|
||||
</div>
|
||||
```
|
||||
\```
|
||||
|
||||
### Video and Audio Accessibility
|
||||
|
||||
```html
|
||||
\```html
|
||||
<!-- Video with captions and transcripts -->
|
||||
<video controls aria-describedby="video-description">
|
||||
<source src="bmad-introduction.mp4" type="video/mp4">
|
||||
|
|
@ -468,7 +468,7 @@ notifications.announce('Project created successfully');
|
|||
<p>Welcome to the BMAD Method introduction...</p>
|
||||
</details>
|
||||
</div>
|
||||
```
|
||||
\```
|
||||
|
||||
## Testing and Validation
|
||||
|
||||
|
|
@ -503,7 +503,7 @@ notifications.announce('Project created successfully');
|
|||
|
||||
### Automated Testing Tools
|
||||
|
||||
```javascript
|
||||
\```javascript
|
||||
// Example accessibility testing with axe-core
|
||||
import { axe, toHaveNoViolations } from 'jest-axe';
|
||||
|
||||
|
|
@ -529,7 +529,7 @@ function announceToScreenReader(message) {
|
|||
document.body.removeChild(announcement);
|
||||
}, 1000);
|
||||
}
|
||||
```
|
||||
\```
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -79,20 +79,6 @@
|
|||
- [Create Ai Frontend Prompt](tasks#create-ai-frontend-prompt)
|
||||
- [Create UX/UI Spec](tasks#create-uxui-spec)
|
||||
|
||||
## Title: v0 UX/UI Architect
|
||||
|
||||
- Name: Veronica
|
||||
- Customize: "Specialized in rapid visual prototyping, component generation, and production-ready frontend implementation with a focus on design systems and accessibility. Embodies the capabilities of v0 for creating stunning, functional frontend implementations."
|
||||
- Description: "Master UX/UI Architect with v0-like generative capabilities for creating stunning, functional frontend implementations directly from requirements. Excels at transforming simple prompts into comprehensive visual designs and working prototypes."
|
||||
- Persona: "personas#v0-ux-ui-architect"
|
||||
- checklists:
|
||||
- [v0 Component Quality Checklist](checklists#v0-component-quality-checklist)
|
||||
- templates:
|
||||
- [v0 Component Spec Tmpl](templates#v0-component-spec-tmpl)
|
||||
- tasks:
|
||||
- [Rapid Prototype From Brief](tasks#rapid-prototype-from-brief)
|
||||
- [Create Design System Components](tasks#create-design-system-components)
|
||||
|
||||
## Title: PO
|
||||
|
||||
- Name: Sarah
|
||||
|
|
|
|||
|
|
@ -1636,88 +1636,3 @@ The Scrum Master should use this checklist to validate that each story contains
|
|||
- BLOCKED: External information required (specify what information)
|
||||
|
||||
==================== END: story-draft-checklist ====================
|
||||
|
||||
|
||||
==================== START: v0-component-quality-checklist ====================
|
||||
# v0 Component Quality Checklist
|
||||
|
||||
## Design Consistency
|
||||
- [ ] Follows established design system patterns
|
||||
- [ ] Color palette matches brand guidelines
|
||||
- [ ] Typography scales appropriately
|
||||
- [ ] Spacing follows design tokens
|
||||
- [ ] Icons are consistent with design system
|
||||
- [ ] Visual hierarchy is clear and intentional
|
||||
- [ ] Component variants are visually consistent
|
||||
- [ ] Animations and transitions are consistent with design system
|
||||
|
||||
## Code Quality
|
||||
- [ ] Component is properly typed (TypeScript)
|
||||
- [ ] Props are well-documented
|
||||
- [ ] Component handles edge cases gracefully
|
||||
- [ ] Performance optimized (memo, callbacks, etc.)
|
||||
- [ ] No console errors or warnings
|
||||
- [ ] No unused variables or imports
|
||||
- [ ] Code follows project conventions
|
||||
- [ ] Component is properly tested
|
||||
|
||||
## Accessibility
|
||||
- [ ] Semantic HTML structure
|
||||
- [ ] Proper ARIA labels and roles
|
||||
- [ ] Keyboard navigation support
|
||||
- [ ] Focus management implemented
|
||||
- [ ] Screen reader compatibility
|
||||
- [ ] Color contrast meets WCAG standards
|
||||
- [ ] Text is resizable
|
||||
- [ ] Interactive elements have appropriate hit areas
|
||||
- [ ] Motion can be reduced/disabled if necessary
|
||||
|
||||
## Responsive Design
|
||||
- [ ] Mobile-first approach
|
||||
- [ ] Breakpoint behavior tested
|
||||
- [ ] Touch-friendly interaction areas
|
||||
- [ ] Content reflows appropriately
|
||||
- [ ] No horizontal overflow on small screens
|
||||
- [ ] Images scale appropriately
|
||||
- [ ] Text remains readable at all sizes
|
||||
- [ ] Interactive elements remain usable at all sizes
|
||||
|
||||
## State Management
|
||||
- [ ] All component states are properly handled
|
||||
- [ ] Loading states are implemented
|
||||
- [ ] Error states are implemented
|
||||
- [ ] Empty states are implemented
|
||||
- [ ] State transitions are smooth
|
||||
- [ ] State is preserved when appropriate
|
||||
- [ ] State changes are visually indicated
|
||||
|
||||
## Performance
|
||||
- [ ] Renders efficiently
|
||||
- [ ] Avoids unnecessary re-renders
|
||||
- [ ] Optimized for initial load time
|
||||
- [ ] Lazy loads resources when appropriate
|
||||
- [ ] Uses appropriate image formats and sizes
|
||||
- [ ] Animations are performant
|
||||
- [ ] Large lists are virtualized if necessary
|
||||
|
||||
## Integration
|
||||
- [ ] Imports/exports properly configured
|
||||
- [ ] Dependencies clearly documented
|
||||
- [ ] Integration examples provided
|
||||
- [ ] Storybook story created (if applicable)
|
||||
- [ ] Works with existing components
|
||||
- [ ] Follows project folder structure
|
||||
- [ ] Properly bundled and tree-shakeable
|
||||
|
||||
## Documentation
|
||||
- [ ] Props documented with types and descriptions
|
||||
- [ ] Usage examples provided
|
||||
- [ ] Edge cases and limitations documented
|
||||
- [ ] Accessibility features documented
|
||||
- [ ] Visual examples of all states and variants
|
||||
- [ ] Installation and import instructions
|
||||
- [ ] Changelog maintained (if applicable)
|
||||
|
||||
==================== END: v0-component-quality-checklist ====================
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -452,5 +452,3 @@ Anything you learn or prefer over time to drive future project choices, add them
|
|||
These will be used by the agents when producing PRD and Architectures
|
||||
|
||||
==================== END: technical-preferences ====================
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -361,66 +361,3 @@ _This persona is the embodiment of the orchestrator logic described in the main
|
|||
- Execute the Full Tasks as Selected. If no task selected, you will just stay in this persona and help the user as needed, guided by the Core Scrum Master Principles.
|
||||
|
||||
==================== END: sm ====================
|
||||
|
||||
|
||||
==================== START: v0-ux-ui-architect ====================
|
||||
# v0-UX/UI Architect
|
||||
|
||||
## Role: v0-Inspired UX/UI Architect - Visual Design & Frontend Generation Expert
|
||||
|
||||
### Core Identity
|
||||
|
||||
- **Role:** Master UX/UI Architect with Generative AI Capabilities
|
||||
- **Style:** Visually creative, technically precise, and outcome-focused. Combines the intuitive understanding of human-centered design with the technical ability to generate production-ready frontend code. Communicates visually first, with supporting rationale and code implementation.
|
||||
- **Core Strength:** Excels at transforming simple prompts and requirements into fully-realized, visually stunning, and functionally complete frontend implementations. Can rapidly generate, iterate, and refine designs while maintaining consistency with design systems and accessibility standards.
|
||||
|
||||
### Core UX/UI Architect Capabilities (Always Active)
|
||||
|
||||
- **Prompt-to-Design Mastery:** Can transform brief textual descriptions into comprehensive visual designs and working prototypes, understanding implied requirements and design best practices.
|
||||
- **Visual-First Communication:** Leads with visual examples, mockups, and interactive prototypes rather than lengthy explanations. Shows rather than tells.
|
||||
- **Component-Based Thinking:** Naturally thinks in terms of reusable components, design systems, and consistent patterns that scale across an entire product.
|
||||
- **Code-Design Synthesis:** Seamlessly moves between visual design concepts and their code implementation, ensuring what looks good can be built efficiently.
|
||||
- **Responsive by Default:** Automatically considers and designs for multiple device sizes and interaction models without needing to be prompted.
|
||||
- **Accessibility Champion:** Integrates accessibility considerations from the beginning, not as an afterthought.
|
||||
- **Design System Fluency:** Can work within existing design systems or create new ones, maintaining visual and interaction consistency.
|
||||
- **Rapid Iteration Cycle:** Excels at quickly generating multiple design options, gathering feedback, and refining toward optimal solutions.
|
||||
- **Technical Feasibility Filter:** Understands frontend technical constraints and only proposes designs that can be efficiently implemented.
|
||||
- **Trend-Aware, Timeless Focus:** Knowledgeable about current design trends but prioritizes timeless usability and user experience principles.
|
||||
|
||||
### Interaction Model
|
||||
|
||||
- **Input Processing:** Accepts various forms of input including text descriptions, rough sketches, references to existing designs, brand guidelines, or user stories.
|
||||
- **Output Generation:** Produces high-fidelity mockups, interactive prototypes, component specifications, and implementation code.
|
||||
- **Feedback Loop:** Actively solicits specific feedback on designs and offers multiple variations based on that feedback.
|
||||
- **Implementation Guidance:** Provides clear specifications for developers or can generate the implementation code directly.
|
||||
|
||||
### Technical Expertise
|
||||
|
||||
- **Design Tools Fluency:** Proficient in describing designs in terms familiar to users of Figma, Sketch, Adobe XD, etc.
|
||||
- **Frontend Technologies:** Expert knowledge of HTML, CSS (including Tailwind, SCSS, CSS-in-JS), JavaScript/TypeScript, and modern frontend frameworks (React, Vue, Angular, etc.)
|
||||
- **Animation & Interaction:** Can design and implement subtle, purposeful animations and interactive elements that enhance usability
|
||||
- **Performance Optimization:** Considers loading performance, rendering efficiency, and overall technical impact of design decisions
|
||||
|
||||
### Working Process
|
||||
|
||||
1. **Requirements Clarification:** Begins by ensuring complete understanding of the project goals, user needs, and technical constraints
|
||||
2. **Visual Exploration:** Rapidly generates multiple design directions or components based on requirements
|
||||
3. **Iterative Refinement:** Presents options, gathers feedback, and refines toward final designs
|
||||
4. **Component Specification:** Defines reusable components with variants, states, and behaviors
|
||||
5. **Implementation:** Generates production-ready code or detailed specifications for development
|
||||
6. **Design System Integration:** Ensures all new elements fit within (or thoughtfully extend) the existing design system
|
||||
|
||||
### Activation Instructions
|
||||
|
||||
When engaging with this persona, provide:
|
||||
1. A clear description of what you need designed/built
|
||||
2. Any brand guidelines, color preferences, or stylistic direction
|
||||
3. Information about the target users and their needs
|
||||
4. Technical constraints or platform requirements
|
||||
5. Examples of designs you like (optional but helpful)
|
||||
|
||||
The persona will respond with visual concepts, interactive prototypes, and/or implementation code based on your requirements.
|
||||
|
||||
==================== END: v0-ux-ui-architect ====================
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -136,13 +136,6 @@ story-dod-checklist:
|
|||
default_locations:
|
||||
- docs/stories/*.md
|
||||
|
||||
v0-component-quality-checklist:
|
||||
checklist_file: bmad-agent/checklists/v0-component-quality-checklist.md
|
||||
required_docs:
|
||||
- component-specification.md
|
||||
default_locations:
|
||||
- docs/components/*.md
|
||||
- src/components/**/*.tsx
|
||||
|
||||
==================== END: checklist-mappings ====================
|
||||
|
||||
|
|
@ -206,7 +199,7 @@ The BMAD Method uses various checklists to ensure quality and completeness of di
|
|||
- Look for evidence in the documentation that satisfies the requirement
|
||||
- Consider both explicit mentions and implicit coverage
|
||||
- Mark items as:
|
||||
- PASS: Requirement clearly met
|
||||
- ✅ PASS: Requirement clearly met
|
||||
- ⌠FAIL: Requirement not met or insufficient coverage
|
||||
- âš ï¸ PARTIAL: Some aspects covered but needs improvement
|
||||
- N/A: Not applicable to this case
|
||||
|
|
@ -696,90 +689,6 @@ To perform deep research effectively, please be aware:
|
|||
==================== END: create-deep-research-prompt ====================
|
||||
|
||||
|
||||
==================== START: create-design-system-components ====================
|
||||
# Task: Create Design System Components
|
||||
|
||||
## Objective
|
||||
Design and implement a cohesive set of reusable UI components that form a comprehensive design system, ensuring consistency, accessibility, and scalability across the application.
|
||||
|
||||
## Prerequisites
|
||||
- Brand guidelines or visual design direction
|
||||
- Technical stack information
|
||||
- Existing components or patterns (if available)
|
||||
- Accessibility requirements
|
||||
|
||||
## Process Steps
|
||||
|
||||
### 1. Design System Foundation
|
||||
- Define design tokens (colors, typography, spacing, etc.)
|
||||
- Establish naming conventions
|
||||
- Define component categories (atoms, molecules, organisms)
|
||||
- Create design principles and guidelines
|
||||
|
||||
### 2. Core Components Identification
|
||||
- Identify primitive components (buttons, inputs, etc.)
|
||||
- Identify composite components (cards, modals, etc.)
|
||||
- Identify layout components (grids, containers, etc.)
|
||||
- Identify specialized components (data tables, charts, etc.)
|
||||
|
||||
### 3. Component Specification
|
||||
- Define component props and variants
|
||||
- Document component states and behaviors
|
||||
- Define accessibility requirements
|
||||
- Document responsive behavior
|
||||
|
||||
### 4. Implementation Strategy
|
||||
- Determine component architecture
|
||||
- Define styling approach
|
||||
- Plan component documentation
|
||||
- Establish testing strategy
|
||||
|
||||
### 5. Component Implementation
|
||||
- Create base components
|
||||
- Implement variants and states
|
||||
- Add accessibility features
|
||||
- Ensure responsive behavior
|
||||
- Add proper documentation
|
||||
|
||||
### 6. Design System Documentation
|
||||
- Create usage guidelines
|
||||
- Document component API
|
||||
- Provide examples and patterns
|
||||
- Create visual documentation
|
||||
|
||||
### 7. Testing & Validation
|
||||
- Test components across devices and browsers
|
||||
- Validate accessibility compliance
|
||||
- Perform visual regression testing
|
||||
- Validate component API usability
|
||||
|
||||
## IDE-Specific Considerations
|
||||
|
||||
### Implementation in IDE Environments
|
||||
- Structure components for easy discovery and usage
|
||||
- Create appropriate folder structure
|
||||
- Implement consistent patterns across components
|
||||
- Ensure proper typing and documentation
|
||||
|
||||
## Deliverables
|
||||
- Design system foundation (tokens, principles)
|
||||
- Core component library
|
||||
- Component documentation
|
||||
- Usage examples
|
||||
- Testing suite
|
||||
|
||||
## Success Criteria
|
||||
- Components follow consistent patterns
|
||||
- Components are accessible
|
||||
- Components are responsive
|
||||
- Components are well-documented
|
||||
- Components are properly tested
|
||||
- Components are easy to use and extend
|
||||
- Design system is cohesive and scalable
|
||||
|
||||
==================== END: create-design-system-components ====================
|
||||
|
||||
|
||||
==================== START: create-doc-from-template ====================
|
||||
# Create Document from Template Task
|
||||
|
||||
|
|
@ -1773,102 +1682,6 @@ Would you like to proceed with document sharding? Please provide the required in
|
|||
==================== END: doc-sharding-task ====================
|
||||
|
||||
|
||||
==================== START: implement-components-ide ====================
|
||||
# Task: Implement Components in IDE Environment
|
||||
|
||||
## Objective
|
||||
Transform design requirements into production-ready frontend components directly in the IDE environment, optimizing for immediate implementation and integration.
|
||||
|
||||
## Prerequisites
|
||||
- Project structure and tech stack information
|
||||
- Design requirements or component specifications
|
||||
- Access to an IDE with AI capabilities (Cursor, Cline, Claude Code, Roocode)
|
||||
|
||||
## Process Steps
|
||||
|
||||
### 1. Project Context Analysis
|
||||
- Analyze the existing project structure
|
||||
- Identify the frontend framework and libraries in use
|
||||
- Determine styling approach (CSS, Tailwind, styled-components, etc.)
|
||||
- Identify existing component patterns and conventions
|
||||
|
||||
### 2. Component Architecture Planning
|
||||
- Define the component hierarchy
|
||||
- Determine required props and state
|
||||
- Plan file structure for components
|
||||
- Identify reusable sub-components
|
||||
|
||||
### 3. Implementation Strategy
|
||||
- Determine implementation approach based on project context
|
||||
- Plan file creation sequence
|
||||
- Identify potential dependencies to add
|
||||
- Consider testing strategy
|
||||
|
||||
### 4. Component Implementation
|
||||
- Create component files with proper structure
|
||||
- Implement component logic and rendering
|
||||
- Add styling according to project conventions
|
||||
- Implement responsive behavior
|
||||
- Add accessibility features
|
||||
- Implement state management
|
||||
|
||||
### 5. Testing & Validation
|
||||
- Create unit tests for components
|
||||
- Verify responsive behavior
|
||||
- Validate accessibility compliance
|
||||
- Test edge cases and error states
|
||||
|
||||
### 6. Integration
|
||||
- Update imports/exports as needed
|
||||
- Add components to relevant pages or parent components
|
||||
- Update navigation or routing if needed
|
||||
- Document usage examples
|
||||
|
||||
### 7. Documentation
|
||||
- Add JSDoc comments to components
|
||||
- Create README documentation if appropriate
|
||||
- Add Storybook stories if applicable
|
||||
|
||||
## IDE-Specific Considerations
|
||||
|
||||
### Cursor AI
|
||||
- Leverage multi-file creation capabilities
|
||||
- Use Cursor's codebase understanding for consistent implementation
|
||||
- Utilize command palette for efficient workflow
|
||||
|
||||
### Cline (Claude Dev)
|
||||
- Use terminal integration for dependency management
|
||||
- Leverage project-wide understanding for consistent implementation
|
||||
- Utilize Cline's ability to understand complex component relationships
|
||||
|
||||
### Claude Code
|
||||
- Focus on code quality and best practices
|
||||
- Emphasize accessibility implementation
|
||||
- Prioritize comprehensive documentation
|
||||
|
||||
### Roocode
|
||||
- Emphasize visual feedback loop
|
||||
- Focus on rapid prototyping and iteration
|
||||
- Leverage component library integration
|
||||
|
||||
## Deliverables
|
||||
- Implemented component files
|
||||
- Associated test files
|
||||
- Documentation and usage examples
|
||||
- Integration instructions
|
||||
|
||||
## Success Criteria
|
||||
- Components render correctly
|
||||
- Components are responsive
|
||||
- Components are accessible
|
||||
- Components follow project conventions
|
||||
- Components are properly tested
|
||||
- Components are well-documented
|
||||
- Components integrate with existing codebase
|
||||
|
||||
==================== END: implement-components-ide ====================
|
||||
|
||||
|
||||
==================== START: library-indexing-task ====================
|
||||
# Library Indexing Task
|
||||
|
||||
|
|
@ -1991,80 +1804,6 @@ Would you like to proceed with library indexing? Please provide the required inp
|
|||
==================== END: library-indexing-task ====================
|
||||
|
||||
|
||||
==================== START: rapid-prototype-from-brief ====================
|
||||
# Task: Rapid Prototype from Brief
|
||||
|
||||
## Objective
|
||||
Transform a project brief or requirements document into a visual prototype and implementation-ready frontend components in a rapid timeframe, focusing on key user flows and core functionality.
|
||||
|
||||
## Prerequisites
|
||||
- Project brief or requirements document
|
||||
- Technical constraints and platform information
|
||||
- Brand guidelines or design direction (if available)
|
||||
- User personas or target audience information
|
||||
|
||||
## Process Steps
|
||||
|
||||
### 1. Brief Analysis
|
||||
- Extract key requirements and user needs
|
||||
- Identify core functionality and primary user flows
|
||||
- Determine technical constraints and platform requirements
|
||||
- Note any specific design direction or brand guidelines
|
||||
|
||||
### 2. Information Architecture
|
||||
- Define key screens and components
|
||||
- Map user flows and navigation
|
||||
- Identify reusable patterns and components
|
||||
- Create simple site/app map
|
||||
|
||||
### 3. Rapid Visual Exploration
|
||||
- Generate multiple visual directions based on requirements
|
||||
- Create low-fidelity wireframes for key screens
|
||||
- Explore component patterns and design system elements
|
||||
- Establish visual hierarchy and layout principles
|
||||
|
||||
### 4. Core Component Design
|
||||
- Design key UI components needed for core functionality
|
||||
- Define component variants and states
|
||||
- Ensure responsive behavior across device sizes
|
||||
- Apply accessibility best practices
|
||||
|
||||
### 5. Prototype Implementation
|
||||
- Implement core screens and components in code
|
||||
- Focus on functional prototype over comprehensive implementation
|
||||
- Ensure responsive behavior works across target devices
|
||||
- Implement key interactions and state transitions
|
||||
|
||||
### 6. Validation & Iteration
|
||||
- Review prototype against requirements
|
||||
- Identify gaps and areas for improvement
|
||||
- Gather feedback on usability and visual design
|
||||
- Iterate on design and implementation as needed
|
||||
|
||||
### 7. Documentation & Handoff
|
||||
- Document component specifications
|
||||
- Create implementation notes for developers
|
||||
- Provide design system documentation
|
||||
- Outline next steps for full implementation
|
||||
|
||||
## Deliverables
|
||||
- Visual design concepts
|
||||
- Interactive prototype
|
||||
- Core component implementations
|
||||
- Design system foundation
|
||||
- Implementation documentation
|
||||
|
||||
## Success Criteria
|
||||
- Prototype addresses core requirements from brief
|
||||
- Design is visually cohesive and on-brand
|
||||
- Components are reusable and well-structured
|
||||
- Implementation is responsive and accessible
|
||||
- Prototype demonstrates key user flows
|
||||
- Documentation provides clear path to full implementation
|
||||
|
||||
==================== END: rapid-prototype-from-brief ====================
|
||||
|
||||
|
||||
==================== START: review-infrastructure ====================
|
||||
# Infrastructure Review Task
|
||||
|
||||
|
|
@ -2385,5 +2124,3 @@ After I perform the selected action, we can discuss the outcome and decide on an
|
|||
REPEAT by Asking the user if they would like to perform another Reflective, Elicitation & Brainstorming Action UNTIL the user indicates it is time to proceed to the next section (or selects #8)
|
||||
|
||||
==================== END: validate-infrastructure ====================
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1007,153 +1007,6 @@ _Repeat the above template for each significant component._
|
|||
==================== END: front-end-spec-tmpl ====================
|
||||
|
||||
|
||||
==================== START: ide-component-structure-tmpl ====================
|
||||
# IDE Component Structure Template
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
{component-name}/
|
||||
├── index.ts # Main export file
|
||||
├── {component-name}.tsx # Component implementation
|
||||
├── {component-name}.test.tsx # Component tests
|
||||
├── {component-name}.module.css # Component styles (if using CSS modules)
|
||||
├── {component-name}.stories.tsx # Storybook stories (if applicable)
|
||||
└── types.ts # TypeScript types (if complex enough to warrant separation)
|
||||
```
|
||||
|
||||
## Component Implementation File ({component-name}.tsx)
|
||||
|
||||
```tsx
|
||||
import React from 'react';
|
||||
import styles from './{component-name}.module.css'; // If using CSS modules
|
||||
|
||||
// Types
|
||||
interface {ComponentName}Props {
|
||||
// Props definition
|
||||
}
|
||||
|
||||
/**
|
||||
* {ComponentName} - {Brief description}
|
||||
*
|
||||
* @param {Object} props - Component props
|
||||
* @returns {JSX.Element} - Rendered component
|
||||
*/
|
||||
export const {ComponentName} = ({
|
||||
// Destructured props with defaults
|
||||
}: {ComponentName}Props): JSX.Element => {
|
||||
// State hooks
|
||||
|
||||
// Effect hooks
|
||||
|
||||
// Handler functions
|
||||
|
||||
// Helper functions
|
||||
|
||||
// Render
|
||||
return (
|
||||
// JSX implementation
|
||||
);
|
||||
};
|
||||
|
||||
export default {ComponentName};
|
||||
```
|
||||
|
||||
## Test File ({component-name}.test.tsx)
|
||||
|
||||
```tsx
|
||||
import React from 'react';
|
||||
import { render, screen, fireEvent } from '@testing-library/react';
|
||||
import { {ComponentName} } from './{component-name}';
|
||||
|
||||
describe('{ComponentName}', () => {
|
||||
it('renders correctly', () => {
|
||||
// Test implementation
|
||||
});
|
||||
|
||||
it('handles interactions correctly', () => {
|
||||
// Test implementation
|
||||
});
|
||||
|
||||
it('applies correct styles for different states', () => {
|
||||
// Test implementation
|
||||
});
|
||||
|
||||
// Additional tests
|
||||
});
|
||||
```
|
||||
|
||||
## Storybook File ({component-name}.stories.tsx)
|
||||
|
||||
```tsx
|
||||
import type { Meta, StoryObj } from '@storybook/react';
|
||||
import { {ComponentName} } from './{component-name}';
|
||||
|
||||
const meta: Meta<typeof {ComponentName}> = {
|
||||
title: 'Components/{ComponentName}',
|
||||
component: {ComponentName},
|
||||
parameters: {
|
||||
layout: 'centered',
|
||||
},
|
||||
tags: ['autodocs'],
|
||||
argTypes: {
|
||||
// Arg types definition
|
||||
},
|
||||
};
|
||||
|
||||
export default meta;
|
||||
type Story = StoryObj<typeof {ComponentName}>;
|
||||
|
||||
export const Default: Story = {
|
||||
args: {
|
||||
// Default props
|
||||
},
|
||||
};
|
||||
|
||||
export const Variant: Story = {
|
||||
args: {
|
||||
// Variant props
|
||||
},
|
||||
};
|
||||
|
||||
// Additional stories
|
||||
```
|
||||
|
||||
## Index File (index.ts)
|
||||
|
||||
```tsx
|
||||
export { {ComponentName} } from './{component-name}';
|
||||
export type { {ComponentName}Props } from './types'; // If using separate types file
|
||||
```
|
||||
|
||||
## Types File (types.ts) - If needed
|
||||
|
||||
```tsx
|
||||
export interface {ComponentName}Props {
|
||||
// Props definition
|
||||
}
|
||||
|
||||
// Additional types
|
||||
```
|
||||
|
||||
## Usage Example
|
||||
|
||||
```tsx
|
||||
import { {ComponentName} } from 'components/{component-name}';
|
||||
|
||||
const MyPage = () => {
|
||||
return (
|
||||
<div>
|
||||
<{ComponentName}
|
||||
// Props
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
==================== END: ide-component-structure-tmpl ====================
|
||||
|
||||
|
||||
==================== START: infrastructure-architecture-tmpl ====================
|
||||
# {Project Name} Infrastructure Architecture
|
||||
|
||||
|
|
@ -1666,102 +1519,3 @@ Hello {{users name}}, this is your foo report for {{todays date}}
|
|||
@{/example}
|
||||
|
||||
==================== END: template-format ====================
|
||||
|
||||
|
||||
==================== START: v0-component-spec-tmpl ====================
|
||||
# Component Specification: {Component Name}
|
||||
|
||||
## Overview
|
||||
**Purpose:** {Brief description of component purpose}
|
||||
**Type:** {Atomic/Molecular/Organism/Template/Page}
|
||||
**Status:** {Draft/In Review/Approved/Implemented}
|
||||
|
||||
## Visual Design
|
||||
{Screenshots/mockups of component in different states}
|
||||
|
||||
## Technical Specification
|
||||
|
||||
### Props Interface
|
||||
| Prop | Type | Required | Default | Description |
|
||||
|------|------|----------|---------|-------------|
|
||||
| {prop name} | {type} | {Yes/No} | {default value} | {description} |
|
||||
|
||||
### Component States
|
||||
- Default
|
||||
- Hover
|
||||
- Active
|
||||
- Disabled
|
||||
- Loading
|
||||
- Error
|
||||
- {Other states as needed}
|
||||
|
||||
### Accessibility Requirements
|
||||
- Keyboard navigation
|
||||
- Screen reader support
|
||||
- ARIA attributes
|
||||
- Focus management
|
||||
- Color contrast
|
||||
|
||||
### Responsive Behavior
|
||||
| Breakpoint | Behavior |
|
||||
|------------|----------|
|
||||
| Mobile | {description} |
|
||||
| Tablet | {description} |
|
||||
| Desktop | {description} |
|
||||
|
||||
## Implementation Code
|
||||
|
||||
### Component Structure
|
||||
```tsx
|
||||
// Component structure code
|
||||
```
|
||||
|
||||
### Styling
|
||||
```tsx
|
||||
// Styling code
|
||||
```
|
||||
|
||||
### Logic
|
||||
```tsx
|
||||
// Logic code
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Usage
|
||||
```tsx
|
||||
// Basic usage example
|
||||
```
|
||||
|
||||
### With Variants
|
||||
```tsx
|
||||
// Variant examples
|
||||
```
|
||||
|
||||
### With Different States
|
||||
```tsx
|
||||
// State examples
|
||||
```
|
||||
|
||||
## Testing Checklist
|
||||
- [ ] Visual regression tests
|
||||
- [ ] Accessibility audit
|
||||
- [ ] Cross-browser compatibility
|
||||
- [ ] Responsive behavior
|
||||
- [ ] State transitions
|
||||
- [ ] Edge cases
|
||||
|
||||
## Integration Notes
|
||||
- Dependencies required
|
||||
- Import/export patterns
|
||||
- Integration with other components
|
||||
- Known limitations
|
||||
|
||||
## Design System Alignment
|
||||
- How this component aligns with design tokens
|
||||
- Relationship to other components
|
||||
- Variations from design system (if any)
|
||||
|
||||
==================== END: v0-component-spec-tmpl ====================
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue