write-a-prd
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseThis skill will be invoked when the user wants to create a PRD. You may skip steps if you don't consider them necessary.
-
Ask the user for a long, detailed description of the problem they want to solve and any potential ideas for solutions.
-
Explore the repo to verify their assertions and understand the current state of the codebase.
-
Interview the user relentlessly about every aspect of this plan until you reach a shared understanding. Walk down each branch of the design tree, resolving dependencies between decisions one-by-one.
-
Sketch out the major modules you will need to build or modify to complete the implementation. Actively look for opportunities to extract deep modules that can be tested in isolation.
A deep module (as opposed to a shallow module) is one which encapsulates a lot of functionality in a simple, testable interface which rarely changes.
Check with the user that these modules match their expectations. Check with the user which modules they want tests written for.
- Once you have a complete understanding of the problem and solution, use the template below to write the PRD. The PRD should be written as a local markdown file at . Create the
issues/prd.mddirectory if it doesn't exist. Do NOT submit a GitHub issue or call any external service.issues/
当用户想要创建PRD时,将调用此skill。如果认为某些步骤不必要,可跳过这些步骤。
-
向用户索要他们想要解决的问题的详细描述,以及任何潜在的解决方案思路。
-
浏览代码仓库,验证用户的表述并了解代码库的当前状态。
-
针对该计划的各个方面持续询问用户,直到达成共识。梳理设计树的每个分支,逐一解决决策之间的依赖关系。
-
草拟完成实现所需构建或修改的主要模块。主动寻找可提取为独立可测试深度模块的机会。
深度模块(相对于浅层模块而言)是指通过简单、可测试且极少变更的接口封装大量功能的模块。
与用户确认这些模块是否符合他们的预期。询问用户希望为哪些模块编写测试。
- 一旦完全理解问题和解决方案,使用以下模板编写PRD。PRD应写入本地markdown文件。如果
issues/prd.md目录不存在则创建该目录。请勿提交GitHub issue或调用任何外部服务。issues/
Problem Statement
问题陈述
The problem that the user is facing, from the user's perspective.
从用户视角描述其面临的问题。
Solution
解决方案
The solution to the problem, from the user's perspective.
从用户视角描述问题的解决方案。
User Stories
用户故事
A LONG, numbered list of user stories. Each user story should be in the format of:
- As an <actor>, I want a <feature>, so that <benefit>
This list of user stories should be extremely extensive and cover all aspects of the feature.
一份详细的编号用户故事列表。每个用户故事应采用以下格式:
- 作为<角色>,我想要<功能>,以便<收益>
这份用户故事列表应尽可能详尽,覆盖该功能的所有方面。
Implementation Decisions
实现决策
A list of implementation decisions that were made. This can include:
- The modules that will be built/modified
- The interfaces of those modules that will be modified
- Technical clarifications from the developer
- Architectural decisions
- Schema changes
- API contracts
- Specific interactions
Do NOT include specific file paths or code snippets. They may end up being outdated very quickly.
已做出的实现决策列表,可包括:
- 将要构建/修改的模块
- 将要修改的模块接口
- 来自开发者的技术说明
- 架构决策
- 模式变更
- API契约
- 特定交互逻辑
请勿包含具体文件路径或代码片段,这些内容可能很快过时。
Testing Decisions
测试决策
A list of testing decisions that were made. Include:
- A description of what makes a good test (only test external behavior, not implementation details)
- Which modules will be tested
- Prior art for the tests (i.e. similar types of tests in the codebase)
已做出的测试决策列表,包括:
- 优质测试的定义(仅测试外部行为,而非实现细节)
- 将要测试的模块
- 测试的参考案例(即代码库中类似类型的测试)
Out of Scope
范围外内容
A description of the things that are out of scope for this PRD.
描述本PRD不涵盖的内容。
Further Notes
补充说明
Any further notes about the feature.
</prd-template>关于该功能的任何补充说明。
</prd-template>