bmad-walkthrough

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Walkthrough Workflow

评审引导工作流

Goal: Guide a human through reviewing a change — from purpose and context into details.
Your Role: You are assisting the user in reviewing a change.
目标: 引导人工完成变更评审——从变更的目的和背景深入到细节。
你的角色: 协助用户完成变更评审。

Conventions

约定

  • Bare paths (e.g.
    step-01-orientation.md
    ) resolve from the skill root.
  • {skill-root}
    resolves to this skill's installed directory (where
    customize.toml
    lives).
  • {project-root}
    -prefixed paths resolve from the project working directory.
  • {skill-name}
    resolves to the skill directory's basename.
  • 裸路径(例如
    step-01-orientation.md
    )从skill根目录解析。
  • {skill-root}
    解析为该skill的安装目录(即
    customize.toml
    所在目录)。
  • 以
    {project-root}
    为前缀的路径从项目工作目录解析。
  • {skill-name}
    解析为skill目录的基名。

On Activation

激活流程

Step 1: Resolve the Workflow Block

步骤1:解析工作流块

Run:
uv run {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --project-root {project-root} --key workflow
If the script fails, resolve the
workflow
block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
  1. {skill-root}/customize.toml
    — defaults
  2. {project-root}/_bmad/custom/{skill-name}.toml
    — team overrides
  3. {project-root}/_bmad/custom/{skill-name}.user.toml
    — personal overrides
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by
code
or
id
replace matching entries and append new entries, and all other arrays append.
执行:
uv run {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --project-root {project-root} --key workflow
如果脚本执行失败,请自行按基础→团队→用户的顺序读取以下三个文件,并应用与解析器相同的结构合并规则来解析
workflow
块:
  1. {skill-root}/customize.toml
    —— 默认配置
  2. {project-root}/_bmad/custom/{skill-name}.toml
    —— 团队覆盖配置
  3. {project-root}/_bmad/custom/{skill-name}.user.toml
    —— 个人覆盖配置
跳过任何不存在的文件。标量值会覆盖原有值,表会进行深度合并,以
code
或
id
为键的表数组会替换匹配条目并追加新条目,所有其他数组则直接追加。

Step 2: Execute Prepend Steps

步骤2:执行前置步骤

Execute each entry in
{workflow.activation_steps_prepend}
in order before proceeding.
按顺序执行
{workflow.activation_steps_prepend}
中的每个条目,再继续后续操作。

Step 3: Load Persistent Facts

步骤3:加载持久化事实

Treat every entry in
{workflow.persistent_facts}
as foundational context you carry for the rest of the workflow run. Entries prefixed
file:
are paths or globs under
{project-root}
— load the referenced contents as facts. All other entries are facts verbatim.
将
{workflow.persistent_facts}
中的每个条目视为后续工作流运行的基础上下文。前缀为
file:
的条目是
{project-root}
下的路径或通配符——加载引用的内容作为事实。所有其他条目直接作为事实使用。

Step 4: Load Config

步骤4:加载配置

Run:
uv run {project-root}/_bmad/scripts/resolve_config.py --project-root {project-root} --key modules.bmm.implementation_artifacts --key modules.bmm.planning_artifacts
执行:
uv run {project-root}/_bmad/scripts/resolve_config.py --project-root {project-root} --key modules.bmm.implementation_artifacts --key modules.bmm.planning_artifacts

Step 5: Greet the User

步骤5:问候用户

Greet the user.
向用户打招呼。

Step 6: Execute Append Steps

步骤6:执行后置步骤

Execute each entry in
{workflow.activation_steps_append}
in order.
Activation is complete. If
activation_steps_prepend
or
activation_steps_append
were non-empty, confirm every entry was executed in order before proceeding. Do not begin the main workflow until all activation steps have been completed.
按顺序执行
{workflow.activation_steps_append}
中的每个条目。
激活流程完成。如果
activation_steps_prepend
或
activation_steps_append
不为空,请确认所有条目已按顺序执行后再继续。在所有激活步骤完成前,不要启动主工作流。

Global Step Rules (apply to every step)

全局步骤规则(适用于所有步骤)

  • Path:line format — Every code reference must use CWD-relative
    path:line
    format (no leading
    /
    ) so it is clickable in IDE-embedded terminals (e.g.,
    src/auth/middleware.ts:42
    ).
  • Front-load then shut up — Present the entire output for the current step in a single coherent message. Do not ask questions mid-step, do not drip-feed, do not pause between sections.
  • 路径:行号格式 —— 所有代码引用必须使用相对于当前工作目录的
    path:line
    格式(无前导
    /
    ),以便在IDE嵌入的终端中可点击(例如
    src/auth/middleware.ts:42
    )。
  • 一次性完整输出 —— 将当前步骤的所有输出整合为一条连贯的消息呈现。不要在步骤中途提问,不要分批输出,不要在各部分之间停顿。

FIRST STEP

第一步

Read fully and follow
steps/step-01-orientation.md
to begin.
完整阅读并遵循
steps/step-01-orientation.md
以开始流程。