关于 to-prd
to-prd 是一项开发技能,可将对话上下文和代码库理解整理成 PRD,并发布到项目问题跟踪器。它规定了仓库调研、测试接缝、用户故事、实现决策和测试决策等环节。
主要功能
- 01综合上下文生成 PRD
- 02调研仓库并采用领域术语
- 03识别测试接缝并默认获批
- 04使用详细的 PRD 模板
- 05添加分流标签并发布到跟踪器
适用场景
- 01根据现有讨论记录功能提案
- 02依据仓库惯例编写 PRD
- 03向跟踪器提交可供 Agent 处理的问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ utarn/ engineer-skills --skill to-prd安装后在 Claude Code 中输入/to-prd确认已加载。
附带文件agents/openai.yaml
详细介绍
此技能会结合当前对话上下文和对代码库的理解来编写 PRD。不要采访用户——只需综合你已有的信息。
问题跟踪器和分类标签词汇应该已提供给你;如果没有,请运行 /setup-utarn-skills。
流程
-
如果你还没有了解代码库的当前状态,请探索仓库。通篇使用项目的领域词汇表,并遵循你要修改区域内的任何 ADR。
-
规划要测试该功能的接缝。优先使用现有接缝。尽可能选择最高层级的接缝。如果需要新增接缝,请尽可能在最高层级提出。跨代码库的接缝越少越好——理想数量为一个。
-
假设接缝方案获得认可。
-
使用以下模板编写 PRD,然后将其发布到项目问题跟踪器。应用
ready-for-agent分类标签——无需额外分类。
问题陈述
从用户的角度描述用户面临的问题。
解决方案
从用户的角度描述问题的解决方案。
用户故事
一份较长的编号用户故事列表。每条用户故事应采用以下格式:
- 作为一名 <角色>,我希望 <功能>,以便 <收益>
这份用户故事列表应尽可能详尽,涵盖该功能的所有方面。
实现决策
列出已作出的实现决策。包括:
- 将构建或修改的模块
- 将修改的模块接口
- 开发者提供的技术说明
- 架构决策
- 架构变更
- API 契约
- 具体交互方式
不要包含具体文件路径或代码片段,因为这些内容很快就可能过时。
例外:如果原型生成的代码片段比文字更精确地表达了某项决策(如状态机、reducer、架构或类型形状),可将其内嵌在相关决策中,并简要注明其来自原型。精简到只保留能体现决策的关键部分——不是可运行的演示,只保留重要内容。
测试决策
列出已作出的测试决策。包括:
- 对优质测试的描述(仅测试外部行为,不测试实现细节)
- 将测试的模块
- 测试方面的先例(即代码库中的类似测试)
范围之外
描述此 PRD 范围之外的内容。
补充说明
有关此功能的其他说明。
评论
支持 Markdown