docs: add official external modules reference page
This commit is contained in:
Alex Verkhovsky
parent
22601f8198
commit
5d0f4a7d84
|
|
@ -0,0 +1,59 @@
|
|||
# Prompt: Generate External Modules Reference Page
|
||||
|
||||
## Goal
|
||||
|
||||
Create a reference documentation page at `docs/reference/modules.md` that lists all official external BMad modules with descriptions and links.
|
||||
|
||||
## Source of Truth
|
||||
|
||||
Read `tools/cli/external-official-modules.yaml` — this is the authoritative registry of official external modules. Use the module names, codes, npm package names, and repository URLs from this file.
|
||||
|
||||
## Research Step
|
||||
|
||||
For each module in the registry, visit its GitHub repository (url in the YAML record)
|
||||
and read its README to get:
|
||||
- A 1-2 sentence description of what the module does
|
||||
- The key agents and workflows it provides (if listed)
|
||||
- Any notable features or use cases
|
||||
|
||||
## Output Format
|
||||
|
||||
Create `docs/reference/modules.md` following the project's Reference Catalog structure (see `docs/_STYLE_GUIDE.md`):
|
||||
|
||||
```
|
||||
1. Title + Hook
|
||||
2. Items (## for each module)
|
||||
- Brief description (one sentence)
|
||||
- **Key Info:** as flat list (code, npm package, GitHub link)
|
||||
3. Installation note
|
||||
```
|
||||
|
||||
## Style
|
||||
use @docs/_STYLE_GUIDE.md
|
||||
|
||||
## Frontmatter
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: Official Modules
|
||||
---
|
||||
```
|
||||
|
||||
## Content Requirements
|
||||
|
||||
- Start with a brief intro explaining that BMad extends through official modules selected during installation
|
||||
- For each module include:
|
||||
- `##` header with module name
|
||||
- 1-2 sentence description (sourced from GitHub README, not just the registry's short description)
|
||||
- Key info list: module code, npm package (linked), GitHub repo (linked)
|
||||
- Brief bullet list of what it provides (agents, workflows, key features) — keep to 3-5 bullets
|
||||
- Include a `:::tip` admonition about how to install modules (via `npx bmad-method` installer)
|
||||
- Mention that community modules and a marketplace are coming
|
||||
- Do NOT include built-in modules (core, bmm) — this page is specifically for external/add-on modules
|
||||
|
||||
## Existing Pages for Reference
|
||||
|
||||
Look at these files to match the tone and style of existing reference docs:
|
||||
- `docs/reference/agents.md`
|
||||
- `docs/reference/commands.md`
|
||||
- `docs/reference/testing.md`
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
---
|
||||
title: Official Modules
|
||||
---
|
||||
|
||||
BMad extends through official modules that you select during installation. These add-on modules provide specialized agents, workflows, and tasks for specific domains beyond the built-in core and BMM (Agile suite).
|
||||
|
||||
:::tip[Installing Modules]
|
||||
Run `npx bmad-method install` and select the modules you want. The installer handles downloading, configuration, and IDE integration automatically.
|
||||
:::
|
||||
|
||||
## BMad Builder
|
||||
|
||||
Create custom agents, workflows, and domain-specific modules with guided assistance. BMad Builder is the meta-module for extending the framework itself.
|
||||
|
||||
- **Code:** `bmb`
|
||||
- **npm:** [`bmad-builder`](https://www.npmjs.com/package/bmad-builder)
|
||||
- **GitHub:** [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder)
|
||||
|
||||
**Provides:**
|
||||
|
||||
- Agent Builder -- create specialized AI agents with custom expertise and tool access
|
||||
- Workflow Builder -- design structured processes with steps and decision points
|
||||
- Module Builder -- package agents and workflows into shareable, publishable modules
|
||||
- Interactive setup with YAML configuration and npm publishing support
|
||||
|
||||
## Creative Intelligence Suite
|
||||
|
||||
AI-powered tools for structured creativity, ideation, and innovation during early-stage development. The suite provides multiple agents that facilitate brainstorming, design thinking, and problem-solving using proven frameworks.
|
||||
|
||||
- **Code:** `cis`
|
||||
- **npm:** [`bmad-creative-intelligence-suite`](https://www.npmjs.com/package/bmad-creative-intelligence-suite)
|
||||
- **GitHub:** [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
|
||||
|
||||
**Provides:**
|
||||
|
||||
- Innovation Strategist, Design Thinking Coach, and Brainstorming Coach agents
|
||||
- Problem Solver and Creative Problem Solver for systematic and lateral thinking
|
||||
- Storyteller and Presentation Master for narratives and pitches
|
||||
- Ideation frameworks including SCAMPER, Reverse Brainstorming, and problem reframing
|
||||
|
||||
## Game Dev Studio
|
||||
|
||||
Structured game development workflows adapted for Unity, Unreal, Godot, and custom engines. Supports rapid prototyping through Quick Flow and full-scale production with epic-driven sprints.
|
||||
|
||||
- **Code:** `gds`
|
||||
- **npm:** [`bmad-game-dev-studio`](https://www.npmjs.com/package/bmad-game-dev-studio)
|
||||
- **GitHub:** [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
|
||||
|
||||
**Provides:**
|
||||
|
||||
- Game Design Document (GDD) generation workflow
|
||||
- Quick Dev mode for rapid prototyping
|
||||
- Narrative design support for characters, dialogue, and world-building
|
||||
- Coverage for 21+ game types with engine-specific architecture guidance
|
||||
|
||||
## Test Architect (TEA)
|
||||
|
||||
Enterprise-grade test strategy, automation guidance, and release gate decisions through an expert agent and nine structured workflows. TEA goes well beyond the built-in QA agent with risk-based prioritization and requirements traceability.
|
||||
|
||||
- **Code:** `tea`
|
||||
- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
- **GitHub:** [bmad-code-org/bmad-method-test-architecture-enterprise](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)
|
||||
|
||||
**Provides:**
|
||||
|
||||
- Murat agent (Master Test Architect and Quality Advisor)
|
||||
- Workflows for test design, ATDD, automation, test review, and traceability
|
||||
- NFR assessment, CI setup, and framework scaffolding
|
||||
- P0-P3 prioritization with optional Playwright Utils and MCP integrations
|
||||
|
||||
## Community Modules
|
||||
|
||||
Community modules and a module marketplace are coming. Check the [BMad GitHub organization](https://github.com/bmad-code-org) for updates.
|
||||
Loading…
Reference in New Issue