mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
e535f94325
Style Guide Additions: - Add Reference Structure section with 6 document types (Index, Catalog, Deep-Dive, Configuration, Glossary, Comprehensive) - Add Glossary Structure section with table-based format leveraging Starlight's right-nav for navigation - Include checklists for both new document types Reference Docs Updated: - agents/index.md: Catalog format, universal commands tip admonition - configuration/core-tasks.md: Configuration format with admonitions - configuration/global-config.md: Table-based config reference - workflows/index.md: Minimal index format - workflows/core-workflows.md: Catalog format - workflows/document-project.md: Deep-dive with Quick Facts admonition - workflows/bmgd-workflows.md: Comprehensive format, removed ~30 hr rules Glossary Rewritten: - Converted from 373 lines with ### headers to 123 lines with tables - Right nav now shows 9 categories instead of 50+ terms - Added italic context markers (*BMGD.*, *Brownfield.*, etc.) - Alphabetized terms within categories - Removed redundant inline TOC All Docs: - Remove horizontal rules (---) per style guide - Remove "Related" sections (sidebar handles navigation) - Standardize admonition usage - Archive deleted workflow customization docs 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