mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
96f21be73e
* docs: optimize style guide for LLM readers Restructure documentation style guide with dependency-first ordering and LLM-optimized content based on editorial-review-structure analysis. Key changes: - Add Universal Formatting Rules section at top (consolidated anti-patterns) - Move Visual Hierarchy and formatting rules before document types - Add Document Types decision table for type selection - Move Before/After example to follow Visual Hierarchy - Merge Links/Images into single Assets table - Move tutorial-specific checklist into Tutorial Structure section - Move Validation Steps to end (submission workflow) - Cut abstract Quick Principles (no execution value for LLMs) - Remove emotional/orientation language throughout - Condense FAQ Sections structure Result: ~35% reduction (539 deletions, 383 insertions) with improved parseability for AI agents writing documentation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: clarify explanation checklist admonition limit Disambiguate 2-3 admonitions max to explicitly show it is a per-document limit that still respects the universal per-section rule. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: clarify header budget vs structure template relationship Add note explaining that structure templates show content flow, not 1:1 header mapping. Admonitions and inline elements are within sections. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: remove horizontal rules to follow own guidelines Remove all --- section separators to comply with Universal Formatting Rules. The ## headers provide sufficient visual separation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: address PR review findings for style guide - Fix forward reference in Header Budget section - Clarify descriptions rule scope (tables and 5+ item lists) - Restore realistic FAQ examples - Add qualifier to admonition content length guideline Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: further optimize style guide as delta-only document - Add opener declaring adherence to Google Style Guide and Diataxis - Remove generic Google style guide sections (Visual Hierarchy patterns, Tables constraints, Code Blocks, Lists, Assets) - Remove Diataxis explainer content (Document Types table, "X documents do Y" explanatory sentences, Before/After example) - Keep all project-specific structure templates and checklists - Consolidate rules into single Project-Specific Rules table Result: 367 lines (down from 597), pure delta document assuming LLM training knowledge of baseline standards. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
BMad Method
Build More, Architect Dreams — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
100% free and open source. No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
Why BMad?
Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking.
- Scale-Adaptive: Automatically adjusts planning depth based on project complexity (Level 0-4)
- Structured Workflows: Grounded in agile best practices across analysis, planning, architecture, and implementation
- Specialized Agents: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
- Complete Lifecycle: From brainstorming to deployment, with just-in-time documentation
Quick Start
Prerequisites: Node.js v20+
npx bmad-method@alpha install
Follow the installer prompts to configure your project. Then run:
*workflow-init
This analyzes your project and recommends a track:
| Track | Best For | Time to First Story |
|---|---|---|
| Quick Flow | Bug fixes, small features | ~5 minutes |
| BMad Method | Products and platforms | ~15 minutes |
| Enterprise | Compliance-heavy systems | ~30 minutes |
Modules
| Module | Purpose |
|---|---|
| BMad Method (BMM) | Core agile development with 34 workflows across 4 phases |
| BMad Builder (BMB) | Create custom agents and domain-specific modules |
| Creative Intelligence Suite (CIS) | Innovation, brainstorming, and problem-solving |
Documentation
Full Documentation — Tutorials, how-to guides, concepts, and reference
For v4 Users
Community
- Discord — Get help, share ideas, collaborate
- YouTube — Tutorials, master class, and podcast (launching Feb 2025)
- GitHub Issues — Bug reports and feature requests
- Discussions — Community conversations
Support BMad
BMad is free for everyone — and always will be. If you'd like to support development:
- ⭐ Star us on GitHub — Helps others discover BMad
- 📺 Subscribe on YouTube — Master class launching Feb 2026
- ☕ Buy Me a Coffee — Fuel the development
- 🏢 Corporate sponsorship — DM on Discord
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (Discord)
Contributing
We welcome contributions! See CONTRIBUTING.md for guidelines.
License
MIT License — see LICENSE for details.
BMad and BMAD-METHOD are trademarks of BMad Code, LLC.