BMAD-METHOD/docs/zh-cn/reference/core-tools.md

294 lines
12 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: "核心工具"
description: 每个 BMad 安装都自带的内置任务和工作流参考。
sidebar:
order: 2
---
每个 BMad 安装都包含一组核心技能,可以配合你正在做的任何事情使用——跨项目、跨模块、跨阶段的独立任务和工作流。无论安装了哪些可选模块,这些工具始终可用。
:::tip[快速上手]
在 IDE 中输入技能名称(如 `bmad-help`)即可运行任意核心工具,无需启动智能体会话。
:::
## 概览
| 工具 | 类型 | 用途 |
| --- | --- | --- |
| [`bmad-help`](#bmad-help) | 任务 | 根据上下文给出下一步建议 |
| [`bmad-brainstorming`](#bmad-brainstorming) | 工作流 | 引导交互式头脑风暴 |
| [`bmad-party-mode`](#bmad-party-mode) | 工作流 | 编排多智能体群组讨论 |
| [`bmad-distillator`](#bmad-distillator) | 任务 | 无损的 LLM 优化文档压缩 |
| [`bmad-advanced-elicitation`](#bmad-advanced-elicitation) | 任务 | 通过迭代精炼方法提升 LLM 输出质量 |
| [`bmad-review-adversarial-general`](#bmad-review-adversarial-general) | 任务 | 挑刺式审查——找出遗漏和问题 |
| [`bmad-review-edge-case-hunter`](#bmad-review-edge-case-hunter) | 任务 | 穷举分支路径分析,找出未处理的边界情况 |
| [`bmad-editorial-review-prose`](#bmad-editorial-review-prose) | 任务 | 临床式文案编辑,聚焦表达清晰度 |
| [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | 任务 | 结构编辑——裁剪、合并与重组 |
| [`bmad-shard-doc`](#bmad-shard-doc) | 任务 | 将大型 Markdown 文件拆分为有序章节 |
| [`bmad-index-docs`](#bmad-index-docs) | 任务 | 生成或更新文件夹的文档索引 |
## bmad-help
**你的智能向导,告诉你下一步该做什么。** — 检查项目状态,识别已完成的内容,推荐下一个必需或可选步骤。
**适用场景:**
- 完成了一个工作流,想知道接下来做什么
- 刚接触 BMad需要快速了解全貌
- 卡住了,想要根据当前上下文获取建议
- 安装了新模块,想看看有哪些可用功能
**工作原理:**
1. 扫描项目中已有的产出物PRD、架构文档、用户故事等
2. 检测已安装的模块及其可用工作流
3. 按优先级推荐下一步——必需步骤优先,可选步骤其次
4. 每条推荐都附带技能命令和简要说明
**输入:** 可选的自然语言查询(如 `bmad-help I have a SaaS idea, where do I start?`
**输出:** 按优先级排列的下一步推荐列表,附带技能命令
## bmad-brainstorming
**通过交互式创意技法激发多样想法。** — 引导式头脑风暴会话,从技法库中加载经过验证的创意方法,引导你在整理之前先产出 100+ 个想法。
**适用场景:**
- 启动新项目,需要探索问题空间
- 想法枯竭,需要结构化的创意引导
- 想使用成熟的创意框架SCAMPER、反向头脑风暴等
**工作原理:**
1. 围绕你的主题建立头脑风暴会话
2. 从方法库中加载创意技法
3. 逐个技法引导你产出想法
4. 应用反偏差协议——每产出 10 个想法切换一次创意领域,防止想法扎堆
5. 生成一份只追加的会话文档,所有想法按技法分类整理
**输入:** 头脑风暴主题或问题陈述,可选上下文文件
**输出:** `brainstorming-session-{date}.md`,包含所有产出的想法
:::note[数量目标]
真正的好点子往往出现在第 50-100 个想法之间。工作流鼓励在整理之前先产出 100+ 个想法。
:::
## bmad-party-mode
**编排多智能体群组讨论。** — 加载所有已安装的 BMad 智能体,引导一场自然对话,每个智能体从各自的专业领域和角色特征出发发言。
**适用场景:**
- 需要多个专家视角来评估一个决策
- 希望智能体互相质疑彼此的假设
- 正在探索一个横跨多个领域的复杂话题
**工作原理:**
1. 加载智能体清单及所有已安装的智能体角色
2. 分析你的话题,选出 2-3 个最相关的智能体
3. 智能体轮流发言,自然地交叉讨论甚至争论
4. 轮换参与的智能体,确保随时间推移覆盖多样视角
5. 输入 `goodbye`、`end party` 或 `quit` 退出
**输入:** 讨论话题或问题,以及你希望参与的角色(可选)
**输出:** 实时多智能体对话,各智能体保持各自角色特征
## bmad-distillator
**无损的 LLM 优化文档压缩。** — 生成信息密度高、token 高效的精馏文档,保留全部信息供下游 LLM 消费。可通过往返重构验证无损性。
**适用场景:**
- 文档太大,超出 LLM 的上下文窗口
- 需要研究资料、规格或规划产出物的 token 高效版本
- 想验证压缩过程中没有丢失信息
- 智能体需要频繁引用和检索其中的信息
**工作原理:**
1. **分析** — 读取源文档,识别信息密度和结构
2. **压缩** — 将散文转为密集的要点格式,剥离装饰性排版
3. **校验** — 检查完整性,确保原始信息全部保留
4. **验证**(可选)— 往返重构测试,证明压缩无损
**输入:**
- `source_documents`(必填)— 文件路径、文件夹路径或 glob 模式
- `downstream_consumer`(可选)— 消费方是什么(如 "PRD creation"
- `token_budget`(可选)— 大致目标大小
- `--validate`(标志)— 运行往返重构测试
**输出:** 精馏 Markdown 文件,附带压缩比报告(如 "3.2:1"
## bmad-advanced-elicitation
**通过迭代精炼方法提升 LLM 输出质量。** — 从启发技法库中选取合适的方法,通过多轮迭代系统性地改进内容。
**适用场景:**
- LLM 输出感觉浅薄或千篇一律
- 想从多个分析角度深挖一个话题
- 正在打磨关键文档,需要更深层的思考
**工作原理:**
1. 加载包含 5+ 种启发技法的方法注册表
2. 根据内容类型和复杂度选出 5 个最匹配的方法
3. 呈现交互菜单——选一个方法、重新洗牌或列出全部
4. 将选中的方法应用到内容上进行增强
5. 重新呈现选项,反复迭代改进,直到你选择"继续"
**输入:** 待增强的内容段落
**输出:** 应用改进后的增强版内容
## bmad-review-adversarial-general
**预设问题存在,然后去找出来的挑刺式审查。** — 以怀疑、挑剔的审查者视角,对粗糙工作零容忍。重点找遗漏,而不只是找错误。
**适用场景:**
- 在交付物定稿前需要质量保证
- 想对规格、用户故事或文档进行压力测试
- 想找到乐观审查容易忽略的覆盖盲区
**工作原理:**
1. 以挑剔、批判的视角阅读内容
2. 从完整性、正确性和质量三个维度识别问题
3. 专门寻找遗漏的内容——不只是已有内容中的错误
4. 至少找出 10 个问题,否则进行更深层分析
**输入:**
- `content`(必填)— diff、规格、用户故事、文档或任意产出物
- `also_consider`(可选)— 需要额外关注的领域
**输出:** 包含 10+ 条发现及描述的 Markdown 列表
## bmad-review-edge-case-hunter
**遍历每条分支路径和边界条件,只报告未处理的情况。** — 纯路径追踪方法论,机械地推导边界类别。与对抗式审查正交——靠方法驱动,而非靠态度驱动。
**适用场景:**
- 想对代码或逻辑做穷举式边界覆盖
- 需要与对抗式审查互补(不同方法论,不同发现)
- 正在审查 diff 或函数的边界条件
**工作原理:**
1. 枚举内容中所有分支路径
2. 机械推导边界类别:缺失的 else/default、未防护的输入、差一错误、算术溢出、隐式类型转换、竞态条件、超时间隙
3. 逐条路径检查现有防护
4. 只报告未处理的路径——已处理的静默丢弃
**输入:**
- `content`(必填)— diff、完整文件或函数
- `also_consider`(可选)— 需要额外关注的领域
**输出:** JSON 数组,每条发现包含 `location`、`trigger_condition`、`guard_snippet` 和 `potential_consequence`
:::note[互补审查]
同时运行 `bmad-review-adversarial-general``bmad-review-edge-case-hunter` 可获得正交覆盖。对抗式审查捕捉质量和完整性问题;边界猎手捕捉未处理的路径。
:::
## bmad-editorial-review-prose
**聚焦表达清晰度的临床式文案编辑。** — 审查文本中阻碍理解的问题,以 Microsoft 写作风格指南为基准,保留作者个人风格。
**适用场景:**
- 写完初稿想打磨文字
- 需要确保内容对特定受众足够清晰
- 只想修表达问题,不想改写风格偏好
**工作原理:**
1. 阅读内容,跳过代码块和 frontmatter
2. 识别表达问题(不是风格偏好)
3. 对多处出现的相同问题去重
4. 生成三列修改表
**输入:**
- `content`(必填)— Markdown、纯文本或 XML
- `style_guide`(可选)— 项目特定的写作风格指南
- `reader_type`(可选)— `humans`(默认)注重清晰流畅,`llm` 注重精确一致
**输出:** 三列 Markdown 表格:原文 | 修改后 | 变更说明
## bmad-editorial-review-structure
**结构编辑——提出裁剪、合并、移动和精简建议。** — 审查文档组织结构,在文案编辑之前提出实质性调整建议,以改善清晰度和阅读流畅性。
**适用场景:**
- 文档由多个子流程产出,需要结构上的连贯性
- 想在保持可读性的前提下缩减文档篇幅
- 需要识别范围越界或关键信息被埋没的情况
**工作原理:**
1. 将文档与 5 种结构模型对照分析(教程、参考、解释、提示词、战略)
2. 识别冗余、范围越界和被埋没的信息
3. 生成优先级排序的建议:裁剪、合并、移动、精简、质疑、保留
4. 估算总缩减字数和百分比
**输入:**
- `content`(必填)— 待审查的文档
- `purpose`(可选)— 预期用途(如 "quickstart tutorial"
- `target_audience`(可选)— 目标读者
- `reader_type`(可选)— `humans``llm`
- `length_target`(可选)— 目标缩减量(如 "30% shorter"
**输出:** 文档摘要、优先级排序的建议列表,以及预估缩减量
## bmad-shard-doc
**将大型 Markdown 文件拆分为有序的章节文件。** — 以二级标题为分割点,创建一个包含独立章节文件和索引的文件夹。
**适用场景:**
- Markdown 文档过大难以有效管理500+ 行)
- 想把单体文档拆分成可导航的章节
- 需要独立文件以支持并行编辑或 LLM 上下文管理
**工作原理:**
1. 验证源文件存在且是 Markdown 格式
2. 按二级(`##`)标题分割为编号章节文件
3. 创建 `index.md`,包含章节清单和链接
4. 提示你选择删除、归档还是保留原文件
**输入:** 源 Markdown 文件路径,可选目标文件夹
**输出:** 包含 `index.md``01-{section}.md`、`02-{section}.md` 等文件的文件夹
## bmad-index-docs
**生成或更新文件夹中所有文档的索引。** — 扫描目录,读取每个文件以理解其用途,生成一份带链接和描述的有序 `index.md`
**适用场景:**
- 需要一个轻量索引供 LLM 快速扫描可用文档
- 文档文件夹不断增长,需要一个有序的目录
- 想要一份自动生成、能持续保持最新的概览
**工作原理:**
1. 扫描目标目录中所有非隐藏文件
2. 读取每个文件以理解其实际用途
3. 按类型、用途或子目录分组
4. 生成简洁描述(每条 3-10 个词)
**输入:** 目标文件夹路径
**输出:** `index.md`,包含有序的文件列表、相对链接和简要描述