mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
* feat(docs): add Diataxis folder structure and update sidebar styling - Create tutorials, how-to, explanation, reference directories with subdirectories - Add index.md files for each main Diataxis section - Update homepage with Diataxis card navigation layout - Implement clean React Native-inspired sidebar styling - Convert sidebar to autogenerated for both Diataxis and legacy sections - Update docusaurus config with dark mode default and navbar changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): migrate Phase 1 files to Diataxis structure Move 21 files to new locations: - Tutorials: quick-start guides, agent creation guide - How-To: installation, customization, workflows - Explanation: core concepts, features, game-dev, builder - Reference: merged glossary from BMM and BMGD Also: - Copy images to new locations - Update internal links via migration script (73 links updated) - Build verified successfully 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(docs): add category labels for sidebar folders Add _category_.json files to control display labels and position for autogenerated sidebar categories. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * style(docs): improve welcome page and visual styling - Rewrite index.md with React Native-inspired welcoming layout - Add Diataxis section cards with descriptions - Remove sidebar separator, add spacing instead - Increase navbar padding with responsive breakpoints - Add rounded admonitions without left border bar - Use system font stack for better readability - Add lighter chevron styling in sidebar - Constrain max-width to 1600px for wide viewports 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use baseUrl in meta tag paths for correct deployment URLs * feat(docs): complete Phase 2 - split files and fix broken links Phase 2 of Diataxis migration: - Split 16 large legacy files into 42+ focused documents - Created FAQ section with 7 topic-specific files - Created brownfield how-to guides (3 files) - Created workflow how-to guides (15+ files) - Created architecture explanation files (3 files) - Created TEA/testing explanation files - Moved remaining legacy module files to proper Diataxis locations Link fixes: - Fixed ~50 broken internal links across documentation - Updated relative paths for new file locations - Created missing index files for installation, advanced tutorials - Simplified TOC anchors to fix Docusaurus warnings Cleanup: - Removed legacy sidebar entries for deleted folders - Deleted duplicate and empty placeholder files - Moved workflow diagram assets to tutorials/images 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(build): use file glob instead of sidebar parsing for llms-full.txt Replace brittle sidebar.js regex parsing with recursive file glob. The old approach captured non-file strings like 'autogenerated' and category labels, resulting in only 5 files being processed. Now correctly processes all 86+ markdown files (~95k tokens). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(seo): use absolute URLs in AI meta tags for agent discoverability AI web-browsing agents couldn't follow relative paths in meta tags due to URL security restrictions. Changed llms-full.txt and llms.txt meta tag URLs from relative (baseUrl) to absolute (urlParts.origin + baseUrl). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): recategorize misplaced files per Diataxis analysis Phase 2.5 categorization fixes based on post-migration analysis: Moved to correct Diataxis categories: - tutorials/installation.md → deleted (duplicate of how-to/install-bmad.md) - tutorials/brownfield-onboarding.md → how-to/brownfield/index.md - reference/faq/* (8 files) → explanation/faq/ - reference/agents/barry-quick-flow.md → explanation/agents/ - reference/agents/bmgd-agents.md → explanation/game-dev/agents.md Created: - explanation/agents/index.md Fixed all broken internal links (14 total) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add Getting Started tutorial and simplify build script - Add comprehensive Getting Started tutorial with installation as Step 1 - Simplify build-docs.js to read directly from docs/ (no consolidation) - Remove backup/restore dance that could corrupt docs folder on build failure - Remove ~150 lines of unused consolidation code 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(css): use fixed width layout to prevent content shifting Apply React Native docs approach: set both width and max-width at largest breakpoint (1400px) so content area maintains consistent size regardless of content length. Switches to fluid 100% below 1416px breakpoint. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): restructure tutorials with renamed entry point - Rename index.md to bmad-tutorial.md for clearer navigation - Remove redundant tutorials/index.md - Update sidebar and config references 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add tutorial style guide and AI agent announcement bar - Add docs/_contributing/ with tutorial style guide - Reformat quick-start-bmm.md and bmad-tutorial.md per style guide - Remove horizontal separators, add strategic admonitions - Add persistent announcement bar for AI agents directing to llms-full.txt - Fix footer broken link to tutorials 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): add markdown demo page and UI refinements - Add comprehensive markdown-demo.md for style testing - Remove doc category links from navbar (use sidebar instead) - Remove card buttons from welcome page - Add dark mode styling for announcement bar - Clean up index.md card layout 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(docs): apply unified tutorial style and update references - Reformat create-custom-agent.md to follow tutorial style guide - Update tutorial-style.md with complete unified structure - Update all internal references to renamed tutorial files - Remove obsolete advanced/index.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(docs): migrate from Docusaurus to Astro+Starlight Replace Docusaurus with Astro and the Starlight documentation theme for improved performance, better customization, and modern tooling. Build pipeline changes: - New build-docs.js orchestrates link checking, artifact generation, and Astro build in sequence - Add check-doc-links.js for validating internal links and anchors - Generate llms.txt and llms-full.txt for LLM-friendly documentation - Create downloadable source bundles (bmad-sources.zip, bmad-prompts.zip) - Suppress MODULE_TYPELESS_PACKAGE_JSON warning in Astro build - Output directly to build/site for cleaner deployment Website architecture: - Add rehype-markdown-links.js plugin to transform .md links to routes - Add site-url.js helper for GitHub Pages URL resolution with strict validation (throws on invalid GITHUB_REPOSITORY format) - Custom Astro components: Banner, Header, MobileMenuFooter - Symlink docs/ into website/src/content/docs for Starlight Documentation cleanup: - Remove Docusaurus _category_.json files (Starlight uses frontmatter) - Convert all docs to use YAML frontmatter with title field - Move downloads.md from website/src/pages to docs/ - Consolidate style guide and workflow diagram docs - Add 404.md and tutorials/index.md --------- Co-authored-by: forcetrainer <bryan@inagaki.us> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
170 lines
5.0 KiB
Markdown
170 lines
5.0 KiB
Markdown
---
|
|
title: "Quick Spec Flow"
|
|
description: Understanding Quick Spec Flow for rapid development in BMad Method
|
|
---
|
|
|
|
|
|
Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go straight to a context-aware technical specification and start coding.
|
|
|
|
**Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements
|
|
|
|
**Time to implementation:** Minutes, not hours
|
|
|
|
---
|
|
|
|
## When to Use Quick Flow
|
|
|
|
### ✅ Use Quick Flow when:
|
|
|
|
- Single bug fix or small enhancement
|
|
- Small feature with clear scope (typically 1-15 stories)
|
|
- Rapid prototyping or experimentation
|
|
- Adding to existing brownfield codebase
|
|
- You know exactly what you want to build
|
|
|
|
### ❌ Use BMad Method or Enterprise when:
|
|
|
|
- Building new products or major features
|
|
- Need stakeholder alignment
|
|
- Complex multi-team coordination
|
|
- Requires extensive planning and architecture
|
|
|
|
💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs!
|
|
|
|
---
|
|
|
|
## Quick Flow Overview
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
START[Step 1: Run Tech-Spec Workflow]
|
|
DETECT[Detects project stack]
|
|
ANALYZE[Analyzes brownfield codebase]
|
|
TEST[Detects test frameworks]
|
|
CONFIRM[Confirms conventions]
|
|
GENERATE[Generates context-rich tech-spec]
|
|
STORIES[Creates ready-to-implement stories]
|
|
IMPL[Step 2: Implement with DEV Agent]
|
|
DONE[DONE!]
|
|
|
|
START --> DETECT
|
|
DETECT --> ANALYZE
|
|
ANALYZE --> TEST
|
|
TEST --> CONFIRM
|
|
CONFIRM --> GENERATE
|
|
GENERATE --> STORIES
|
|
STORIES --> IMPL
|
|
IMPL --> DONE
|
|
|
|
style START fill:#bfb,stroke:#333,stroke-width:2px
|
|
style IMPL fill:#bbf,stroke:#333,stroke-width:2px
|
|
style DONE fill:#f9f,stroke:#333,stroke-width:3px
|
|
```
|
|
|
|
---
|
|
|
|
## What Makes It Quick
|
|
|
|
- ✅ No Product Brief needed
|
|
- ✅ No PRD needed
|
|
- ✅ No Architecture doc needed
|
|
- ✅ Auto-detects your stack
|
|
- ✅ Auto-analyzes brownfield code
|
|
- ✅ Auto-validates quality
|
|
- ✅ Story context optional (tech-spec is comprehensive!)
|
|
|
|
---
|
|
|
|
## Smart Context Discovery
|
|
|
|
Quick Spec Flow automatically discovers and uses:
|
|
|
|
### Existing Documentation
|
|
- Product briefs (if they exist)
|
|
- Research documents
|
|
- `document-project` output (brownfield codebase map)
|
|
|
|
### Project Stack
|
|
- **Node.js:** package.json → frameworks, dependencies, scripts
|
|
- **Python:** requirements.txt, pyproject.toml → packages, tools
|
|
- **Ruby:** Gemfile → gems and versions
|
|
- **Java:** pom.xml, build.gradle → Maven/Gradle dependencies
|
|
- **Go:** go.mod → modules
|
|
- **Rust:** Cargo.toml → crates
|
|
|
|
### Brownfield Code Patterns
|
|
- Directory structure and organization
|
|
- Existing code patterns (class-based, functional, MVC)
|
|
- Naming conventions
|
|
- Test frameworks and patterns
|
|
- Code style configurations
|
|
|
|
### Convention Confirmation
|
|
|
|
Quick Spec Flow detects your conventions and **asks for confirmation**:
|
|
|
|
```
|
|
I've detected these conventions in your codebase:
|
|
|
|
Code Style:
|
|
- ESLint with Airbnb config
|
|
- Prettier with single quotes
|
|
|
|
Test Patterns:
|
|
- Jest test framework
|
|
- .test.js file naming
|
|
|
|
Should I follow these existing conventions? (yes/no)
|
|
```
|
|
|
|
**You decide:** Conform to existing patterns or establish new standards!
|
|
|
|
---
|
|
|
|
## Auto-Validation
|
|
|
|
Quick Spec Flow **automatically validates** everything:
|
|
|
|
- ✅ Context gathering completeness
|
|
- ✅ Definitiveness (no "use X or Y" statements)
|
|
- ✅ Brownfield integration quality
|
|
- ✅ Stack alignment
|
|
- ✅ Implementation readiness
|
|
|
|
---
|
|
|
|
## Comparison: Quick Flow vs Full BMM
|
|
|
|
| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks |
|
|
| --------------------- | ---------------------------- | ---------------------------------- |
|
|
| **Setup** | None (standalone) | workflow-init recommended |
|
|
| **Planning Docs** | tech-spec.md only | Product Brief → PRD → Architecture |
|
|
| **Time to Code** | Minutes | Hours to days |
|
|
| **Best For** | Bug fixes, small features | New products, major features |
|
|
| **Context Discovery** | Automatic | Manual + guided |
|
|
| **Validation** | Auto-validates everything | Manual validation steps |
|
|
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
|
|
|
|
---
|
|
|
|
## When to Graduate to BMad Method
|
|
|
|
Start with Quick Flow, but switch to BMad Method when:
|
|
|
|
- ❌ Project grows beyond initial scope
|
|
- ❌ Multiple teams need coordination
|
|
- ❌ Stakeholders need formal documentation
|
|
- ❌ Product vision is unclear
|
|
- ❌ Architectural decisions need deep analysis
|
|
- ❌ Compliance/regulatory requirements exist
|
|
|
|
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
|
|
|
|
---
|
|
|
|
## Related
|
|
|
|
- [Create Tech Spec](../../how-to/workflows/create-tech-spec.md) - How to use Quick Flow
|
|
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started
|
|
- [Four Phases](../architecture/four-phases.md) - Understanding the full methodology
|