关于 to-prd
to-prd 根据对话上下文和代码库信息整理产品需求文档,并发布到项目 issue 跟踪器。适用于将已知需求转化为包含用户故事、实现与测试决策的 PRD。
主要功能
- 01综合现有上下文生成 PRD
- 02梳理待构建或修改的模块
- 03编写全面的用户故事
- 04记录实现与测试决策
- 05添加 needs-triage 标签并发布
适用场景
- 01将讨论中的需求整理为 PRD
- 02为功能规划用户故事与测试范围
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ camacho/ ai-skills --skill to-prd安装后在 Claude Code 中输入/to-prd确认已加载。
详细介绍
此技能会结合当前对话上下文和对代码库的理解,编写 PRD。不要采访用户——只需综合已有信息。
应能通过 gh 访问问题跟踪器。如果需要了解标签词汇,请查看项目的 AGENTS.md 或问题模板。
流程
-
如果尚未了解代码库的当前状态,请先探索代码库。在整个 PRD 中使用项目的领域词汇表,并遵循所涉及领域的 ADR。
-
列出完成实现所需构建或修改的主要模块。积极寻找将深层模块提取出来、以便单独测试的机会。
深层模块(相对于浅层模块而言)是指封装大量功能、提供简单且可测试的接口,并且很少变更的模块。
与用户确认这些模块是否符合他们的预期。向用户确认他们希望为哪些模块编写测试。
- 使用下方模板编写 PRD,然后将其发布到项目的问题跟踪器。添加
needs-triage分类标签,使其进入正常分类流程。
问题陈述
从用户的角度描述他们面临的问题。
解决方案
从用户的角度描述问题的解决方案。
用户故事
列出一份篇幅较长且编号的用户故事清单。每条用户故事的格式应为:
- 作为一名 <角色>,我希望拥有 <功能>,以便 <收益>
这份用户故事清单应尽可能详尽,涵盖该功能的所有方面。
实施决策
列出已作出的实施决策,包括:
- 将构建或修改的模块
- 将修改的模块接口
- 开发者提供的技术说明
- 架构决策
- 架构变更
- API 契约
- 具体交互方式
不要包含具体文件路径或代码片段。它们很快就可能过时。
测试决策
列出已作出的测试决策,包括:
- 优秀测试的标准(只测试外部行为,不测试实现细节)
- 将接受测试的模块
- 测试的既有参考示例(即代码库中类似类型的测试)
范围之外
描述不属于此 PRD 范围的事项。
补充说明
关于此功能的任何其他说明。
评论
支持 Markdown