mcpField
D
doc-brd-autopilot

doc-brd-autopilot

github.com/vladm3105文档处理1745 次安装1 天前更新
代码仓库

关于 doc-brd-autopilot

doc-brd-autopilot 是用于根据参考文档、提示词或实现计划生成或审查 BRD 的技能。它协调验证与修复，并在审查通过后更新 BRD 索引。

主要功能

  1. 01生成和审查 BRD
  2. 02识别来源与 BRD 类型
  3. 03按分数门槛审计和修复
  4. 04单项、批量及试运行模式
  5. 05审计通过后更新索引

适用场景

  1. 01根据参考文件或提示词创建 BRD
  2. 02审查并修复现有 BRD
  3. 03批量处理相关 BRD

安装

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

$npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-brd-autopilot

安装后在 Claude Code 中输入/doc-brd-autopilot确认已加载。

详细介绍

doc-brd-autopilot

目的

自动化的 BRD 生成流水线。根据参考文档 （docs/00_REF/）、用户提示词或实现计划（IPLAN-*），分析来源，确定 BRD 类型，生成完整的 BRD，验证其就绪状态，维护 BRD-00_index.md，并推动审计↔修复循环直至达到通过分数——可处理单个 BRD，也可批量处理。

层级：1。上游：可选的 REF／提示词／IPLAN 输入。下游：通过验证的 BRD + 索引条目。

技能依赖

技能作用
../doc-brd/SKILL.mdBRD 结构和编写规则（生成）
../doc-brd-audit/SKILL.md质量门禁（评分 + 问题发现）
../doc-brd-fixer/SKILL.md根据审计报告应用修复
../doc-naming/SKILL.md元素 ID 标准
../review-team/SKILL.md团队模式调度器（并行分派角色子 Agent）
../charts-flow/SKILL.md图表契约标签（C4-L1、DFD-L1）

生成的 BRD 的编写风格由 ${CLAUDE_PLUGIN_ROOT}/framework/governance/AUTHORING_STYLE.md 管理（通过 doc-brd 和 doc-brd-audit 继承）。

输入约定

接受：目标 BRD ID／路径；REF 目录或文件；自由文本提示词； 或 IPLAN 路径。可选项：分数阈值（默认值为 90）、最大修复迭代次数 （默认值为 3）、批处理列表。未明确提供输入时，将请求视为提示词。

智能文档检测

针对每个目标，检查 BRD 是否已存在（嵌套文件夹 docs/01_BRD/BRD-NN_{slug}/）：

  • 不存在 → 生成模式。
  • 已存在 → 审查并修复模式（先审计，低于阈值时再修复）。

根据来源内容确定 deliverable_type（code／document／ux／risk／process）和 BRD 类型（平台型或功能型）。

模型预检

仅作建议，尽力提供。本项会显示此层级建议使用的模型，但无法切换会话模型。调用驱动程序前：

  1. 如果 .claude/aidoc-flow.config.yaml 不存在，或没有 model.* 键，则完全跳过本节（不输出任何内容）。
  2. 确定建议使用的模型：若已设置 model.per_layer.BRD，则使用该值；否则使用 model.default。
  3. 根据 model.precheck（warn | silent | block）执行操作：
    • warn（默认）——打印一行，然后继续调用驱动程序： ℹ BRD recommends model '<rec>'. If you're not on it, run /model <rec> (or set model.precheck: silent to hide this).
    • silent — 不打印任何内容；继续执行。
    • block — 打印上面一行以及 precheck=block: confirm you want to draft on the current model, or run /model <rec> first.，然后等待用户确认后再继续。

工作流

强制编排步骤（在上述模型预检之后）。 当 review_mode: team（框架默认值）时，你的第一个编排操作是通过 Bash 工具调用 saga 驱动程序。不得直接分派 Task 子 Agent，不得通过 SlashCommand 或其他方式直接调用 doc-brd／doc-brd-audit／doc-brd-fixer，也不得在当前会话中生成 BRD。驱动程序是创建-审查-修订循环的唯一编排机制。绕过驱动程序会生成没有 saga.json 日志的 BRD——这一做法在 2026-06-05 的 BRD 验证中被实际证明会失败，这正是此 SKILL 精简所要修复的确切问题。

Saga 驱动的生成循环（review_mode: team）

步骤 1 — 调用驱动程序。仅此而已。 在调用此 SKILL 之前，执行框架会设置 PREV_OUTPUT、 ARTIFACT_ID、ARTIFACT_PATH 环境变量。 你的第一个编排操作必须是 Bash 工具（上方的 Model 预检会先运行），并且必须运行以下内容：

python3 "${CLAUDE_PLUGIN_ROOT}/tools/saga_driver.py" \
  --layer 01_BRD \
  --allow-skip-permissions

--allow-skip-permissions 可让驱动程序分派的各阶段在无需权限提示的情况下写入 文件——无人值守自动驾驶需要此选项。 移除该标记，即可使用 Claude Code 的常规提示运行同一循环。

使用充足的超时时间（≥1800s）。不要预先分析输入。不要 读取种子。不要分类类型/范围。驱动程序及其分派的子进程（用于草稿的 /aidoc-flow:doc-brd、用于评审的 /aidoc-flow:doc-brd-audit、用于修复的 /aidoc-flow:doc-brd-fixer）会处理所有这些工作。驱动程序根据 ${CLAUDE_PLUGIN_ROOT}/framework/governance/REVIEW_SAGA.md 提前强制执行状态机；此 SKILL 的任务是调用驱动程序并报告结果。

步骤 2 — 驱动程序返回后，报告结果。 读取 .aidoc/review/01_BRD/${ARTIFACT_ID}/saga.json。最终状态必须为 CLOSED（通过）、ESCALATED（终止失败）或 PARTIAL_TIMEOUT（软截止时间；可恢复）。打印状态、 verdict.json 中的最终得分（若存在），以及一行摘要。

步骤 3 — 更新索引（仅限 CLOSED）。 在 docs/01_BRD/BRD-00_index.md 中添加一行，引用新 BRD。

这就是 team 模式下的全部工作流。如果你发现自己在此处做其他事情——起草文本、分派 Task 子 Agent、 调用其他斜杠命令——请停止，意识到你正在绕过驱动程序，并改为调用上面的 Bash 命令。

线性流水线（review_mode: single_pass）

保持旧版行为——当配置文件指定此模式、无法分派 Task 子 Agent，或在写入时（on_author，此时成本是首要考虑因素）使用。

  1. 生成 — 按照 ../doc-brd/SKILL.md 生成 BRD：先写文档 控制（第 1 节），再写 §3–§15 必需章节（根据 section_toggles 决定是否启用 §2 执行摘要）、图表注册表、附录、§8 的 7 个类别、元素 ID BRD.NN.SS.xxxx， 以及通过 ../charts-flow/SKILL.md 添加图表标签。
  2. 验证 — 从头开始以 single_pass 模式运行 ../doc-brd-audit/SKILL.md。
  3. 审核 ↔ 修复循环 — 当得分低于阈值且迭代次数未达到上限时： 以 single_pass 模式运行 ../doc-brd-fixer/SKILL.md，然后重新审核。 通过后，更新 docs/01_BRD/BRD-00_index.md；达到迭代上限后，标记为需人工审核。

执行模式

  • 单个 — 一个 BRD（生成或审核并修复）。
  • 批量 — 多个 BRD，按每批 3 个处理以限制上下文； 先生成依赖项，再生成依赖它们的功能 BRD。
  • 试运行 — 报告计划执行的操作（类型、章节、ID），不写入 文件。

质量门槛

  • 审核通过（得分 ≥ 阈值，Tier-1 错误为 0）或达到迭代上限（随后：标记为需人工审核）之前，不得完成生成。
  • 仅在 BRD 通过后更新 BRD 索引。
  • 每个循环都必须重新审核——不得使用缓存分数。

错误处理

情况操作
缺少被引用的 Platform BRD（功能 BRD）停止；报告缺失的依赖项
达到最大迭代次数但仍低于阈值写入报告，标记为需人工审核，并继续处理批次
源输入含糊不清回退到提示词模式；在 BRD 中记录假设
写入/权限错误记录日志，跳过该项，继续处理批次

适配

应用默认设置前，读取项目适配配置文件 （.aidoc/profile.yaml），并在生成和内部 审核/修复阶段中应用。遵循 section_toggles、active_layers、audit_threshold （仅可调高——只能变得更严格）和 glossary。忽略未知或 超出适用范围的键；若没有配置文件，则使用框架默认值。 依据：${CLAUDE_PLUGIN_ROOT}/framework/governance/ADAPTATION.md。

Related Resources

  • Create: ../doc-brd/SKILL.md · Audit: ../doc-brd-audit/SKILL.md · Fix: ../doc-brd-fixer/SKILL.md
  • Authority: ${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-TEMPLATE.yaml, ${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/README.md, ${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-00_index.TEMPLATE.md

评论

支持 Markdown