SuperAPI AI 工具集

to-prd

编程与开发

查看项目

更新于 10-16 04:37

技能介绍

用途

该技能用于将当前对话上下文转化为一份 PRD(产品需求文档),并以 GitHub issue 的形式提交。适用场景是:当用户希望基于当前上下文创建 PRD 时使用。它不进行用户访谈,而是直接综合已知信息。

主要能力与流程

  1. 探索仓库,了解代码库的当前状态(如果尚未了解)。
  2. 规划完成实现所需新建或修改的主要模块,并主动寻找抽取“深模块”的机会。深模块(相对于浅模块)指以简单、可测试且很少变化的接口封装大量功能。
  3. 与用户确认这些模块是否符合其预期,并确认希望为哪些模块编写测试。
  4. 按下述模板撰写 PRD,并作为 GitHub issue 提交。

PRD 模板结构

  • 问题陈述:从用户视角描述用户所面临的问题。
  • 解决方案:从用户视角描述该问题的解决方案。
  • 用户故事:一个很长的、带编号的列表。每条用户故事采用如下格式:As a ..., I want a ..., so that ...。该列表应极其详尽,覆盖功能的各个方面。
  • 实现决策:列出已做出的实现决策,可包括:将构建/修改的模块、这些模块将被修改的接口、来自开发者的技术澄清、架构决策、schema 变更、API 契约、具体交互。不要包含具体文件路径或代码片段,因为它们可能很快过时。
  • 测试决策:列出已做出的测试决策,包括:好测试的标准描述(只测试外部行为,不测试实现细节)、将测试哪些模块、测试的先例(即代码库中类似类型的测试)。
  • 范围外:描述本 PRD 中范围之外的内容。
  • 进一步说明:关于该功能的任何其他说明。

使用方式

该技能作为技能被调用,触发条件是用户希望从当前上下文创建 PRD。使用时它会读取当前对话上下文与代码库理解,按上述流程执行,并最终产出并提交 GitHub issue。

适用场景

适用于已通过对话积累了足够需求与背景信息、希望快速将其固化为结构化 PRD 并记录为 GitHub issue 的开发者或团队。尤其适合需要明确模块划分、实现决策与测试决策的软件功能开发前期。

限制

  • 技能明确要求不采访用户,仅综合已有信息;若当前上下文信息不足,需由使用者自行补充。
  • 实现决策部分要求不包含具体文件路径或代码片段。
  • 资料未提供具体的安装命令、平台限制、是否收费或价格等信息,暂未提供。