mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
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>
3.5 KiB
3.5 KiB
title, description
| title | description |
|---|---|
| How to Create Architecture | How to create system architecture using the BMad Method |
Use the architecture workflow to make technical decisions explicit and prevent agent conflicts during implementation.
When to Use This
- Multi-epic projects (BMad Method, Enterprise)
- Cross-cutting technical concerns
- Multiple agents implementing different parts
- Integration complexity exists
- Technology choices need alignment
When to Skip This
- Quick Flow (simple changes)
- BMad Method Simple with straightforward tech stack
- Single epic with clear technical approach
:::note[Prerequisites]
- BMad Method installed
- Architect agent available
- PRD completed :::
Steps
1. Load the Architect Agent
Start a fresh chat and load the Architect agent.
2. Run the Architecture Workflow
*create-architecture
3. Engage in Discovery
This is NOT a template filler. The architecture workflow:
- Discovers technical needs through conversation
- Proposes architectural options with trade-offs
- Documents decisions that prevent agent conflicts
- Focuses on decision points, not exhaustive documentation
4. Document Key Decisions
Work with the agent to create Architecture Decision Records (ADRs) for significant choices.
5. Review the Architecture
The agent produces a decision-focused architecture document.
What You Get
An architecture.md document containing:
- Architecture Overview — System context, principles, style
- System Architecture — High-level diagram, component interactions
- Data Architecture — Database design, state management, caching
- API Architecture — API style (REST/GraphQL/gRPC), auth, versioning
- Frontend Architecture — Framework, state management, components
- Integration Architecture — Third-party integrations, messaging
- Security Architecture — Auth/authorization, data protection
- Deployment Architecture — CI/CD, environments, monitoring
- ADRs — Key decisions with context, options, rationale
- FR/NFR-Specific Guidance — Technical approach per requirement
- Standards and Conventions — Directory structure, naming, testing
ADR Format
## ADR-001: Use GraphQL for All APIs
**Status:** Accepted | **Date:** 2025-11-02
**Context:** PRD requires flexible querying across multiple epics
**Decision:** Use GraphQL for all client-server communication
**Options Considered:**
1. REST - Familiar but requires multiple endpoints
2. GraphQL - Flexible querying, learning curve
3. gRPC - High performance, poor browser support
**Rationale:**
- PRD requires flexible data fetching (Epic 1, 3)
- Mobile app needs bandwidth optimization (Epic 2)
- Team has GraphQL experience
**Consequences:**
- Positive: Flexible querying, reduced versioning
- Negative: Caching complexity, N+1 query risk
- Mitigation: Use DataLoader for batching
Example
E-commerce platform produces:
- Monolith + PostgreSQL + Redis + Next.js + GraphQL
- ADRs explaining each choice
- FR/NFR-specific implementation guidance
Tips
- Focus on decisions that prevent conflicts — Multiple agents need alignment
- Use ADRs for every significant choice — Document the "why"
- Keep it practical — Don't over-architect
- Architecture is living — Update as you learn
Next Steps
After architecture:
- Create Epics and Stories — Work breakdown informed by architecture
- Implementation Readiness — Gate check before Phase 4