mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
91f6c41be1
* docs: radical reduction of documentation scope for v6 beta Archive and basement unreviewed content to ship a focused, minimal doc set. Changes: - Archive stale how-to workflow guides (will rewrite for v6) - Archive outdated explanation and reference content - Move unreviewed content to basement for later review - Reorganize TEA docs into dedicated /tea/ section - Add workflow-map visual reference page - Simplify getting-started tutorial and sidebar navigation - Add explanation pages: brainstorming, adversarial-review, party-mode, quick-flow, advanced-elicitation - Fix base URL handling for subdirectory deployments (GitHub Pages forks) The goal is a minimal, accurate doc set for beta rather than comprehensive but potentially misleading content. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor: restructure BMM and agents documentation by consolidating and flattening index files. --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1.7 KiB
1.7 KiB
title, description
| title | description |
|---|---|
| How to Document an Existing Project | How to document an existing brownfield codebase using BMad Method |
Use the document-project workflow to scan your entire codebase and generate comprehensive documentation about its current state.
When to Use This
- Starting work on an undocumented legacy project
- Documentation is outdated and needs refresh
- AI agents need context about existing code patterns
- Onboarding new team members
:::note[Prerequisites]
- BMad Method installed in your project
- Access to the codebase you want to document :::
Steps
1. Load the Analyst Agent
Start a fresh chat and load the Analyst agent.
2. Run the document-project Workflow
Tell the agent:
Run the document-project workflow
3. Let the Agent Scan Your Codebase
The workflow will:
- Scan your codebase structure
- Identify architecture patterns
- Document the technology stack
- Create reference documentation
- Generate a PRD-like document from existing code
4. Review the Generated Documentation
The output will be saved to project-documentation-{date}.md in your output folder.
Review the documentation for:
- Accuracy of detected patterns
- Completeness of architecture description
- Any missing business rules or intent
What You Get
- Project overview - High-level description of what the project does
- Technology stack - Detected frameworks, libraries, and tools
- Architecture patterns - Code organization and design patterns found
- Business rules - Logic extracted from the codebase
- Integration points - External APIs and services
Tips
- Run this before any major brownfield work
- Keep the documentation updated as the project evolves
- Use it as input for future PRD creation