SuperAPI AI 工具集

prd-generator

写作与研究

查看项目

更新于 10-15 08:01

技能介绍

用途

PRD Generator 是一个专业级产品需求文档(PRD)生成器,采用 UML 用例驱动方法论,帮助用户快速生成结构完整、可直接用于团队协作的产品需求文档。

当用户提到以下场景时触发本技能:写 PRD、写产品需求文档、写产品规格说明书、产品设计、产品规划、新功能需求分析、用例分析、用例建模、生成需求文档。

主要能力

本技能按以下工作流程生成文档:

  1. 需求收集:与用户确认产品背景、核心功能、目标用户。
  2. 用例建模:识别参与者 → 梳理用例 → 建立关系(Include/Extend)。
  3. 规格编写:按模板编写每个用例的详细规格(前置/后置条件、事件流、备选流)。
  4. 交互设计:绘制流程图、时序图、状态机。
  5. UI 规范:定义布局、组件、色彩、字体。
  6. 非功能需求:明确性能、安全、兼容性要求。
  7. 文档整合:生成完整 PRD 文档。

生成的 PRD 包含以下章节:

  1. 产品概述:产品背景、产品目标、系统范围(含组件定义表)。
  2. UML 用例模型:系统用例图(ASCII 图形)、参与者定义、用例列表(编号-名称-参与者)、用例关系图。
  3. 详细用例规格说明:每个用例包含基本信息(编号/名称/参与者/优先级)、前置/后置条件、基本事件流、备选事件流、业务规则、数据说明表(字段定义)、接口说明。
  4. 详细交互设计:页面整体交互流程、子流程图(如文件上传)、状态机图、时序图(数据流转)、追问/多轮对话流程。
  5. UI 设计规范:页面整体布局(ASCII 线框图)、核心组件设计(ASCII 示意)、色彩规范(色板+色值)、字体规范(字号层级)、间距规范(基础单位)、组件状态规范。
  6. 非功能需求:性能需求、兼容性需求、安全需求、可靠性需求。
  7. 附录:术语表、参考资料。

使用方式

技能内置核心模板,包括用例规格模板、时序图模板与数据字典模板。

用例规格模板结构如下:

UC-XX [用例名称]

项目 内容
用例编号 UC-XX
用例名称 [用例名称]
参与者 [参与者列表]
前置条件 [前置条件描述]
后置条件 [后置条件描述]
基本事件流 1. [步骤1]<br>2. [步骤2]<br>3. [步骤3]
备选事件流 1a. [异常1]:系统[处理方式]<br>2a. [异常2]:系统[处理方式]
业务规则 1. [规则1]<br>2. [规则2]

数据说明表模板:

[表名](table_name)

字段名 字段中文名 数据类型 取值范围 是否必填 备注说明
field_name 字段中文名 VARCHAR(100) 任意字符串 是/否 字段说明
优先级 [高/中/低]

时序图模板:

┌─────────────────────────────────────────────────────────────────┐ │ [标题] │ └─────────────────────────────────────────────────────────────────┘

参与者A 参与者B 参与者C │ │ │ │ 1. [操作描述] │ │ │ ───────────────────────► │ │ │ 2. [处理操作] │ │ │ ───────────► │ │ │ │ │ 3. [返回结果] │ │ │ ◄─────────────────────── │ │ │ │

数据字典模板包含字段类型枚举与状态字段枚举:

字段类型枚举:

  • STRING/VARCHAR: 字符串类型
  • INT/BIGINT: 整数类型
  • DECIMAL: 小数类型
  • BOOLEAN: 布尔类型
  • DATETIME: 日期时间类型
  • JSON: JSON 对象/数组
  • UUID: 唯一标识符

状态字段枚举:

  • PENDING: 待处理
  • PROCESSING: 处理中
  • COMPLETED: 已完成
  • ERROR/FAILED: 错误/失败
  • ACTIVE: 活跃
  • INACTIVE: 未激活

针对数据分析类产品,还提供常用意图类型参考:

意图类型 说明 关联图表
BAR 柱状图意图 柱状图
LINE 折线图意图 折线图
PIE 饼图意图 饼图
SCATTER 散点图意图 散点图
TABLE 表格展示意图 数据表格
FILTER 数据筛选意图 筛选条件
AGREGATE 聚合查询意图 统计结果
CONDITION 条件判断意图 判断结果

输出格式要求:生成的 PRD 文档使用 Markdown 格式,包含完整的 ASCII 图形(用例图、流程图、时序图),数据字段使用表格清晰展示,代码块使用 ``` 标记,文档头部包含版本、日期、状态信息。示例输出详见 references/examples.md。

适用场景

适用于产品经理、需求分析人员或开发团队在以下场景使用:撰写 PRD、撰写产品规格说明书、进行产品设计与产品规划、开展新功能需求分析、进行用例分析与用例建模、生成需求文档。

限制

资料未提供关于收费、价格、平台支持范围、具体效果或性能指标的信息,暂未提供。