ros/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-01-30 04:32:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add how-to guide for getting BMAD answers + fix Discord channels (#1265)

Browse Source 
* docs: add how-to guide for getting BMAD answers + fix Discord channels

- New guide: docs/how-to/get-answers-about-bmad.md
  Teaches users to point LLMs at BMAD sources for self-serve answers

- Fixed outdated Discord channel references across 8 files:
  #general-dev → #bmad-development
  #bugs-issues → #report-bugs-and-issues
  Added #suggestions-feedback and #bmad-method-help where appropriate

* docs: add Mayakovsky-style poem to how-to guide
This commit is contained in:
Alex Verkhovsky
2026-01-07 00:05:05 -08:00
committed by GitHub
parent 2e16650067
commit 692f14f2e7
9 changed files with 115 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@@ -4,8 +4,9 @@ Thank you for considering contributing to the BMad project! We believe in **Huma
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions:
- **#general-dev** - Technical discussions, feature ideas, and development questions
- **#bugs-issues** - Bug reports and issue discussions
- **#bmad-development** - Technical discussions and development questions
- **#suggestions-feedback** - Feature ideas and suggestions
- **#report-bugs-and-issues** - Bug reports and issue discussions
## Our Philosophy
@@ -56,7 +57,7 @@ Every contribution should strengthen human-AI collaboration. Ask yourself: **"Do
### Reporting Bugs
1. **Check existing issues** first to avoid duplicates
2. **Consider discussing in Discord** (#bugs-issues channel) for quick help
2. **Consider discussing in Discord** (#report-bugs-and-issues channel) for quick help
3. **Use the bug report template** when creating a new issue - it guides you through providing:
- Clear bug description
- Steps to reproduce
@@ -67,7 +68,7 @@ Every contribution should strengthen human-AI collaboration. Ask yourself: **"Do
### Suggesting Features or New Modules
1. **Discuss first in Discord** (#general-dev channel) - the feature request template asks if you've done this
1. **Discuss first in Discord** (#suggestions-feedback channel) - the feature request template asks if you've done this
2. **Check existing issues and discussions** to avoid duplicates
3. **Use the feature request template** when creating an issue
4. **Be specific** about why this feature would benefit the BMad community and strengthen human-AI collaboration
@@ -77,7 +78,7 @@ Every contribution should strengthen human-AI collaboration. Ask yourself: **"Do
⚠️ **Required before submitting PRs:**
1. **For bugs**: Check if an issue exists (create one using the bug template if not)
2. **For features**: Discuss in Discord (#general-dev) AND create a feature request issue
2. **For features**: Discuss in Discord (#suggestions-feedback) AND create a feature request issue
3. **For large changes**: Always open an issue first to discuss alignment
Please propose small, granular changes! For large or significant changes, discuss in Discord and open an issue first. This prevents wasted effort on PRs that may not align with planned changes.
@@ -251,8 +252,9 @@ By participating in this project, you agree to abide by our Code of Conduct. We
## Need Help?
- 💬 Join our [Discord Community](https://discord.gg/gk8jAdXWmj):
- **#general-dev** - Technical questions and feature discussions
- **#bugs-issues** - Get help with bugs before filing issues
- **#bmad-development** - Technical questions and discussions
- **#suggestions-feedback** - Feature ideas and suggestions
- **#report-bugs-and-issues** - Get help with bugs before filing issues
- 🐛 Report bugs using the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
- 💡 Suggest features using the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
- 📖 Browse the [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions)

2
docs/explanation/bmm/index.md
View File

@@ -128,7 +128,7 @@ Comprehensive documentation for all BMM workflows organized by phase:
### Community and Support
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#general-dev, #bugs-issues)
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#bmad-method-help, #report-bugs-and-issues)
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs

2
docs/explanation/faq/tools-faq.md
View File

@@ -221,7 +221,7 @@ Trust your expertise - BMM supports your decisions.
**A:**
1. Search [Complete Documentation](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) for related topics
2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#general-dev)
2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#bmad-method-help)
3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues)
4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode)

98
docs/how-to/get-answers-about-bmad.md Normal file
View File

@@ -0,0 +1,98 @@
---
title: "How to Get Answers About BMAD"
description: Use an LLM to quickly answer your own BMAD questions
---
Point an LLM at BMAD's source files and ask your question. That's the technique—the rest of this guide shows you how.
## See It Work
:::note[Example]
**Q:** "Tell me the fastest way to build something with BMAD"
**A:** Use Quick Flow: Run `create-tech-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases. This gets small features shipped in a single focused session instead of going through the full 4-phase BMM workflow.
:::
## Why This Works
BMAD's prompts are written in plain English, not code. The `_bmad` folder contains readable instructions, workflows, and agent definitions—exactly what LLMs are good at processing. You're not asking the LLM to guess; you're giving it the actual source material.
## How to Do It
### What Each Source Gives You
| Source | Best For | Examples |
|--------|----------|----------|
| **`_bmad` folder** (installed) | How BMAD works in detail—agents, workflows, prompts | "What does the PM agent do?" "How does the PRD workflow work?" |
| **Full GitHub repo** (cloned) | Why things are the way they are—history, installer, architecture | "Why is the installer structured this way?" "What changed in v6?" |
| **`llms-full.txt`** | Quick overview from documentation perspective | "Explain BMAD's four phases" "What's the difference between levels?" |
:::note[What's `_bmad`?]
The `_bmad` folder is created when you install BMAD. It contains all the agent definitions, workflows, and prompts. If you don't have this folder yet, you haven't installed BMAD—see the "clone the repo" option below.
:::
### If Your AI Can Read Files (Claude Code, Cursor, etc.)
**BMAD installed:** Point your LLM at the `_bmad` folder and ask directly.
**Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD) for git history and installer details.
### If You Use ChatGPT or Claude.ai
Fetch `llms-full.txt` into your session:
```
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
```
You can also find this and other downloadable resources on the [Downloads page](/downloads).
:::tip[Verify Surprising Answers]
LLMs occasionally get things wrong. If an answer seems off, check the source file it referenced or ask on Discord.
:::
## Still Stuck?
Tried the LLM approach and still need help? You now have a much better question to ask.
| Channel | Use For |
|---------|---------|
| `#bmad-method-help` | Quick questions (real-time chat) |
| `help-requests` forum | Detailed questions (searchable, persistent) |
| `#suggestions-feedback` | Ideas and feature requests |
| `#report-bugs-and-issues` | Bug reports |
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
## Found a Bug?
If it's clearly a bug in BMAD itself, skip Discord and go straight to GitHub Issues:
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)
---
*You!*
*Stuck*
*in the queue—*
*waiting*
*for who?*
*The source*
*is there,*
*plain to see!*
*Point*
*your machine.*
*Set it free.*
*It reads.*
*It speaks.*
*Ask away—*
*Why wait*
*for tomorrow*
*when you have*
*today?*
*—Claude*

2
docs/how-to/index.md
View File

@@ -32,3 +32,5 @@ Working with existing codebases.
## Troubleshooting
Solutions to common problems.
- [Get Answers About BMAD](./get-answers-about-bmad.md)

2
docs/tutorials/advanced/create-custom-agent.md
View File

@@ -154,7 +154,7 @@ Study the reference agents in `src/modules/bmb/reference/agents/`:
## Getting Help
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Ask in #general-dev or #bugs-issues
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Ask in #bmad-method-help or #report-bugs-and-issues
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
## Further Reading

2
docs/tutorials/getting-started/getting-started-bmadv4.md
View File

@@ -231,7 +231,7 @@ Workflows are context-intensive. Reusing chats can cause the AI to hallucinate o
- **During workflows** — Agents guide you with questions and explanations
- **Check status** — Run `workflow-status` with any agent
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#general-dev, #bugs-issues)
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode)
## Key Takeaways

2
docs/tutorials/getting-started/getting-started-bmadv6.md
View File

@@ -230,7 +230,7 @@ Yes, once you learn the flow. Use the Quick Reference to go directly to needed w
## Getting Help
- **During workflows** — Agents guide you with questions and explanations
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#general-dev, #bugs-issues)
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
- **Documentation** — [BMM Workflow Reference](../../reference/workflows/index.md)
- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode)

2
docs/tutorials/getting-started/quick-start-bmgd.md
View File

@@ -243,7 +243,7 @@ Yes. Documents are living artifacts—return to update them as your vision evolv
## Getting Help
- **During workflows** — Agents guide you with questions and explanations
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#general-dev, #bugs-issues)
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
- **Documentation** — [BMGD Workflow Reference](../../reference/workflows/bmgd-workflows.md)
- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode)