From 752a238d00746f5018106a65ec43a5983ee516ad Mon Sep 17 00:00:00 2001 From: Loic Duong Date: Wed, 20 May 2026 23:20:37 +0700 Subject: [PATCH] docs: update official module references --- README.md | 4 +++- README_VN.md | 4 +++- docs/how-to/install-bmad.md | 6 ++--- docs/how-to/upgrade-to-v6.md | 6 ++--- docs/reference/modules.md | 37 +++++++++++++++++++++++++++--- docs/vi-vn/how-to/install-bmad.md | 6 ++--- docs/vi-vn/how-to/upgrade-to-v6.md | 6 ++--- docs/vi-vn/reference/modules.md | 35 ++++++++++++++++++++++++++-- 8 files changed, 85 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 933adef3b..7ef360a7c 100644 --- a/README.md +++ b/README.md @@ -73,9 +73,11 @@ BMad Method extends with official modules for specialized domains. Available dur | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | **[BMad Method (BMM)](https://github.com/bmad-code-org/BMAD-METHOD)** | Core framework with 34+ workflows | | **[BMad Builder (BMB)](https://github.com/bmad-code-org/bmad-builder)** | Create custom BMad agents and workflows | +| **[BMad Automator](https://github.com/bmad-code-org/bmad-automator)** | Experimental story epic automation for Claude and Codex | | **[Test Architect (TEA)](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)** | Risk-based test strategy and automation | -| **[Game Dev Studio (BMGD)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | Game development workflows (Unity, Unreal, Godot) | +| **[Game Dev Studio (GDS)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | Game development workflows (Unity, Unreal, Godot) | | **[Creative Intelligence Suite (CIS)](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)** | Innovation, brainstorming, design thinking | +| **[Whiteport Design Studio (WDS)](https://github.com/bmad-code-org/bmad-method-wds-expansion)** | Strategic UX and design-first planning | ## Documentation diff --git a/README_VN.md b/README_VN.md index 88a84e1fa..4266b8a2c 100644 --- a/README_VN.md +++ b/README_VN.md @@ -75,9 +75,11 @@ BMad Method có thể được mở rộng bằng các mô-đun chính thức ch | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | **[BMad Method (BMM)](https://github.com/bmad-code-org/BMAD-METHOD)** | Khung lõi với hơn 34 quy trình | | **[BMad Builder (BMB)](https://github.com/bmad-code-org/bmad-builder)** | Tạo agent và quy trình BMad tùy chỉnh | +| **[BMad Automator](https://github.com/bmad-code-org/bmad-automator)** | Tự động hóa story epic thử nghiệm cho Claude và Codex | | **[Test Architect (TEA)](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)** | Chiến lược kiểm thử và tự động hóa dựa trên rủi ro | -| **[Game Dev Studio (BMGD)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | Quy trình phát triển game (Unity, Unreal, Godot) | +| **[Game Dev Studio (GDS)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | Quy trình phát triển game (Unity, Unreal, Godot) | | **[Creative Intelligence Suite (CIS)](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)** | Đổi mới, động não ý tưởng, tư duy thiết kế | +| **[Whiteport Design Studio (WDS)](https://github.com/bmad-code-org/bmad-method-wds-expansion)** | UX chiến lược và lập kế hoạch design-first | ## Tài liệu diff --git a/docs/how-to/install-bmad.md b/docs/how-to/install-bmad.md index e96b53aa1..5bf7a1d8d 100644 --- a/docs/how-to/install-bmad.md +++ b/docs/how-to/install-bmad.md @@ -31,7 +31,7 @@ npx bmad-method install The interactive flow asks you five things: 1. Installation directory (defaults to the current working directory) -2. Which modules to install (checkboxes for core, bmm, bmb, cis, gds, tea) +2. Which modules to install (checkboxes for core, bmm, bmb, automator, cis, gds, wds, tea) 3. **"Ready to install (all stable)?"** — Yes accepts the latest released tag for every external module 4. Which AI tools/IDEs to integrate with (claude-code, cursor, and others) 5. Per-module config (name, language, output folder) @@ -53,7 +53,7 @@ Two independent axes control what ends up on disk. ### Axis 1: external module channels -Every external module — bmb, cis, gds, tea, and any community module — installs on one of three channels: +Every external module — bmb, automator, cis, gds, wds, tea, and any community module — installs on one of three channels: | Channel | What gets installed | Who picks this | | ------------------ | ---------------------------------------------------------------------------- | --------------------------------------- | @@ -138,7 +138,7 @@ Under `--yes`, patch and minor upgrades apply automatically. Majors stay frozen Precedence when flags overlap: `--pin` beats `--next=` beats `--channel` / `--all-*` beats the registry default (`stable`). :::note[Example resolution] -`--all-next --pin cis=v0.2.0` puts bmb, gds, and tea on next while pinning cis to v0.2.0. +`--all-next --pin cis=v0.2.0` puts bmb, automator, gds, wds, and tea on next while pinning cis to v0.2.0. ::: ### Recipes diff --git a/docs/how-to/upgrade-to-v6.md b/docs/how-to/upgrade-to-v6.md index 96febd355..39ffaadf2 100644 --- a/docs/how-to/upgrade-to-v6.md +++ b/docs/how-to/upgrade-to-v6.md @@ -85,9 +85,9 @@ your-project/ | v4 Module | v6 Status | | ----------------------------- | ----------------------------------------- | -| `.bmad-2d-phaser-game-dev` | Integrated into BMGD Module | -| `.bmad-2d-unity-game-dev` | Integrated into BMGD Module | -| `.bmad-godot-game-dev` | Integrated into BMGD Module | +| `.bmad-2d-phaser-game-dev` | Integrated into GDS module | +| `.bmad-2d-unity-game-dev` | Integrated into GDS module | +| `.bmad-godot-game-dev` | Integrated into GDS module | | `.bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon | | `.bmad-creative-writing` | Not adapted — new v6 module coming soon | diff --git a/docs/reference/modules.md b/docs/reference/modules.md index 6bdc64190..1a449d86f 100644 --- a/docs/reference/modules.md +++ b/docs/reference/modules.md @@ -1,6 +1,6 @@ --- title: Official Modules -description: Add-on modules for building custom agents, creative intelligence, game development, and testing +description: Add-on modules for building custom agents, automation, creative intelligence, game development, design, and testing sidebar: order: 4 --- @@ -41,6 +41,22 @@ AI-powered tools for structured creativity, ideation, and innovation during earl - Storyteller and Presentation Master for narratives and pitches - Ideation frameworks including SCAMPER, Reverse Brainstorming, and problem reframing +## BMad Automator + +Experimental automation module for generating implementation-ready story epics and running supported BMAD workflows with less manual orchestration. The module currently targets Claude and Codex workflows. + +- **Code:** `automator` +- **npm:** [`bmad-story-automator`](https://www.npmjs.com/package/bmad-story-automator) +- **GitHub:** [bmad-code-org/bmad-automator](https://github.com/bmad-code-org/bmad-automator) +- **Default channel:** `next` + +**Provides:** + +- Epic-building automation for story-driven delivery +- Experimental workflow support for Claude and Codex users +- A faster path from planning artifacts to actionable implementation work +- Early-access functionality that may change more quickly than stable modules + ## 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. @@ -56,6 +72,21 @@ Structured game development workflows adapted for Unity, Unreal, Godot, and cust - Narrative design support for characters, dialogue, and world-building - Coverage for 21+ game types with engine-specific architecture guidance +## Whiteport Design Studio + +Strategic UX and design-first planning module for teams that need stronger product experience framing before implementation. WDS expands BMAD with structured UX discovery and design planning workflows. + +- **Code:** `wds` +- **npm:** [`bmad-wds`](https://www.npmjs.com/package/bmad-wds) +- **GitHub:** [bmad-code-org/bmad-method-wds-expansion](https://github.com/bmad-code-org/bmad-method-wds-expansion) + +**Provides:** + +- Design-first planning methodology for product and UX work +- Structured UX discovery before solutioning and implementation +- Strategic design workflows that complement BMAD's product planning flow +- Whiteport Design Studio skills exposed through the installer module picker + ## 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. @@ -71,6 +102,6 @@ Enterprise-grade test strategy, automation guidance, and release gate decisions - NFR assessment, CI setup, and framework scaffolding - P0-P3 prioritization with optional Playwright Utils and MCP integrations -## Community Modules +## Community and Custom Modules -Community modules and a module marketplace are coming. Check the [BMad GitHub organization](https://github.com/bmad-code-org) for updates. +The interactive community module picker has been retired. Install community or third-party modules with `--custom-source ` from a Git repository or local path. See [Install custom and community modules](../how-to/install-custom-modules.md). diff --git a/docs/vi-vn/how-to/install-bmad.md b/docs/vi-vn/how-to/install-bmad.md index de5ead38c..309557a0f 100644 --- a/docs/vi-vn/how-to/install-bmad.md +++ b/docs/vi-vn/how-to/install-bmad.md @@ -31,7 +31,7 @@ npx bmad-method install Luồng tương tác sẽ hỏi bạn năm thứ: 1. Thư mục cài đặt (mặc định là thư mục làm việc hiện tại) -2. Module cần cài (checkbox cho core, bmm, bmb, cis, gds, tea) +2. Module cần cài (checkbox cho core, bmm, bmb, automator, cis, gds, wds, tea) 3. **"Ready to install (all stable)?"** — chọn Yes để nhận tag phát hành mới nhất cho mọi module bên ngoài 4. Công cụ AI/IDE cần tích hợp (claude-code, cursor và các công cụ khác) 5. Cấu hình theo từng module (tên, ngôn ngữ, thư mục output) @@ -53,7 +53,7 @@ Có hai trục độc lập quyết định thứ gì được ghi xuống đĩa ### Trục 1: channel của module bên ngoài -Mọi module bên ngoài như bmb, cis, gds, tea và các module cộng đồng đều được cài trên một trong ba channel: +Mọi module bên ngoài như bmb, automator, cis, gds, wds, tea và các module cộng đồng đều được cài trên một trong ba channel: | Channel | Nội dung được cài | Ai nên chọn | | ------------------ | ---------------------------------------------------------------------------- | --------------------------------------- | @@ -138,7 +138,7 @@ Khi dùng `--yes`, nâng cấp patch và minor được áp dụng tự động. Độ ưu tiên khi các cờ chồng nhau: `--pin` thắng `--next=`, thắng `--channel` / `--all-*`, thắng mặc định registry (`stable`). :::note[Ví dụ resolve] -`--all-next --pin cis=v0.2.0` đặt bmb, gds và tea lên next, đồng thời ghim cis vào v0.2.0. +`--all-next --pin cis=v0.2.0` đặt bmb, automator, gds, wds và tea lên next, đồng thời ghim cis vào v0.2.0. ::: ### Recipe diff --git a/docs/vi-vn/how-to/upgrade-to-v6.md b/docs/vi-vn/how-to/upgrade-to-v6.md index d72e71911..e34af4c97 100644 --- a/docs/vi-vn/how-to/upgrade-to-v6.md +++ b/docs/vi-vn/how-to/upgrade-to-v6.md @@ -84,9 +84,9 @@ du-an-cua-ban/ | Module v4 | Trạng thái trong v6 | | --- | --- | -| `.bmad-2d-phaser-game-dev` | Đã được tích hợp vào module BMGD | -| `.bmad-2d-unity-game-dev` | Đã được tích hợp vào module BMGD | -| `.bmad-godot-game-dev` | Đã được tích hợp vào module BMGD | +| `.bmad-2d-phaser-game-dev` | Đã được tích hợp vào module GDS | +| `.bmad-2d-unity-game-dev` | Đã được tích hợp vào module GDS | +| `.bmad-godot-game-dev` | Đã được tích hợp vào module GDS | | `.bmad-infrastructure-devops` | Đã bị ngừng hỗ trợ - agent DevOps mới sắp ra mắt | | `.bmad-creative-writing` | Chưa được điều chỉnh - module v6 mới sắp ra mắt | diff --git a/docs/vi-vn/reference/modules.md b/docs/vi-vn/reference/modules.md index 1f0bf25ea..ada3a01e1 100644 --- a/docs/vi-vn/reference/modules.md +++ b/docs/vi-vn/reference/modules.md @@ -41,6 +41,22 @@ Bộ công cụ vận hành bởi AI dành cho sáng tạo có cấu trúc, phá - Storyteller và Presentation Master cho kể chuyện và pitching - Các framework phát ý tưởng như SCAMPER, Reverse Brainstorming và problem reframing +## BMad Automator + +Module tự động hóa thử nghiệm để tạo epic/story sẵn sàng cho triển khai và chạy các workflow BMAD được hỗ trợ với ít thao tác thủ công hơn. Hiện module này tập trung vào Claude và Codex. + +- **Mã:** `automator` +- **npm:** [`bmad-story-automator`](https://www.npmjs.com/package/bmad-story-automator) +- **GitHub:** [bmad-code-org/bmad-automator](https://github.com/bmad-code-org/bmad-automator) +- **Kênh mặc định:** `next` + +**Cung cấp:** + +- Tự động hóa xây epic cho quy trình giao hàng theo story +- Hỗ trợ workflow thử nghiệm cho người dùng Claude và Codex +- Đường tắt từ artifact kế hoạch sang công việc triển khai cụ thể +- Tính năng early-access có thể thay đổi nhanh hơn các module stable + ## Game Dev Studio Các workflow phát triển game có cấu trúc, được điều chỉnh cho Unity, Unreal, Godot và các engine tùy chỉnh. Hỗ trợ làm prototype nhanh qua Quick Flow và sản xuất toàn diện bằng sprint theo epic. @@ -56,6 +72,21 @@ Các workflow phát triển game có cấu trúc, được điều chỉnh cho U - Hỗ trợ thiết kế narrative cho nhân vật, hội thoại và world-building - Bao phủ hơn 21 thể loại game cùng hướng dẫn kiến trúc theo engine +## Whiteport Design Studio + +Module UX chiến lược và design-first planning cho các nhóm cần định hình trải nghiệm sản phẩm chắc hơn trước khi triển khai. WDS mở rộng BMAD bằng discovery UX và workflow lập kế hoạch thiết kế có cấu trúc. + +- **Mã:** `wds` +- **npm:** [`bmad-wds`](https://www.npmjs.com/package/bmad-wds) +- **GitHub:** [bmad-code-org/bmad-method-wds-expansion](https://github.com/bmad-code-org/bmad-method-wds-expansion) + +**Cung cấp:** + +- Phương pháp design-first planning cho sản phẩm và UX +- Discovery UX có cấu trúc trước solutioning và implementation +- Workflow thiết kế chiến lược bổ trợ luồng product planning của BMAD +- Các skill Whiteport Design Studio được hiển thị qua module picker của installer + ## Test Architect (TEA) Chiến lược kiểm thử cấp doanh nghiệp, hướng dẫn tự động hóa và quyết định release gate thông qua một agent chuyên gia cùng chín workflow có cấu trúc. TEA vượt xa QA agent tích hợp sẵn nhờ ưu tiên theo rủi ro và truy vết yêu cầu. @@ -71,6 +102,6 @@ Chiến lược kiểm thử cấp doanh nghiệp, hướng dẫn tự động h - Đánh giá NFR, thiết lập CI và dựng sườn framework kiểm thử - Ưu tiên P0-P3 cùng tích hợp tùy chọn với Playwright Utils và MCP -## Community Modules +## Module cộng đồng và tùy chỉnh -Các module cộng đồng và một chợ module đang được chuẩn bị. Hãy theo dõi [tổ chức BMad trên GitHub](https://github.com/bmad-code-org) để cập nhật. +Module picker cho community module trong luồng tương tác đã được gỡ. Hãy cài module cộng đồng hoặc bên thứ ba bằng `--custom-source ` từ Git repository hoặc đường dẫn cục bộ. Xem [Cài đặt module tùy chỉnh và module cộng đồng](../how-to/install-custom-modules.md).