ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity
BMAD-METHOD/docs/how-to/established-projects.md

4.4 KiB
Raw Blame History

title description sidebar
Established Projects How to use BMad Method on existing codebases
order
6

Use BMad Method effectively when working on existing projects and legacy codebases.

This guide covers the essential workflow for onboarding to existing projects with BMad Method.

:::note[Prerequisites]

  • BMad Method installed (npx bmad-method install)
  • An existing codebase you want to work on
  • Access to an AI-powered IDE (Claude Code or Cursor) :::

Step 1: Clean Up Completed Planning Artifacts

If you have completed all PRD epics and stories through the BMad process, clean up those files. Archive them, delete them, or rely on version history if needed. Do not keep these files in:

  • docs/
  • _bmad-output/planning-artifacts/
  • _bmad-output/implementation-artifacts/

Step 2: Create Project Context

:::tip[Recommended for Existing Projects] Generate project-context.md to capture your existing codebase patterns and conventions. This ensures AI agents follow your established practices when implementing changes. :::

Run the generate project context workflow:

bmad-generate-project-context

This scans your codebase to identify:

  • Technology stack and versions
  • Code organization patterns
  • Naming conventions
  • Testing approaches
  • Framework-specific patterns

You can review and refine the generated file, or create it manually at _bmad-output/project-context.md if you prefer.

Learn more about project context

Step 3: Maintain Quality Project Documentation

Your docs/ folder should contain succinct, well-organized documentation that accurately represents your project:

  • Intent and business rationale
  • Business rules
  • Architecture
  • Any other relevant project information

For complex projects, consider using the bmad-document-project workflow. It offers runtime variants that will scan your entire project and document its actual current state.

Step 3: Get Help

BMad-Help: Your Starting Point

Run bmad-help anytime you're unsure what to do next. This intelligent guide:

  • Inspects your project to see what's already been done
  • Shows options based on your installed modules
  • Understands natural language queries
bmad-help I have an existing Rails app, where should I start?
bmad-help What's the difference between quick-flow and full method?
bmad-help Show me what workflows are available

BMad-Help also automatically runs at the end of every workflow, providing clear guidance on exactly what to do next.

Choosing Your Approach

You have two primary options depending on the scope of changes:

Scope Recommended Approach
Small updates or additions Use bmad-quick-flow-solo-dev to create a tech-spec and implement the change. The full four-phase BMad Method is likely overkill.
Major changes or additions Start with the BMad Method, applying as much or as little rigor as needed.

During PRD Creation

When creating a brief or jumping directly into the PRD, ensure the agent:

  • Finds and analyzes your existing project documentation
  • Reads the proper context about your current system

You can guide the agent explicitly, but the goal is to ensure the new feature integrates well with your existing system.

UX Considerations

UX work is optional. The decision depends not on whether your project has a UX, but on:

  • Whether you will be working on UX changes
  • Whether significant new UX designs or patterns are needed

If your changes amount to simple updates to existing screens you are happy with, a full UX process is unnecessary.

Architecture Considerations

When doing architecture, ensure the architect:

  • Uses the proper documented files
  • Scans the existing codebase

Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.

More Information