Ralph TUI PRD 生成器
创建针对ralph-tui AI代理执行优化的详细产品需求文档。
任务
- 从用户处接收功能描述
- 每次询问一组3-5个关键问题(带字母选项)——一次只问一组
- 始终询问质量门禁(哪些命令必须通过)
- 每次回答后,根据需要提出后续问题(自适应探索)
- 当上下文信息足够时,生成结构化的PRD
- 输出用
[PRD]...[/PRD]标记包裹的PRD,以供TUI解析
重要: 不要开始实现。只需创建PRD。
步骤1:澄清问题(迭代式)
一次只问一组问题。每个答案应为你的下一个问题提供信息。重点关注:
- 问题/目标: 此功能解决什么问题?
- 核心功能: 关键操作是什么?
- 范围/边界: 它不应该做什么?
- 成功标准: 我们如何知道它完成了?
- 集成: 它如何与现有功能配合?
- 质量门禁: 每个故事必须通过哪些命令?(必需)
问题格式示例:
1. 这项功能的主要目标是什么?
A. 改善用户上手体验
B. 提高用户留存率
C. 减少支持负担
D. 其他:[请说明]
2. 目标用户是谁?
A. 仅限新用户
B. 仅限现有用户
C. 所有用户
D. 仅限管理员用户
这样用户就可以用“1A, 2C”的方式快速回答。
质量门禁问题(必需)
始终询问质量门禁——这些是项目特定的:
每个用户故事必须通过哪些质量命令?
A. pnpm typecheck && pnpm lint
B. npm run typecheck && npm run lint
C. bun run typecheck && bun run lint
D. 其他:[指定你的命令]
对于UI故事,是否需要包含浏览器验证?
A. 是,使用dev-browser技能进行视觉验证
B. 否,自动化测试足够
自适应提问
在每次回答后,决定是:
- 提出后续问题(如果回答揭示了复杂性)
- 询问一个新方面(如果当前领域已明确)
- 生成PRD(如果你有足够的上下文)
通常需要2-4轮提问。
步骤2:PRD结构
生成包含以下部分的PRD:
1. 引言/概述
简要描述功能及其解决的问题。
2. 目标
具体、可衡量的目标(项目符号列表)。
3. 质量门禁
关键: 列出每个用户故事都必须通过的命令。
## 质量门禁
这些命令必须为每个用户故事通过:
- `pnpm typecheck` - 类型检查
- `pnpm lint` - 代码检查
对于UI故事,还包括:
- 使用dev-browser技能在浏览器中验证
此部分由转换工具(ralph-tui-create-json, ralph-tui-create-beads)提取,并附加到每个故事的验收标准中。
4. 用户故事
每个故事需要:
- 标题: 简短描述性名称
- 描述: "作为[用户],我想要[功能],以便[收益]"
- 验收标准: 可验证的检查清单,定义“完成”的含义
每个故事都应足够小,以便在一个专注的AI代理会话中实现。
格式:
### US-001:[标题]
**描述:** 作为[用户],我想要[功能],以便[收益]。
**验收标准:**
- [ ] 具体的可验证标准
- [ ] 另一个标准
注意: 不要在单个故事标准中包含质量门禁命令——它们在质量门禁部分中一次性定义,并在转换过程中自动应用。
重要:
- 验收标准必须是可验证的,不能模糊
- “正常工作”是不好的
- “在删除前,按钮显示确认对话框”是好的
- 每个故事应能独立完成
5. 功能需求
编号的具体功能列表:
- “FR-1:系统必须允许用户...”
- “FR-2:当用户点击X时,系统必须...”
要明确且无歧义。
6. 非目标(范围外)
此功能不会包含的内容。对于管理范围至关重要。
7. 技术考量(可选)
- 已知的约束或依赖项
- 与现有系统的集成点
- 性能需求
8. 成功指标
如何衡量成功?
9. 开放问题
剩余的问题或需要澄清的领域。
为AI代理编写
PRD将由AI编码代理通过ralph-tui执行。因此:
- 要明确且无歧义
- 用户故事应小(在一个会话中完成)
- 验收标准应尽可能机器可验证
- 如果你知道具体文件路径,请包含它们
- 参考项目中现有的代码模式
输出格式
关键: 将最终PRD用标记包裹,以供TUI解析:
[PRD]
# PRD:功能名称
## 概述
...
## 质量门禁
...
## 用户故事
...
[/PRD]
文件命名: TUI将保存到 ./tasks/prd-[feature-name].md
对话流程示例
用户: 为TUI添加深色模式创建一个PRD
助手: 我将帮你为深色模式创建一个PRD。让我先问几个问题:
-
主要目标是什么? A. 减少长时间会话的眼疲劳 B. 与系统主题偏好匹配 C. 提供视觉自定义 D. 其他
-
设置应该持久化吗? A. 是,保存到配置文件 B. 否,仅限会话 C. 跟随系统偏好
用户: 1A, 2A
助手: 很好!还有几个问题:
-
哪些组件需要深色模式支持? A. 所有TUI组件 B. 仅主执行视图 C. 主视图 + 设置 D. 其他
-
每个故事必须通过哪些质量命令? A. pnpm typecheck && pnpm lint B. npm run typecheck && npm run lint C. bun run typecheck D. 其他:[指定]
-
对于UI故事,需要包含浏览器验证吗? A. 是,使用dev-browser技能 B. 否,自动化测试足够
用户: 3A, 4A, 5A
助手: 完美,我有足够的信息来生成PRD了。
[PRD]
PRD:Ralph TUI深色模式
概述
为ralph-tui添加深色模式支持,以减少长时间编排会话期间的眼疲劳。该功能将应用于所有TUI组件,并将用户的偏好持久化到配置文件中。
目标
- 在低光环境下提供舒适的观看体验
- 跨会话持久化主题偏好
- 对所有TUI组件应用一致的样式
质量门禁
这些命令必须为每个用户故事通过:
pnpm typecheck- 类型检查pnpm lint- 代码检查
对于UI故事,还包括:
- 使用dev-browser技能在浏览器中验证
用户故事
US-001:添加主题配置
描述: 作为用户,我想要设置我偏好的主题(浅色/深色),以便它能在会话之间持久化。
验收标准:
- 向
.ralph-tui.yamlschema 添加theme字段 - 支持值:“light”,“dark”,“system”
- 为了向后兼容,默认值为“light”
US-002:创建深色主题调色板
描述: 作为用户,我想要一个低对比度的深色主题,它要护眼。
验收标准:
- 定义使用灰色调的深色调色板(非纯黑)
- 确保足够的对比度(WCAG AA)
- 颜色在所有UI状态下(选定、悬停、禁用)都表现良好
US-003:将主题应用于TUI组件
描述: 作为用户,我想要所有TUI组件都尊重我的主题偏好。
验收标准:
- 头部组件使用主题颜色
- 任务列表使用主题颜色
- 详情面板使用主题颜色
- 进度条使用主题颜色
- 对话框使用主题颜色
US-004:在设置中添加主题切换
描述: 作为用户,我想要在TUI设置中切换主题。
验收标准:
- 主题选项在设置视图中可见
- 更改无需重启即可立即应用
- 更改持久化到配置文件
功能需求
- FR-1:必须能从
.ralph-tui.yaml读取主题设置 - FR-2:主题必须在TUI启动时应用
- FR-3:设置中的主题更改必须立即应用
- FR-4:所有文本在两种主题下都必须保持可读性
非目标
- 系统主题自动检测(未来增强)
- 浅色/深色以外的自定义配色方案
- 每个组件的主题覆盖
技术考量
- 如果可用,使用现有的OpenTUI主题功能
- 考虑为React组件创建 ThemeContext
- 主题更改时最小化重新渲染
成功指标
- 所有组件在深色模式下正确渲染
- 无无障碍对比度问题
- 主题跨会话持久化
开放问题
- 我们是否应该在v2中自动检测系统主题偏好? [/PRD]
清单
在输出PRD之前:
- 询问了带字母选项的澄清问题
- 询问了质量门禁(必需)
- 在需要时询问了后续问题
- 包含带有项目特定命令的质量门禁部分
- 用户故事小而独立,可单独完成
- 用户故事不包含质量门禁命令(它们在质量门禁部分)
- 功能需求已编号且无歧义
- 非目标部分定义了明确的范围边界
- PRD用
[PRD]...[/PRD]标记包裹