SuperAPI AI 工具集

ralph-tui-prd

写作与研究

查看项目

更新于 10-16 09:40

技能介绍

用途

ralph-tui-prd 用于为 ralph-tui 任务编排生成产品需求文档(PRD)。它面向需要通过 AI 编码智能体执行任务的场景,产出经过优化的 PRD,使后续的 ralph-tui 流程能够将用户故事转换为 beads issues 等可执行任务。该技能的核心职责是“只创建 PRD,不开始实现”。

主要能力

  • 接收用户提供的功能描述。
  • 提出 3-5 个关键澄清问题,每个问题带字母选项,且每次只问一组。
  • 始终询问质量门禁(哪些命令必须通过)。
  • 根据每次回答自适应地追问后续问题,通常需要 2-4 轮问答。
  • 在获得足够上下文后,生成结构化 PRD。
  • 将最终 PRD 用 [PRD]...[/PRD] 标记包裹,供 TUI 解析。

使用方式

技能以问答方式驱动。问题格式示例:

  1. What is the primary goal of this feature? A. Improve user onboarding experience B. Increase user retention C. Reduce support burden D. Other: [please specify]

  2. Who is the target user? A. New users only B. Existing users only C. All users D. Admin users only

用户可以用“1A, 2C”这样的方式快速回答。

如果是在 Claude Code 交互式会话中,可以用 AskUserQuestion 工具呈现这些问题(问题与选项相同,仍每次一组)。当该技能由 ralph-tui create-prd 驱动时,智能体以非交互方式运行,无法响应工具调用,因此需以纯文本加字母选项的方式提问。

质量门禁问题(必需)示例:

What quality commands must pass for each user story? A. pnpm typecheck && pnpm lint B. npm run typecheck && npm run lint C. bun run typecheck && bun run lint D. Other: [specify your commands]

For UI stories, should we include browser verification? A. Yes, use dev-browser skill to verify visually B. No, automated tests are sufficient

自适应提问:每次回答后,决定是继续追问、转向新方面,还是直接生成 PRD。

PRD 结构

生成的 PRD 包含以下章节:

  1. Introduction/Overview:功能简述及其解决的问题。
  2. Goals:具体、可衡量的目标(项目符号列表)。
  3. Quality Gates:每个用户故事都必须通过的命令。该章节会被转换工具(ralph-tui-create-json、ralph-tui-create-beads)提取并附加到每个故事的验收标准中。示例:

Quality Gates

These commands must pass for every user story:

  • pnpm typecheck - Type checking
  • pnpm lint - Linting

For UI stories, also include:

  • Verify in browser using dev-browser skill
  1. User Stories:每个故事包含标题、描述(“As a [user], I want [feature] so that [benefit]”)和可验证的验收标准清单。每个故事应小到可在一次专注的 AI 智能体会话中完成。格式示例:

US-001: [Title]

Description: As a [user], I want [feature] so that [benefit].

Acceptance Criteria:

  • [ ] Specific verifiable criterion
  • [ ] Another criterion

注意:不要在单个故事的验收标准中写入质量门禁命令——它们只在 Quality Gates 章节定义一次,并在转换时自动应用。验收标准必须可验证,不能含糊(“Works correctly”不好,“Button shows confirmation dialog before deleting”好),且每个故事应可独立完成。

  1. Functional Requirements:编号的具体功能列表,如“FR-1: The system must allow users to...”。
  2. Non-Goals (Out of Scope):该功能不包含的内容,用于管理范围。
  3. Technical Considerations (Optional):已知约束或依赖、与现有系统的集成点、性能要求。
  4. Success Metrics:如何衡量成功。
  5. Open Questions:剩余问题或需要澄清的领域。

面向 AI 智能体的写作要求

由于 PRD 将由 AI 编码智能体通过 ralph-tui 执行,因此要求:明确无歧义;用户故事要小(可在一次会话内完成);验收标准尽可能可机器验证;如知道具体文件路径则包含;引用项目中已有的代码模式。

输出格式

最终 PRD 必须用标记包裹:

[PRD]

PRD: Feature Name

Overview

...

Quality Gates

...

User Stories

... [/PRD]

文件命名:TUI 会保存到 ./tasks/prd-[feature-name].md。

适用场景

适用于需要为 ralph-tui 编排的 AI 编码任务预先定义需求、用户故事和验收标准的场景,尤其是希望将 PRD 转换为 beads issues 或其他可执行任务时。

限制

  • 该技能只生成 PRD,不进行实现。
  • 当由 ralph-tui create-prd 驱动时,智能体非交互运行,无法响应工具调用,只能以纯文本加字母选项提问。
  • 关于收费、价格、平台支持范围等信息,资料中暂未提供。