fix: address PR review — standardize templates and document config settings
- Replace Claude-specific AskUserQuestion in default-* templates with generic
numbered-list wording since these are universal fallbacks for all IDEs
- Fix hardcoded _bmad paths to use {{bmadFolderName}} in antigravity, rovodev,
trae, windsurf-workflow, and default-agent templates
- Extract RULE from numbered steps to standalone directive in gemini and
opencode workflow/tool templates
- Standardize RULE wording: add "Do NOT ask open-ended inline questions" to
all templates missing it for consistency
- Move RULE before execution instructions in default-task and rovodev templates
- Add {document_output_language} to activation-steps session variables
- Add interaction_style confirmation to gemini-agent preflight checklist
- Document all config settings including interaction_style in install guide
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
6522e8e92a
commit
57018815f6
|
|
@ -57,9 +57,24 @@ Each tool has its own way of integrating commands. The installer creates tiny pr
|
||||||
|
|
||||||
The installer shows available modules. Select whichever ones you need — most users just want **BMad Method** (the software development module).
|
The installer shows available modules. Select whichever ones you need — most users just want **BMad Method** (the software development module).
|
||||||
|
|
||||||
### 5. Follow the Prompts
|
### 5. Configure Settings
|
||||||
|
|
||||||
The installer guides you through the rest — custom content, settings, etc.
|
The installer prompts you for core settings that control how agents behave:
|
||||||
|
|
||||||
|
| Setting | Default | Description |
|
||||||
|
| ------- | ------- | ----------- |
|
||||||
|
| **User Name** | `BMad` | What agents call you — use your name or a team name |
|
||||||
|
| **Communication Language** | `English` | Language agents use when chatting with you |
|
||||||
|
| **Document Output Language** | `English` | Language for generated documents and artifacts |
|
||||||
|
| **Output Folder** | `_bmad-output` | Where agents save generated files |
|
||||||
|
| **Interaction Style** | `structured` | How agents ask you questions (see below) |
|
||||||
|
|
||||||
|
**Interaction Style** controls how agents present choices:
|
||||||
|
|
||||||
|
- **Structured** (recommended) — Agents present numbered option lists for every question, using your IDE's native question tool when available. This keeps conversations focused and reduces ambiguity.
|
||||||
|
- **Open** — Agents ask natural conversational questions. More flexible but can lead to longer back-and-forth.
|
||||||
|
|
||||||
|
These settings are saved to `_bmad/<module>/config.yaml` and can be changed later by editing that file and rerunning the installer.
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
<step n="1">Load persona from this current agent file (already in context)</step>
|
<step n="1">Load persona from this current agent file (already in context)</step>
|
||||||
<step n="2">🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT:
|
<step n="2">🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT:
|
||||||
- Load and read {project-root}/_bmad/{{module}}/config.yaml NOW
|
- Load and read {project-root}/_bmad/{{module}}/config.yaml NOW
|
||||||
- Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}, {interaction_style}
|
- Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}, {interaction_style}, {document_output_language}
|
||||||
- VERIFY: If config not loaded, STOP and report error to user
|
- VERIFY: If config not loaded, STOP and report error to user
|
||||||
- DO NOT PROCEED to step 3 until config is successfully loaded and variables stored
|
- DO NOT PROCEED to step 3 until config is successfully loaded and variables stored
|
||||||
</step>
|
</step>
|
||||||
|
|
|
||||||
|
|
@ -3,8 +3,8 @@ name: '{{name}}'
|
||||||
description: '{{description}}'
|
description: '{{description}}'
|
||||||
---
|
---
|
||||||
|
|
||||||
Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}}
|
Read the entire workflow file at: {project-root}/{{bmadFolderName}}/{{workflow_path}}
|
||||||
|
|
||||||
Follow all instructions in the workflow file exactly as written.
|
Follow all instructions in the workflow file exactly as written.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
|
||||||
|
|
@ -5,10 +5,10 @@ description: '{{description}}'
|
||||||
|
|
||||||
You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command.
|
You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
||||||
<agent-activation CRITICAL="TRUE">
|
<agent-activation CRITICAL="TRUE">
|
||||||
1. LOAD the FULL agent file from {project-root}/_bmad/{{path}}
|
1. LOAD the FULL agent file from {project-root}/{{bmadFolderName}}/{{path}}
|
||||||
2. READ its entire contents - this contains the complete agent persona, menu, and instructions
|
2. READ its entire contents - this contains the complete agent persona, menu, and instructions
|
||||||
3. FOLLOW every step in the <activation> section precisely
|
3. FOLLOW every step in the <activation> section precisely
|
||||||
4. DISPLAY the welcome/greeting as instructed
|
4. DISPLAY the welcome/greeting as instructed
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@ description: '{{description}}'
|
||||||
|
|
||||||
# {{name}}
|
# {{name}}
|
||||||
|
|
||||||
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
||||||
Read the entire task file at: {project-root}/{{bmadFolderName}}/{{path}}
|
Read the entire task file at: {project-root}/{{bmadFolderName}}/{{path}}
|
||||||
|
|
||||||
Follow all instructions in the task file exactly as written.
|
Follow all instructions in the task file exactly as written.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions.
|
|
||||||
|
|
|
||||||
|
|
@ -9,4 +9,4 @@ Read the entire tool file at: {project-root}/{{bmadFolderName}}/{{path}}
|
||||||
|
|
||||||
Follow all instructions in the tool file exactly as written.
|
Follow all instructions in the tool file exactly as written.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ name: '{{name}}'
|
||||||
description: '{{description}}'
|
description: '{{description}}'
|
||||||
---
|
---
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
||||||
IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded:
|
IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,6 @@ name: '{{name}}'
|
||||||
description: '{{description}}'
|
description: '{{description}}'
|
||||||
---
|
---
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST call the AskUserQuestion tool. Do NOT write questions as plain text. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
||||||
IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/{{bmadFolderName}}/{{path}}, READ its entire contents and follow its directions exactly!
|
IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/{{bmadFolderName}}/{{path}}, READ its entire contents and follow its directions exactly!
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,7 @@ PRE-FLIGHT CHECKLIST:
|
||||||
1. [ ] IMMEDIATE ACTION: Load and parse {project-root}/{{bmadFolderName}}/{{module}}/config.yaml - store ALL config values in memory for use throughout the session.
|
1. [ ] IMMEDIATE ACTION: Load and parse {project-root}/{{bmadFolderName}}/{{module}}/config.yaml - store ALL config values in memory for use throughout the session.
|
||||||
2. [ ] IMMEDIATE ACTION: Read and internalize the full agent definition at {project-root}/{{bmadFolderName}}/{{path}}.
|
2. [ ] IMMEDIATE ACTION: Read and internalize the full agent definition at {project-root}/{{bmadFolderName}}/{{path}}.
|
||||||
3. [ ] CONFIRM: The user's name from config is {user_name}.
|
3. [ ] CONFIRM: The user's name from config is {user_name}.
|
||||||
|
4. [ ] CONFIRM: interaction_style is set to "{interaction_style}".
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,8 @@ TOOL INSTRUCTIONS:
|
||||||
1. LOAD the tool file from {project-root}/{{bmadFolderName}}/{{path}}
|
1. LOAD the tool file from {project-root}/{{bmadFolderName}}/{{path}}
|
||||||
2. READ its entire contents
|
2. READ its entire contents
|
||||||
3. FOLLOW every instruction precisely as specified
|
3. FOLLOW every instruction precisely as specified
|
||||||
4. RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions.
|
|
||||||
|
RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions.
|
||||||
|
|
||||||
TOOL FILE: {project-root}/{{bmadFolderName}}/{{path}}
|
TOOL FILE: {project-root}/{{bmadFolderName}}/{{path}}
|
||||||
"""
|
"""
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,8 @@ CRITICAL: This is a structured YAML workflow. Follow these steps precisely:
|
||||||
- Dependencies between steps
|
- Dependencies between steps
|
||||||
3. EXECUTE each step in order
|
3. EXECUTE each step in order
|
||||||
4. VALIDATE outputs before proceeding to next step
|
4. VALIDATE outputs before proceeding to next step
|
||||||
5. RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions.
|
|
||||||
|
RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions.
|
||||||
|
|
||||||
WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{workflow_path}}
|
WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{workflow_path}}
|
||||||
"""
|
"""
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,8 @@ WORKFLOW INSTRUCTIONS:
|
||||||
2. READ its entire contents
|
2. READ its entire contents
|
||||||
3. FOLLOW every step precisely as specified
|
3. FOLLOW every step precisely as specified
|
||||||
4. DO NOT skip or modify any steps
|
4. DO NOT skip or modify any steps
|
||||||
5. RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions.
|
|
||||||
|
RULE: When interaction_style is "structured", EVERY question to the user MUST call the ask_user tool. Do NOT write questions as plain text. No exceptions.
|
||||||
|
|
||||||
WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{workflow_path}}
|
WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{workflow_path}}
|
||||||
"""
|
"""
|
||||||
|
|
|
||||||
|
|
@ -8,4 +8,4 @@ Read the entire task file at: #[[file:{{bmadFolderName}}/{{path}}]]
|
||||||
|
|
||||||
Follow all instructions in the task file exactly as written.
|
Follow all instructions in the task file exactly as written.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
|
||||||
|
|
@ -8,4 +8,4 @@ Read the entire tool file at: #[[file:{{bmadFolderName}}/{{path}}]]
|
||||||
|
|
||||||
Follow all instructions in the tool file exactly as written.
|
Follow all instructions in the tool file exactly as written.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
|
||||||
|
|
@ -12,6 +12,7 @@ WORKFLOW INSTRUCTIONS:
|
||||||
2. READ its entire contents
|
2. READ its entire contents
|
||||||
3. FOLLOW every step precisely as specified
|
3. FOLLOW every step precisely as specified
|
||||||
4. DO NOT skip or modify any steps
|
4. DO NOT skip or modify any steps
|
||||||
5. RULE: When interaction_style is "structured", EVERY question to the user MUST call the question tool. Do NOT write questions as plain text. No exceptions.
|
|
||||||
|
RULE: When interaction_style is "structured", EVERY question to the user MUST call the question tool. Do NOT write questions as plain text. No exceptions.
|
||||||
|
|
||||||
WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{path}}
|
WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{path}}
|
||||||
|
|
|
||||||
|
|
@ -12,6 +12,7 @@ WORKFLOW INSTRUCTIONS:
|
||||||
2. READ its entire contents
|
2. READ its entire contents
|
||||||
3. FOLLOW every step precisely as specified
|
3. FOLLOW every step precisely as specified
|
||||||
4. DO NOT skip or modify any steps
|
4. DO NOT skip or modify any steps
|
||||||
5. RULE: When interaction_style is "structured", EVERY question to the user MUST call the question tool. Do NOT write questions as plain text. No exceptions.
|
|
||||||
|
RULE: When interaction_style is "structured", EVERY question to the user MUST call the question tool. Do NOT write questions as plain text. No exceptions.
|
||||||
|
|
||||||
WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{path}}
|
WORKFLOW FILE: {project-root}/{{bmadFolderName}}/{{path}}
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,8 @@
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}}
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
||||||
|
Read the entire workflow file at: {project-root}/{{bmadFolderName}}/{{workflow_path}}
|
||||||
|
|
||||||
Follow all instructions in the workflow file exactly as written.
|
Follow all instructions in the workflow file exactly as written.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions.
|
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,8 @@
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
Read the entire workflow file at: {project-root}/_bmad/{{workflow_path}}
|
Read the entire workflow file at: {project-root}/{{bmadFolderName}}/{{workflow_path}}
|
||||||
|
|
||||||
Follow all instructions in the workflow file exactly as written.
|
Follow all instructions in the workflow file exactly as written.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@ auto_execution_mode: "iterate"
|
||||||
|
|
||||||
# {{name}}
|
# {{name}}
|
||||||
|
|
||||||
Read the entire workflow file at {project-root}/_bmad/{{workflow_path}}
|
Read the entire workflow file at {project-root}/{{bmadFolderName}}/{{workflow_path}}
|
||||||
|
|
||||||
Follow all instructions in the workflow file exactly as written.
|
Follow all instructions in the workflow file exactly as written.
|
||||||
|
|
||||||
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. No exceptions.
|
RULE: When interaction_style is "structured", EVERY question to the user MUST use structured options with a numbered list. Do NOT ask open-ended inline questions. No exceptions.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue