Ralph TUI PRD 產生器
建立針對 AI agent 透過 ralph-tui 執行而最佳化的詳細產品需求文件。
任務
- 從使用者接收功能說明
- 提出 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 skill 進行視覺驗證
B. 否,自動化測試已足夠
自適應提問
每次回覆後,決定是否要:
- 提出後續問題(如果答案顯示複雜性)
- 詢問新的方面(如果當前領域已清楚)
- 產生 PRD(如果你有足夠的上下文)
通常需要 2-4 輪的問題。
步驟 2:PRD 結構
使用以下章節產生 PRD:
1. 簡介/概述
功能的簡要描述以及它解決的問題。
2. 目標
具體、可衡量的目標(項目符號列表)。
3. 品質關卡
關鍵: 列出每個使用者故事都必須通過的指令。
## 品質關卡
這些指令必須通過每個使用者故事:
- `pnpm typecheck` - 型別檢查
- `pnpm lint` - Linting
對於 UI 故事,也需包含:
- 使用 dev-browser 技能在瀏覽器中驗證
此章節會被轉換工具(ralph-tui-create-json、ralph-tui-create-beads)擷取,並附加到每個故事的驗收標準。
4. 使用者故事
每個故事需要:
- 標題: 簡短的描述性名稱
- 描述: 「身為一個 [使用者],我想要 [功能] 以便 [效益]」
- 驗收標準: 可驗證的核取清單,說明「完成」的定義
每個故事應夠小,以便在一個專注的 AI agent 會話中實作。
格式:
### US-001:[標題]
**描述:** 身為一個 [使用者],我想要 [功能] 以便 [效益]。
**驗收標準:**
- [ ] 特定的可驗證標準
- [ ] 另一個標準
注意: 請勿在個別故事標準中包含品質關卡指令——它們在品質關卡章節中一次性定義,並在轉換過程中自動套用。
重要:
- 驗收標準必須是可驗證的,而非含糊不清
- 「正常運作」是不好的
- 「按鈕在刪除前顯示確認對話框」是好的
- 每個故事應可獨立完成
5. 功能需求
編號的具體功能列表:
- 「FR-1:系統必須允許使用者...」
- 「FR-2:當使用者點擊 X 時,系統必須...」
要明確且無歧義。
6. 非目標(超出範圍)
此功能將不包含的內容。對於管理範圍至關重要。
7. 技術考量(選擇性)
- 已知的限制或依賴關係
- 與現有系統的整合點
- 效能要求
8. 成功指標
如何衡量成功?
9. 未解決的問題
殘留的問題或需要釐清的領域。
為 AI Agent 撰寫
PRD 將由 AI 編碼 agent 透過 ralph-tui 執行。因此:
- 要明確且無歧義
- 使用者故事應小(可在一個會話中完成)
- 驗收標準必須在可能的情況下可被機器驗證
- 如果知道,請包含特定的檔案路徑
- 參考專案中現有的程式碼模式
輸出格式
關鍵: 將最終的 PRD 包裹在標記中,以供 TUI 解析:
[PRD]
# PRD:功能名稱
## 概述
...
## 品質關卡
...
## 使用者故事
...
[/PRD]
檔案命名: TUI 將儲存至 ./tasks/prd-[功能名稱].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 skill B. 否,自動化測試已足夠
使用者: 3A, 4A, 5A
助理: 完美,我已有足夠資訊來產生 PRD。
[PRD]
PRD:Ralph TUI 深色模式
概述
為 ralph-tui 加入深色模式支援,以減輕長時間排程會話期間的眼睛疲勞。此功能將套用至所有 TUI 元件,並將使用者的偏好儲存在設定檔中。
目標
- 在低光源環境下提供舒適的觀看體驗
- 跨會話持續保存主題偏好
- 對所有 TUI 元件套用一致的樣式
品質關卡
這些指令必須通過每個使用者故事:
pnpm typecheck- 型別檢查pnpm lint- Linting
對於 UI 故事,也需包含:
- 使用 dev-browser 技能在瀏覽器中驗證
使用者故事
US-001:加入主題設定
描述: 身為一個使用者,我想要設定我的偏好的主題(淺色/深色),以便它跨會話持續保存。
驗收標準:
- 將
theme欄位加入.ralph-tui.yaml架構 - 支援值:「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]標記包裹