SuperAPI AI 工具集

write-a-prd

写作与研究

查看项目

更新于 10-16 03:39

技能介绍

用途:当用户希望创建 PRD 时调用该技能,可通过用户访谈、代码库探索和模块设计产出 PRD,并提交为 GitHub issue。仅在用户明确要求编写 PRD 时使用。

主要流程:先让用户给出想要解决问题的长而详细的描述及可能的解决方案想法;探索仓库以验证其说法并了解代码库现状;围绕计划的每个方面反复访谈用户,直到达成共识,逐一梳理设计树各分支并解决决策间的依赖;勾勒完成实现所需构建或修改的主要模块,主动寻找可提取为深模块的机会。深模块指以简单、可测试且很少变化的接口封装大量功能,区别于浅模块。需与用户确认这些模块是否符合预期,并确认希望为哪些模块编写测试。

在充分理解问题与方案后,按模板撰写 PRD 并作为 GitHub issue 提交。模板包含:问题陈述(从用户视角描述其面临的问题)、解决方案(从用户视角描述解决方式)、用户故事(很长的编号列表,格式为“作为……,我想要……,以便……”,需极为详尽并覆盖功能各方面)、实现决策(包括将构建/修改的模块、这些模块将被修改的接口、开发者给出的技术澄清、架构决策、模式变更、API 契约、具体交互;不要包含具体文件路径或代码片段,以免很快过时)、测试决策(好测试的标准,即只测试外部行为而非实现细节;将测试哪些模块;测试的先例,即代码库中类似类型的测试)、范围外(本 PRD 不涵盖的内容)、补充说明(关于该功能的其他备注)。

限制与未提供信息:资料未说明该技能的具体安装方式、命令、收费、价格、平台、效果或使用步骤。