BMAD-METHOD/docs/ide-setup-guides/cursor-ai-setup.md

237 lines
7.3 KiB
Markdown

# Setting Up BMAD Method in Cursor AI
This guide explains how to effectively use the BMAD Method within Cursor AI through documentation loading and structured prompt techniques.
## Overview
The BMAD Method integrates with Cursor AI through **methodology application** rather than software installation. This involves loading BMAD documentation into your workspace and structuring your AI interactions using BMAD principles.
## Setup Process
### 1. Workspace Preparation
**Clone BMAD Repository:**
```bash
git clone https://github.com/bmadcode/BMAD-METHOD.git
cd BMAD-METHOD
```
**Open in Cursor AI:**
- Launch Cursor AI
- Open the BMAD-METHOD folder as your workspace
- Ensure Cursor has access to read all documentation files
### 2. Documentation Loading Strategy
**Essential Files to Reference:**
- `bmad-agent/personas/` - Core persona definitions
- `bmad-agent/tasks/` - Task libraries and workflows
- `bmad-agent/templates/` - Document templates
- `bmad-agent/checklists/` - Quality validation checklists
**Context Management:**
- Keep relevant persona files open in tabs
- Reference task definitions when starting new work
- Use templates as starting points for deliverables
### 3. Persona Activation Technique
**Basic Activation Pattern:**
```
Load the [persona name] from bmad-agent/personas/[persona-file].md
I need help with [specific task] following BMAD methodology.
Use the [template name] template and apply [checklist name] quality standards.
```
**Example Activation:**
```
Load the Product Manager persona from bmad-agent/personas/pm.md
I need help creating a PRD for a new user authentication feature.
Use the PRD template and apply the PM quality checklist.
```
## Usage Workflows
### Project Initiation Workflow
1. **Load Project Context:**
- Open relevant BMAD documentation in Cursor
- Prepare project requirements and constraints
- Identify which personas you'll need
2. **Activate Primary Persona:**
```
Acting as John (Product Manager) from BMAD Method, help me define
requirements for [project description]. Reference the PRD template
and follow PM quality standards.
```
3. **Generate Initial Deliverables:**
- Use persona-specific templates
- Apply quality checklists for validation
- Iterate based on feedback
### Feature Development Workflow
1. **Requirements Analysis (PM Persona):**
```
Load John (PM) persona. Analyze these requirements: [requirements]
Create user stories following the story template.
```
2. **Architecture Design (Architect Persona):**
```
Load Fred (Architect) persona. Based on these requirements: [requirements]
Design system architecture using the architecture template.
```
3. **Implementation Planning (Developer Persona):**
```
Load David (Developer) persona. Based on this architecture: [architecture]
Create implementation plan following development best practices.
```
### Design System Creation Workflow
1. **UX/UI Planning (UX/UI Architect):**
```
Load Veronica (UX/UI Architect) persona. Create design system
components for [project]. Use v0 component specifications.
```
2. **Component Implementation:**
```
Following the UX/UI specifications, implement these components
using React and Tailwind CSS. Apply component quality checklist.
```
## Advanced Techniques
### Multi-Persona Collaboration
**Handoff Pattern:**
```
Transition from [current persona] to [next persona].
Context: [previous deliverable]
Next task: [specific task for new persona]
Maintain consistency with previous work.
```
**Example Handoff:**
```
Transition from John (PM) to Fred (Architect).
Context: PRD for user authentication system
Next task: Design secure authentication architecture
Maintain consistency with PRD requirements.
```
### Context Preservation
**Session Management:**
- Save important outputs as reference files
- Maintain project context across sessions
- Use consistent naming conventions
**Context Refresh:**
```
Refresh project context:
- Project: [project name]
- Current phase: [development phase]
- Active persona: [persona name]
- Last deliverable: [deliverable summary]
```
### Quality Validation
**Checklist Application:**
```
Validate this [deliverable type] against the [checklist name]:
[paste deliverable content]
Provide improvement recommendations.
```
**Peer Review Simulation:**
```
Acting as [different persona], review this [deliverable] created by [original persona].
Provide feedback and suggestions for improvement.
```
## Best Practices
### Documentation Organization
- Keep BMAD files organized in your workspace
- Create project-specific folders for outputs
- Maintain version control for generated content
### Prompt Structuring
- Always specify the persona you're activating
- Reference specific templates and checklists
- Provide clear context and requirements
### Quality Assurance
- Use BMAD quality checklists consistently
- Validate outputs against methodology standards
- Conduct regular methodology compliance reviews
### Team Collaboration
- Share BMAD workspace setup with team members
- Establish common persona usage patterns
- Document project-specific methodology adaptations
## Troubleshooting
### Common Issues and Solutions
**Issue: Persona Not Responding Correctly**
- **Solution**: Ensure persona file is loaded and referenced explicitly
- **Check**: Verify you're using the correct persona name and file path
**Issue: Inconsistent Output Quality**
- **Solution**: Always reference appropriate quality checklists
- **Check**: Confirm you're following the complete workflow for the persona
**Issue: Context Loss During Long Sessions**
- **Solution**: Regularly refresh context with key project information
- **Check**: Reload persona documentation periodically
**Issue: Unclear Task Assignment**
- **Solution**: Reference the task library for persona-specific capabilities
- **Check**: Ensure you're using the right persona for the task type
### Performance Optimization
**Memory Management:**
- Close unnecessary files to maintain performance
- Focus on relevant documentation for current tasks
- Clear chat history when switching between major project phases
**Response Quality:**
- Provide specific, detailed requirements
- Reference concrete examples when possible
- Use iterative refinement for complex deliverables
## Integration with Other Tools
### Version Control Integration
```bash
# Save BMAD outputs to version control
git add docs/bmad-outputs/
git commit -m "Add BMAD methodology outputs for [feature]"
```
### Documentation Systems
- Export BMAD outputs to your documentation platform
- Maintain links between BMAD templates and final documentation
- Use consistent formatting across all outputs
### Project Management Tools
- Create tasks based on BMAD persona workflows
- Use BMAD quality checklists as acceptance criteria
- Track methodology compliance in project metrics
## Conclusion
The BMAD Method in Cursor AI provides a powerful framework for structured, high-quality development work. By following these setup and usage patterns, you can leverage the full potential of BMAD methodology to improve your development process and deliverable quality.
Remember that BMAD is a methodology framework - its power comes from consistent application of its principles rather than technical configuration. Focus on understanding the personas, following the workflows, and applying the quality standards to achieve the best results.