mcpField
B
bmad-readiness-check

bmad-readiness-check

github.com/aj-geddes测试与质量493100 次安装19 周前更新
代码仓库

关于 bmad-readiness-check

bmad-readiness-check 是 BMAD Planning & Orchestrator 插件中的规划验证技能。它检查需求、架构及史诗的可追溯性,并在实施前生成 PASS、CONCERNS 或 FAIL 报告。

主要功能

  1. 01检查规划文档是否齐备
  2. 02交叉核对需求与架构
  3. 03检查史诗与需求的追溯关系
  4. 04生成结论和可执行问题清单

适用场景

  1. 01在实施前检查规划文档
  2. 02找出架构未覆盖的需求
  3. 03识别缺少需求关联的史诗

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/aj-geddes/claude-code-bmad-skills --skill bmad-readiness-check

安装后在 Claude Code 中输入/bmad-readiness-check确认已加载。

附带文件scripts/readiness-check.shtemplates/readiness-report.template.md

详细介绍

BMAD 就绪性检查

“规划到此为止。” 此技能是解决方案设计与实施之间的关卡。在编写任何代码之前,它会验证规划材料在内部是否一致——需求是否由架构覆盖、史诗是否可追溯到需求,以及是否遗漏了任何关键内容。

输出为 readiness-report.md,其中包含明确的 PASS / CONCERNS / FAIL 结论和可执行的具体建议。


工作流

使用 TodoWrite 跟踪:加载材料 → 交叉核对 → 质量检查 → 生成报告 → 显示结论。


第 1 步 — 定位规划材料

运行随附的文件存在性检查:

bash "${CLAUDE_PLUGIN_ROOT}/skills/bmad-readiness-check/scripts/readiness-check.sh" <output-folder>

该脚本会检查必需的材料文件,并输出 PASS / CONCERNS / FAIL 预检结论。阅读其输出;脚本还会打印材料路径,供你在第 2 步加载。

默认搜索根目录为 bmad-output/(或用户配置的 outputFolder)。 如果用户提供自定义路径,请将其作为参数传入。


第 2 步 — 加载并解析材料

读取脚本定位到的每份材料:

需求文档(PRD 或 tech-spec):

  • 提取带标签的功能需求(FR-001、FR-002……),或未加标签的需求要点。
  • 提取非功能需求(NFR-001……,或命名章节: 性能、安全性、可扩展性、可靠性、可维护性)。
  • 记录史诗数量和高层级范围说明。

架构文档:

  • 提取系统组件及其职责。
  • 找出 FR 可追溯性矩阵或明确的 FR 到组件映射。
  • 找出 NFR 覆盖章节。
  • 记录技术栈决策和权衡说明。

史诗 / 用户故事(如果存在):

  • 统计史诗和用户故事的数量。
  • 对每个史诗,确定其引用了哪些 PRD 需求。

记录基线:

Baseline
- FRs found: N
- NFRs found: N
- Epics found: N  (0 if Quick Flow)
- Stories found: N  (0 if not yet decomposed)

第 3 步 — 交叉核对
3a. FR → 架构覆盖情况

针对每个 FR,在架构文档中搜索 FR 标识符以及该需求的主题内容。标记为:

  • 已覆盖 — 明确处理了 FR,并分配了相应组件。
  • 隐含覆盖 — 覆盖了相关主题,但未明确关联。
  • 缺失 — 没有覆盖证据。
3b. NFR → 架构覆盖情况

针对每类 NFR,检查是否有专门的架构章节或明确的策略:

  • 性能:缓存、响应时间目标、异步模式。
  • 安全性:身份验证 / 授权模型、加密、密钥管理。
  • 可扩展性:横向 / 纵向扩展策略、负载均衡。
  • 可靠性:故障转移、备份、正常运行时间目标。
  • 其他已列出的类别。

分别标记为:已处理 / 部分处理 / 缺失。

3c. 史诗 → FR 可追溯性(BMad Method / Enterprise 轨道)

对每个史诗,确认其至少引用了一项 FR 或 PRD 章节。 标记没有可追溯需求的孤立史诗。

3d. 架构质量抽查

确认架构文档包含:

  • 已说明并论证架构模式
  • 已定义组件职责和接口
  • 数据模型 / 实体关系
  • API 设计或服务契约
  • 有理由说明的技术选型
  • 已记录权衡
  • 已列出假设和约束

步骤 4 — 计算判定结果

应用以下阈值(根据 BMAD Method v6 的门禁标准调整,以 PASS / CONCERNS / FAIL 表示):

标准PASSCONCERNSFAIL
FR 覆盖率(已覆盖 + 隐含)≥ 90 %80–89 %< 80 %
NFR 覆盖率(已处理 + 部分处理)≥ 90 %80–89 %< 80 %
架构质量检查≥ 80 %70–79 %< 70 %
阻塞问题(关键缺口)0有缓解方案未缓解
Epic 可追溯性(如适用)全部关联≥ 80 % 已关联< 80 %

总体判定规则:

  • PASS — 所有标准均达到 PASS 阈值,且没有阻塞问题。
  • CONCERNS — 一个或多个标准处于 CONCERNS 区间,且阻塞问题已有缓解方案。谨慎推进;在故事细化期间解决相关问题。
  • FAIL — 任一标准低于 CONCERNS 阈值,或存在未缓解的阻塞问题。问题解决前,不要继续创建故事。

步骤 5 — 生成报告

使用以下模板编写就绪情况报告:

${CLAUDE_PLUGIN_ROOT}/skills/bmad-readiness-check/templates/readiness-report.template.md

保存到:<outputFolder>/readiness-report-<project-slug>-<date>.md

使用 Write 工具。根据你的分析填写所有 {{placeholder}} 字段。


步骤 6 — 显示判定结果

向用户打印简洁的摘要:

Readiness Check Complete

Artifact Coverage
  FR coverage:          XX %
  NFR coverage:         XX %
  Architecture quality: XX %

Verdict: PASS | CONCERNS | FAIL

<One-sentence rationale>

Report saved: <file path>

然后给出具体的下一步建议:

  • PASS → 继续进行 epic/story 拆解 (/bmad-planning-orchestrator:bmad-epics-and-stories)。
  • CONCERNS → 谨慎推进;列出故事作者必须作为 Dev Notes 延续跟进的未解决事项。
  • FAIL → 列出最重要的 3–5 项必需修复;完成修复后重新运行就绪情况检查。

范围边界

此技能仅验证规划文档。它不会:

  • 编写应用程序代码。
  • 运行测试、代码检查工具或构建工具。
  • 审查拉取请求或差异。
  • 执行覆盖率或速率指标。

判定结果为 PASS 或 CONCERNS 时,通过 epic/story 技能生成的故事文件,将工作移交给你的开发工具。


Persona 说明

在 BMAD Method 中,此门禁通常由 Winston(系统架构师)负责。该技能是一套工作流,而非角色,但报告的语气应体现 Winston 的风格——严谨、系统、注重质量。



属于 BMAD Planning & Orchestrator 插件的一部分——这是由 BMAD Code Organization 开发、用于 BMAD Method 的 Claude Code harness(https://github.com/bmad-code-org/BMAD-METHOD)。实现了 bmad-check-implementation-readiness 的理念。所有方法论的功劳均归于 BMAD Code Organization。

评论

支持 Markdown