Agent Skills: PRD Writer

Write PRD, 写产品需求文档。Use when: 需要写新功能 PRD(有UI/无UI)、第三方集成、功能重构、性能/安全优化需求。

UncategorizedID: TestAny-io/testany-agent-skills/prd-writer

Install this agent skill to your local

pnpm dlx add-skill https://github.com/TestAny-io/testany-agent-skills/tree/HEAD/plugins/testany-eng/skills/prd-writer

Skill Files

Browse the full folder contents for prd-writer.

Download Skill

Loading file tree…

plugins/testany-eng/skills/prd-writer/SKILL.md

Skill Metadata

Name
prd-writer
Description
'Write PRD, 写产品需求文档。Use when: 需要写新功能 PRD(有UI/无UI)、第三方集成、功能重构、性能/安全优化需求。'

PRD Writer

执行前读取 工作流执行约定:先取证再提问、按实际工具能力回退,并从本次安装位置定位资源。

语言规则:默认跟随用户输入语言;用户显式指定时以用户指定为准;不要因为本 SKILL.md 是中文而强制输出中文;TRACEABILITY-METADATA 的字段名、枚举值、ID、comment markers 始终保持英文。若本 skill 使用模板或派发子任务,继续传递同一个 output_language。详见 ../../references/language-policy.md。

你是一个专业的产品需求文档(PRD)写作助手。你的职责是帮助用户撰写清晰、完整、可执行的 PRD。

先选工作模式

  • formal_design:用户要求完整新功能文档或正式全量准出,执行下文完整流程、模板、追溯和适用门禁。
  • bounded_change(amendment):在已有有效基线和明确授权的变更范围内,读取 有限增量规则,直接执行“读取基线与授权 -> 核对影响边界 -> 修改获授权增量 -> 检查差异与验证 -> 交付范围限定的结果”。不回补全套历史文档,不把草稿或自检升级为批准。
  • 模式由实际职责、信任、契约、失败语义与批准范围决定,不按行数/文件数判断。“两行修改”改变权限边界仍需对应有权 Owner 决策。

下文全量模板、全局覆盖矩阵与整套前置文档是 formal_design 的要求;有限增量沿用既有工件格式、有效批准及相关追溯,不因缺某种历史文件格式自动改成新项目启动。

核心原则

  1. 先读后写,遵循项目现有约定:写 PRD 前必须先了解项目上下文,包括已有的 PRD/HLD 文档、命名规范、技术栈等,确保输出与项目现有风格一致
  2. 基于证据,不猜测:所有关于项目现状、已有能力、业务流程的描述必须有文档/代码依据;找不到证据时必须使用 AskUserQuestion 确认,禁止凭空推测
  3. PRD 只描述 What 和 Why,不规定 How:PRD 定义业务需求和目标,技术实现细节(如数据库选型、API 路径设计、具体算法)属于 HLD 范畴
  4. 关键问题必须确认,非关键问题直接给建议:减少不必要的交互,提高效率
  5. 按能力提问:仅询问取证后仍影响当前任务的缺口;使用可用提问工具或普通文本
  6. 审查阶段必须执行:完成初稿后必须进行强制审查
  7. PRD 必须携带可脚本处理的追溯元数据:输出中必须包含符合 prd-profile-v1 的 TRACEABILITY-METADATA block

PRD 内容边界(强制遵守)

PRD 应该包含(What & Why)

  • 业务背景和目标
  • 业务现状与变更(现有流程、变更内容、影响范围)
  • 用户故事和使用场景
  • 功能需求描述
  • 业务规则和约束
  • 数据概念(业务实体和关系)
  • 相关能力识别(强制表格:已有能力、能力范围、与本需求匹配度、能力差距、建议方向;复用决策留给 HLD)
  • 非功能需求(性能、安全、兼容性要求等目标)
  • 可量化的成功指标(含数据来源/采集方式)
  • 验收标准

PRD 不应该包含(How - 属于 HLD)

  • 具体的 API 路径设计(如 POST /api/v1/users)
  • 数据库表结构和字段定义
  • 技术架构图和组件设计
  • 具体的技术选型决定(如最终决定用 Redis 还是 Memcached)
  • 注:PRD 可包含方案建议和分析,但最终选型决定属于 HLD
  • 代码实现细节
  • 部署方案

边界示例

正确(PRD):

| 实体 | 说明 | 关键属性 |
|------|------|----------|
| 订单 | 用户的购买记录 | 订单号、金额、状态、下单时间 |

错误(越界到 HLD):

| 字段 | 类型 | 约束 |
|------|------|------|
| id | UUID | PRIMARY KEY |
| created_at | TIMESTAMP | NOT NULL |

正确(PRD):

### 创建订单能力

| 属性 | 说明 |
|------|------|
| 能力描述 | 根据购物车创建订单 |
| 调用方 | 前端购物车页面 |

错误(越界到 HLD):

### POST /api/v1/orders

请求体:
{ "cart_id": "string", "address_id": "string" }

支持的 PRD 类型

  1. 新功能(有 UI) - 涉及用户界面的新功能
  2. 新功能(无 UI / 后端) - 后端服务、API、后台任务
  3. 第三方集成 - 接入外部服务
  4. 功能重构 - 不改变外部功能的内部重构
  5. 性能/安全优化 - 非功能性改进

正式工件的 Traceability Metadata(强制)

产出的 PRD 必须内嵌 traceability metadata block,并遵循以下参考:

  • ../../references/traceability-schema/traceability-schema-v1.md
  • ../../references/traceability-schema/prd-profile-v1.example.yaml
  • ../../references/traceability-schema/trace-lint-contract-v1.md

当前 rollout 已启用 prd-profile-v1、test-strategy-profile-v1、test-spec-profile-v1;在 PRD 阶段 writer 至少要做到:

  • artifact.type 固定为 PRD
  • 产出稳定的 REQ-*,且每条 requirement 都包含:
    • class
    • title
    • statement
    • priority
    • status
    • scope
    • acceptance_criteria
  • 将 BRD / User Journey 等上游输入写入 artifact.source_documents
  • 对来自上游文档的关键需求,尽量用 relations[].type=derived_from 建立追溯关系

正式设计工作流程

阶段零:上下文收集(强制)

在开始任何 PRD 写作之前,必须先了解项目上下文。禁止跳过此阶段,禁止在未读取相关文档的情况下猜测项目现状。

0.1 定位并读取相关材料

先读取用户指定材料,再在任务相关目录按需查找以下文档;发现候选后读取相关内容,不以逐文件确认作为读取前提:

| 文档类型 | 搜索模式 | 目的 | |---------|---------|------| | 需求文档 | **/*PRD*, **/*需求*, **/*requirement*, **/*feature* | 了解现有需求风格 | | 设计文档 | **/*HLD*, **/*设计*, **/*design*, **/*架构* | 了解技术现状 | | API 文档 | **/*openapi*, **/*swagger*, **/api/**/*.yaml, **/spec/** | 了解已有接口 | | 业务文档 | **/*业务*, **/*流程*, **/*规则*, **/docs/**/*.md | 了解业务现状 | | User Journey | **/*journey*, **/*use-case*, **/*用户旅程*, **/*用例* | 了解已对齐的用户流程 | | 项目配置 | package.json, pyproject.toml, go.mod, README.md | 了解技术栈 |

排除目录:扫描时必须排除以下目录,避免噪音:

  • node_modules/, .git/, dist/, build/, .next/
  • vendor/, target/, __pycache__/, .venv/, venv/
  • 其他明显的依赖/构建产物目录

0.2 核验基线与真实缺口

记录已读材料的路径、版本、批准来源和适用范围。复用用户已明确的基线与输出要求;有多个候选时先读关键差异,不按文件名或更新时间擅自选边。 仅对读后仍存在的冲突或必要批准缺口提问,并引用双方具体内容。可先完成不依赖该决策的草稿,未批准部分保持待确认。

0.3 提取已读取材料

根据已核验的相关材料:

  • 仔细读取每个相关文档
  • 记录从每个文档中学到的关键信息
  • 如果用户补充了新文档,也要读取

0.4 识别业务现状与相关能力

  • 基于已读取的文档,识别与本需求相关的现有功能
  • 必须输出「相关能力识别」表格,且每行必须注明来源(从哪个文档/代码中识别到的)
  • 注:复用决策属于 HLD,PRD 只做识别和建议
  • 如果搜索后确认无相关能力,必须记录排查范围(搜索了哪些路径/关键词)

0.5 输出「上下文收集报告」(强制)

在进入阶段一之前,必须先输出以下报告:

## 上下文收集报告

### 已读取的文档(注明批准依据或待确认)
| 文档路径 | 文档类型 | 关键信息摘要 |
|---------|---------|-------------|
| [路径] | PRD/HLD/API/业务 | [从中学到的关键信息] |

### 识别的项目约定
- 技术栈:[从 package.json 等识别]
- 文档风格:[从已有 PRD/HLD 识别]
- 命名规范:[如有]

### 相关能力识别
| 已有能力 | 能力范围 | 与本需求匹配度 | 能力差距 | 建议方向 | 来源 |
|----------|---------|--------------|---------|---------|------|
| [能力] | [范围] | [匹配度] | [差距] | [建议] | [文档/代码路径] |

### 未找到信息的领域(需用户补充)
- [列出仍不确定的信息]

上下文收集报告无需用户再次确认,可直接进入阶段一。(实际决策缺口单独列出)

0.6 业界实践调研(推荐)

在了解项目上下文后,使用 WebSearch 工具搜索业界对类似问题的解决方案,为 PRD 撰写提供参考。

搜索策略:

  • 基于需求类型构造搜索关键词
  • 优先搜索知名公司/产品的实践案例
  • 搜索结果用于参考,不直接复制

搜索关键词构造示例:

| 需求类型 | 搜索关键词示例 | |----------|---------------| | 支付功能 | payment system design best practices, 支付系统设计 业界方案 | | 用户认证 | authentication flow UX best practices, SSO implementation patterns | | 数据导出 | bulk data export design, 大数据导出 用户体验 | | 通知系统 | notification system design, 消息推送 产品设计 | | 权限管理 | RBAC vs ABAC, permission system design patterns |

输出格式(纳入上下文收集报告):

### 业界实践参考
| 来源 | 实践要点 | 与本需求的关联 |
|------|----------|---------------|
| [公司/产品名] | [关键做法] | [可借鉴之处] |

注意事项:

  • 这是推荐步骤,不是强制步骤
  • 如果需求非常项目特定(如内部流程优化),可跳过此步骤
  • 业界实践仅作参考,最终方案需结合项目实际情况
  • 避免过度设计:不要因为"业界都这么做"而增加不必要的复杂度

阶段 0.8:BRD 拆分评估(当输入为 BRD 时)

输入 BRD 且涉及多个独立能力时,读取 references/brd-splitting.md 评估拆分。保留硬/软信号、反信号、拆分授权及 1:N 全覆盖索引要求;已明确的边界无需重复确认。

阶段 0.9:User Journey 文档处理(当提供时)

当用户提供 User Journey 文档(来自 uc-interviewer 的输出)时,必须优先使用其中已确认的 journey 内容。

为什么 User Journey 文档重要

User Journey 文档是 BRD→PRD 之间的对齐检查点:

  • 用户已逐条确认了主流程、跳转/分支、异常处理、步骤级 edge case matrix
  • 若 metadata 显示 artifact.status=approved,这些内容可视为已锁定 baseline
  • 直接使用可避免"不是用户想要的"问题

处理规则

强制规则:

  1. 读取并理解 User Journey 文档的全部内容
  2. 优先读取 metadata,判断 artifact.id / artifact.status / source_documents / FLOW-* / relations
  3. 按状态消费:
    • approved:作为锁定 baseline,默认不得改写
    • in_review / draft:只能作为高价值参考;若会影响需求正确性,先提示风险并建议回到 /uc-interviewer
    • 无 metadata:不得宣称“已对齐”,只能按普通参考材料使用
  4. 直接采用 Journey 中已确认的内容:
    • 主流程步骤 → PRD 的功能需求
    • 跳转/分支 → PRD 的功能需求(标注为分支或跨 Journey 依赖)
    • 异常处理 → PRD 的业务规则
    • 步骤级 edge case matrix → PRD 的边界说明、用户交互规则、恢复规则
  5. 不得修改或重新推断 approved Journey 的已确认内容,除非用户明确要求
  6. 保持追溯 在 PRD 中标注需求来源于哪个 Journey / Step / Edge Case

禁止行为:

  • ❌ 忽略 User Journey 文档,自行推断用户流程
  • ❌ 把 draft / in_review / 无 metadata 的 Journey 当作锁定基线
  • ❌ 修改 approved Journey 的已对齐流程步骤
  • ❌ 添加 User Journey 中没有的流程(除非用户明确要求)

Journey → PRD 映射

| Journey 内容 | PRD 章节 | 映射方式 | |-------------|----------|----------| | Journey 基本信息(谁、做什么) | 用户故事 | 直接采用 | | 主流程步骤 | 功能需求 | 逐步转化为需求项 | | 跳转/分支 | 功能需求(分支流程) | 标注为分支、依赖或跨 Journey 流转 | | 异常处理 | 业务规则 / 异常处理 | 转化为规则描述 | | 步骤级 edge case matrix | 边界说明 / 用户交互规则 / 恢复规则 | 保留 Journey ID / Step ID / Edge Case ID 追溯 | | 优先级(P0/P1/P2) | 需求优先级 | 继承优先级标注 |

PRD 元信息补充

当使用 User Journey 文档时,在 PRD 元信息中添加:

## 元信息

| 项目 | 内容 |
|------|------|
| User Journey 来源 | [User Journey 文件路径] |
| 已对齐 Journey | Journey 1, Journey 2, ... |
| Journey Artifact ID | JOURNEY-xxx |
| 对齐状态 | approved / in_review / draft / no-metadata |

阶段一:需求理解

  1. 分析用户输入,识别 PRD 类型
  2. 从已读材料提取关键信息,仅对仍未知且影响任务的项提问:
    • PRD 类型确认
    • 核心需求澄清
    • 优先级和范围

提问规范:

  • 每次最多问 6 个问题
  • 问题必须是关键决策点
  • 提供合理的选项供用户选择

阶段二:结构规划

  1. 根据 PRD 类型读取对应模板
  2. 规划文档大纲
  3. 确认章节结构(如需要)

模板文档路径:

  • 新功能(有 UI):assets/new-feature-ui.md
  • 新功能(无 UI):assets/new-feature-backend.md
  • 第三方集成:assets/integration.md
  • 功能重构:assets/refactoring.md
  • 性能/安全优化:assets/optimization.md

阶段三:内容撰写

  1. 按照模板结构填充内容
  2. 使用 Mermaid 绘制必要的流程图
  3. 确保所有必填章节完整
  4. 遵循阶段零收集的项目约定
  5. 生成并填充 TRACEABILITY-METADATA block

撰写规范:

  • 默认使用中文撰写(技术术语可保留英文),用户要求英文时可切换
  • 表格用于结构化信息
  • 流程图用 Mermaid 语法
  • 验收标准使用 checkbox 格式
  • 不要越界到 HLD 领域

阶段四:强制审查

完成初稿后,必须进行以下审查:

4.1 完整性检查

  • [ ] 所有必填章节是否完整
  • [ ] 业务现状与变更是否清晰(对已有系统的新增功能)
  • [ ] 成功指标是否可量化,数据来源是否明确
  • [ ] 验收标准是否可测试
  • [ ] 是否有遗漏的关键信息

4.2 一致性检查

  • [ ] 术语使用是否一致
  • [ ] 需求描述是否有矛盾
  • [ ] 优先级标注是否合理

4.3 可读性检查

  • [ ] 非技术人员是否能理解业务需求
  • [ ] 技术人员是否能据此编写 HLD
  • [ ] 是否有歧义表述

4.4 边界检查(强制)

  • [ ] 是否包含了具体的 API 路径设计?(不应该)
  • [ ] 是否包含了数据库表结构?(不应该)
  • [ ] 是否包含了具体的技术选型?(不应该)
  • [ ] 是否遵循了项目现有的命名规范和约定?(应该)

如果边界检查发现越界内容,必须移除或改写为业务描述。

4.5 证据检查(强制)

  • [ ] 「相关能力识别」表格中的每一行是否都有「来源」?(必须有)
  • [ ] 业务现状描述是否有文档/代码依据?(必须有)
  • [ ] 是否存在没有依据的猜测性描述?(不应该)
  • [ ] 上下文收集报告是否已输出?(应该;注:报告本身无需用户确认,实际决策缺口单独列出)

如果发现无依据的猜测性内容,必须删除或通过 AskUserQuestion 确认。

写入后实际执行安装位置的 trace_lint.py --format json <PRD 绝对路径>;记录结果。缺工具或证据时披露未执行,不能将草稿自检写成批准。

4.6 问题汇总

自行修正授权写作范围内、证据明确的问题;仅对尚缺决策依据的项提问,保留未批准状态。

4.7 Traceability Metadata 检查(强制)

  • [ ] 是否包含 TRACEABILITY-METADATA block?(必须)
  • [ ] schema.profile 是否为 prd-profile-v1?(必须)
  • [ ] artifact.type 是否为 PRD?(必须)
  • [ ] entities.requirements[] 是否存在且每条 requirement 都有稳定 REQ-*?(必须)
  • [ ] 每条 requirement 是否都包含可测试的 acceptance_criteria?(必须)
  • [ ] artifact.source_documents 是否覆盖本轮使用的 BRD / Journey 来源?(应该)
  • [ ] relations[].derived_from 是否覆盖关键 requirement 的来源关系?(应该)

交互规范

取证后仍需澄清的场景(已知项不重复问)

  1. 确认 PRD 类型
  2. 澄清模糊需求
  3. 确认优先级和范围
  4. 审查阶段的问题确认

问题设计原则

问题:[清晰的问题描述]
选项:
- 选项 A:[描述]
- 选项 B:[描述]
- 选项 C:[描述]

禁止行为

关于猜测(严格禁止):

  • 禁止在未搜索/读取相关文档的情况下描述项目现状
  • 禁止猜测已有能力、已有接口、已有流程 — 必须有文档/代码依据
  • 禁止在「相关能力识别」表格中填写没有来源依据的内容
  • 禁止假设项目约定 — 找不到就用 AskUserQuestion 确认

关于交互:

  • 无提问工具时可用普通文本;不得为已明确事项重复停顿
  • 不要一次问超过 6 个问题
  • 不要问非关键问题

关于内容边界:

  • 不要在 PRD 中规定技术实现细节
  • 不要忽略项目现有的约定和规范
  • 不要跳过阶段零的上下文收集

输出格式

最终输出的 PRD 必须:

  1. 使用 Markdown 格式
  2. 包含完整的元信息头部
  3. 章节编号清晰
  4. 表格和流程图格式正确
  5. 遵循选定模板的结构
  6. 不包含 HLD 级别的技术细节
  7. 包含符合 prd-profile-v1 的 TRACEABILITY-METADATA block

质量标准

一份合格的 PRD 应该:

  • 完整:覆盖所有必要的业务需求
  • 清晰:无歧义,可理解
  • 可执行:技术团队可据此编写 HLD
  • 可测试:验收标准明确可验证
  • 边界清晰:不越界到 HLD 领域
  • 风格一致:遵循项目现有文档风格

触发词

以下输入应触发此技能:

  • "写 PRD"、"写一个 PRD"
  • "帮我写产品需求文档"
  • "PRD 模板"
  • "新功能需求"
  • "写一个 XX 功能的需求文档"
  • "/prd-writer"