mcpField
D
doc-prd

doc-prd

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

关于 doc-prd

用于在 SDD 流程中编写和校验产品需求文档（PRD）的技能，帮助产品与需求编写者基于上游 BRD 定义功能、用户画像、指标、验收标准和追溯关系。

主要功能

  1. 0115 个章节的 PRD 结构
  2. 02功能与用户画像定义
  3. 03成功指标与验收标准
  4. 04BRD 追溯标签
  5. 05结构与质量校验

适用场景

  1. 01将现有 BRD 转化为 PRD
  2. 02定义产品范围和用户旅程
  3. 03记录 ADR 的评估主题
  4. 04检查 PRD 结构和追溯关系

安装

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

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

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

详细介绍

doc-prd

用途

创建产品需求文档（PRD）——SDD 工作流的第 2 层。 PRD 在 C4 容器级别定义产品功能、用户画像、成功指标和验收标准（产品做什么，而不是如何实现）。

层级：2（容器级）。上游：BRD。 下游：EARS → BDD → ADR → SPEC → TDD → IPLAN → Code。

每个 BRD 迭代周期（MVP → PROD → 新 MVP）对应一份 PRD。新范围需要创建一份新 PRD；使用 @depends: PRD-NN 链接各个周期。

何时使用

在以下情况下使用 doc-prd：

  • 已有 BRD，需要定义产品功能和用户需求。
  • 将业务需求转化为产品能力、用户画像和 KPI。
  • 将 BRD §8 中的架构主题细化为 ADR 的技术选项。

若要从 BRD、提示词或 IPLAN 端到端生成文档，请使用 ../doc-prd-autopilot/SKILL.md。

前提条件

PRD 需要上游 BRD。开始编写前，请阅读：

  1. 上游 BRD——推动此 PRD 的 BRD。如果 BRD 拆分为多个章节文件 （docs/01_BRD/BRD-NN_{slug}/），请将所有文件作为一份逻辑文档阅读。
  2. 模板（唯一可信来源）： ${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/PRD-TEMPLATE.yaml
  3. 层级 README： ${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/README.md
  4. ID 和标签标准： ${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md
  5. 编写风格： ${CLAUDE_PLUGIN_ROOT}/framework/governance/AUTHORING_STYLE.md

确认不存在 ID 冲突：ls docs/02_PRD/ 2>/dev/null。仅引用实际存在的 BRD 元素；切勿虚构 BRD-XXX 或 TBD 等占位符。PRD ID 无需与 BRD ID 匹配（PRD-09 可以实现 BRD-16）。

层级指南

内容边界（判断哪些内容属于此层）

PRD 属于容器级。保留产品能力、用户旅程和错误处理；其他内容留给下游层级。

内容所属层级
产品功能、用户画像、KPI、用户旅程PRD（本层）
WHEN-THE-SHALL-WITHIN 正式需求EARS（第 3 层）
Given-When-Then 可执行场景BDD（第 4 层）
架构决策ADR（第 5 层）
架构、端点、基础设施配置SPEC（第 6 层）
必需结构（15 个章节）

document_control 必须放在首位（产品名称、版本、状态、日期、 作者／审核人／批准人、@brd: 引用、EARS-Ready 评分、修订历史）。然后依次为：

  1. 执行摘要（含 MVP 假设）· 3. 问题陈述 ·
  2. 目标受众与用户画像 · 5. 成功指标与 KPI ·
  3. 目标与目的 · 7. 范围与需求 · 8. 用户故事与用户角色 ·
  4. 功能需求（含用户旅程和图示约定）·
  5. 面向客户的内容与消息 · 11. 验收标准 ·
  6. 约束与假设 · 13. 风险评估 · 14. 可追溯性 （含 ADR 主题细化）· 15. 术语表。

各章节的内容要求和内嵌的 _guidance 请参见 PRD-TEMPLATE.yaml。

第 8 节——用户故事（层级分离，必须注明）

仅包含角色定义和故事摘要（As a [role], I want [capability] so that [benefit]）以及产品级验收标准。 必须注明：详细行为见 EARS；可执行场景见 BDD。 此处不要编写 WHEN-THE-SHALL 或 Given-When-Then。

第 10 节——面向客户的内容（必需，阻断性要求）

至少 3 个类别必须包含实质性内容：产品定位、关键信息、功能描述、文档、帮助文本、错误消息、成功确认、入门引导、发行说明。 仅含占位符的内容会导致阻断错误。

第 14 节——ADR 主题细化

将 BRD §8 中的主题细化为技术选项和评估标准。 层级分工：BRD = 做什么及为何做 · PRD = 如何评估 · ADR = 决策。不要引用 ADR 编号——ADR 尚不存在。

元素 ID 和标签
  • 分层元素 ID：PRD.{doc_id}.{section_id}.{hash}（例如 PRD.01.09.b3f2）。为每个元素生成一个稳定的 4 位十六进制标识符，在其所属章节中保持唯一（HASH01）；发生冲突时扩展为 8 位。本提示词中不要计算 SHA-256——哈希形式是由确定性工具流程生成的规范化目标，且字节精确的字段提取仅适用于 BRD §7（PRD 从第 2 阶段起适用）。权威依据：framework/governance/ID_NAMING_STANDARDS.md。 SS 是元素所属的章节——不使用数字类型代码。
  • PRD 属于第 2 层，因此带有 @brd: 标签（例如 @brd: BRD.01.07.a7f3）。下游工件为其添加标签：@prd: PRD.01.09.b3f2。
  • 已移除的模式（不要使用）：FR-XXX、US-XXX、AC-XXX、F-XXX，以及旧版三段式 PRD.NN.xxxx。
  • 可能发生变化的定量值使用 @threshold: PRD.NN.{category}.{key} （类别：quota、risk、perf、timeout、rate）。

创建流程

  1. 阅读父级 BRD——将所有章节文件作为一份文档阅读；提取目标、利益相关方、成功标准和 §8 主题。
  2. 预留 ID——使用下一个可用的 PRD-NN（两位数字：PRD-01、PRD-99、 PRD-102）。 各层独立（CLEANUP-PR-F 项目 18）： 在你所在层的索引中选择下一个可用编号——上游层的编号不是你的编号 （文档编号按层顺序递增且彼此独立；参见 framework/governance/ID_NAMING_STANDARDS.md §Cross-layer cardinality）。
  3. 创建嵌套文件夹——每份 PRD 都必须放在 docs/02_PRD/PRD-NN_{slug}/ 中，无论规模大小。单体式： 在其中放置 PRD-NN_{slug}.md；基于章节的（>25 KB）：PRD-NN.S_{section}.md
    • 使用 ${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/PRD-00_index.TEMPLATE.md 创建索引。
  4. 先填写“文档控制”，然后完成模板中的全部 15 个章节。
  5. 填写 §10（至少 3 个面向客户的类别）；细化 §14 中的 ADR 主题，但不添加 ADR 编号。
  6. 添加 @brd: 标签，使其指向现有 BRD 元素。
  7. 更新 PRD 索引 docs/02_PRD/PRD-00_index.md，并在同一项更改中将此 PRD 添加到父级 BRD 的下游工件中。
  8. 验证（见下文），并将 PRD、索引和 BRD 更新一并提交。

验证

此技能本身就是验证器（无运行时代码）。依据 ${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/README.md 和 ${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md 进行检查。

  • “文档控制”是第一个章节，包含 @brd: 引用和 EARS 就绪度评分。
  • 全部 15 个章节均存在且内容非空。
  • §10 至少 3 个类别包含实质性内容（不是占位符）。
  • §8 仅包含 PRD 级别的摘要，并注明层级分离。
  • §14 细化了 ADR 主题；未引用 ADR 编号。
  • 元素 ID 符合 PRD.NN.SS.xxxx 格式；SS 与所在章节一致；不包含已移除的模式。
  • @brd: 标签指向现有 BRD 元素。
  • 已更新可追溯性信息和索引；已更新父级 BRD；没有失效链接。
  • 图表约定：包含 @diagram: c4-l2 和 @diagram: dfd-l2（使用 ../charts-flow/SKILL.md）；时序图包含 alt/else。
代码含义严重级别
XDOC-002缺少必需的上游标签（@brd）错误
XDOC-006标签格式无效错误
XDOC-008内部链接失效错误
XDOC-009缺少可追溯性章节错误

**质量门禁（阻断性）：**继续后续步骤前，EARS 就绪度评分必须 ≥ 90/100。若发现问题，修复后重新检查；若无法修复，记录下来以供人工审查。

下一项技能

../doc-ears/SKILL.md——EARS 引用此 PRD（@prd: PRD.NN.SS.xxxx），并将 PRD 功能形式化为 WHEN-THE-SHALL-WITHIN 需求。（根据必要上游约定，EARS 本身只要求 @prd；通过 @ 标签链可传递追溯到上游 BRD。)

适配

读取 .aidoc/profile.yaml；仅遵循此技能的可配置项 （section_toggles、glossary）。忽略未知键；如果没有配置文件，则使用 框架默认值。权威依据： ${CLAUDE_PLUGIN_ROOT}/framework/governance/ADAPTATION.md。

相关资源

  • 模板／编写规则：${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/PRD-TEMPLATE.yaml
  • 层 README：${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/README.md
  • 索引模板：${CLAUDE_PLUGIN_ROOT}/framework/layers/02_PRD/PRD-00_index.TEMPLATE.md
  • ID 和标签标准：${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md
  • 上游 BRD：../doc-brd/SKILL.md
  • 质量门禁：../doc-prd-audit/SKILL.md · 修复：../doc-prd-fixer/SKILL.md
  • 生成流水线：../doc-prd-autopilot/SKILL.md

快速参考

用途定义产品功能、用户画像和 KPI
层级2（容器）
上游标签@brd（依据必要上游契约）
关键决策哪些内容保留在 PRD 层级，哪些内容下推至下游
必须包含文档控制（置于首位）、§10（≥3 个类别）、§14 ADR 主题、15 个章节
下一步doc-ears

评论

支持 Markdown