bmad-help
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseBMad Help
BMad帮助
Purpose
用途
Help the user understand where they are in their BMad workflow and what to do next. Answer BMad questions when asked.
帮助用户了解自己处于BMad工作流的哪个位置,以及下一步该做什么。当用户提出相关问题时,解答BMad相关疑问。
Desired Outcomes
预期效果
When this skill completes, the user should:
- Know where they are — which module and phase they're in, what's already been completed
- Know what to do next — the next recommended and/or required step, with clear reasoning
- Know how to invoke it — skill name, menu code, action context, and any args that shortcut the conversation
- Get offered a quick start — when a single skill is the clear next step, offer to run it for the user right now rather than just listing it
- Feel oriented, not overwhelmed — surface only what's relevant to their current position; don't dump the entire catalog
当该skill执行完成后,用户应当:
- 清楚自身所处位置——当前所在的模块和阶段,已经完成的工作内容
- 清楚下一步要做什么——得到推荐的和/或必填的下一步操作,附带清晰的理由
- 清楚如何调用——skill名称、菜单编码、操作上下文,以及所有可以简化对话的参数(args)
- 获得快速启动选项——如果明确下一步只需使用单个skill,直接为用户提供立即运行的选项,而非仅列出skill名称
- 有清晰的方向感,不会感到信息过载——仅展示与用户当前位置相关的内容,不要堆砌整个目录的信息
Data Sources
数据来源
- Catalog: — assembled manifest of all installed module skills
{project-root}/_bmad/_config/bmad-help.csv - Config: and
config.yamlfiles inuser-config.yamland its subfolders — resolve{project-root}/_bmad/variables, provideoutput-locationandcommunication_languageproject_knowledge - Artifacts: Files matching patterns at resolved
outputspaths reveal which steps are possibly completed; their content may also provide grounding context for recommendationsoutput-location - Project knowledge: If resolves to an existing path, read it for grounding context. Never fabricate project-specific details.
project_knowledge
- 目录:——所有已安装模块skill的汇总清单
{project-root}/_bmad/_config/bmad-help.csv - 配置:及其子文件夹下的
{project-root}/_bmad/和config.yaml文件——用于解析user-config.yaml变量,提供output-location和communication_language配置project_knowledge - 产物:匹配已解析的路径下
output-location规则的文件,可反映哪些步骤可能已经完成;其内容也可为推荐内容提供背景依据outputs - 项目知识:如果解析后指向存在的路径,读取该文件获取背景信息。绝对不要编造项目专属的细节内容。
project_knowledge
CSV Interpretation
CSV解析规则
The catalog uses this format:
module,skill,display-name,menu-code,description,action,args,phase,after,before,required,output-location,outputsPhases determine the high-level flow:
- — available regardless of workflow state
anytime - Numbered phases (,
1-analysis, etc.) flow in order; naming varies by module2-planning
Dependencies determine ordering within and across phases:
- — skills that should ideally complete before this one
after - — skills that should run after this one
before - Format: for single-action skills,
skill-namefor multi-action skillsskill-name:action
Required gates:
- items must complete before the user can meaningfully proceed to later phases
required=true - A phase with no required items is entirely optional — recommend it but be clear about what's actually required next
Completion detection:
- Search resolved output paths for patterns
outputs - Fuzzy-match found files to catalog rows
- User may also state completion explicitly, or it may be evident from the current conversation
Descriptions carry routing context — some contain cycle info and alternate paths (e.g., "back to DS if fixes needed"). Read them as navigation hints, not just display text.
目录采用如下格式:
module,skill,display-name,menu-code,description,action,args,phase,after,before,required,output-location,outputs阶段(Phases) 决定高层流转逻辑:
- ——无论工作流处于什么状态都可使用
anytime - 带编号的阶段(比如、
1-analysis等)按顺序流转;命名规则随模块不同有所差异2-planning
依赖(Dependencies) 决定阶段内和跨阶段的执行顺序:
- ——理想情况下应当在当前skill之前完成的skill
after - ——应当在当前skill之后运行的skill
before - 格式:单操作skill为,多操作skill为
skill-nameskill-name:action
必填关卡(Required gates):
- 标记为的项必须完成,用户才能有效推进到后续阶段
required=true - 没有必填项的阶段是完全可选的——可以推荐该阶段的内容,但要明确告知用户下一步实际需要完成的内容是什么
完成状态检测:
- 在已解析的输出路径中搜索匹配规则的文件
outputs - 将找到的文件与目录行进行模糊匹配
- 用户也可能明确说明已完成某步骤,或者从当前对话中可以明显看出步骤已完成
描述包含路由上下文——部分描述包含周期信息和备选路径(比如“如果需要修复则返回DS”)。要将其视为导航提示,而非仅作为展示文本。
Response Format
响应格式
For each recommended item, present:
- Display name — e.g., "[CP] Create PRD"
[menu-code] - Skill name in backticks — e.g.,
bmad-create-prd - For multi-action skills: action invocation context — e.g., "tech-writer lets create a mermaid diagram!"
- Description if present in CSV; otherwise your existing knowledge of the skill suffices
- Args if available
Ordering: Show optional items first, then the next required item. Make it clear which is which.
对于每个推荐项,需要展示:
- 展示名称——例如:“[CP] Create PRD”
[menu-code] - 反引号包裹的skill名称——例如:
bmad-create-prd - 多操作skill需要提供操作调用上下文——例如:“tech-writer lets create a mermaid diagram!”
- 描述(如果CSV中有提供);否则使用你已有的关于该skill的知识即可
- 参数(args,如果有提供的话)
排序规则:先展示可选项,再展示下一个必填项。要明确区分两者的属性。
Constraints
约束
- Present all output in
{communication_language} - Recommend running each skill in a fresh context window
- Match the user's tone — conversational when they're casual, structured when they want specifics
- If the active module is ambiguous, ask rather than guess
- 所有输出使用指定的语言
{communication_language} - 建议在全新的上下文窗口中运行每个skill
- 匹配用户的语气——用户语气随意时回复口语化,用户想要具体信息时回复结构化
- 如果当前激活的模块不明确,要询问用户而非猜测