opencode-workflow/design-idea/IMPLEMENTATION_CHECKLIST.md

6.5 KiB

實施檢查清單

本文件提供 Vibe-Kanban 工作流程的實施檢查清單,確保所有組件都已正確實作。


檢查清單總覽

  • Phase 1: 核心框架
  • Phase 2: 設計階段技能
  • Phase 3: 整合測試
  • Phase 4: 優化

Phase 1: 核心框架

1.1 主控技能 - vibe-kanban

skills/vibe-kanban/
├── SKILL.md                # 主技能定義
├── references/
│   └── workflow-diagram.md # 工作流程圖
└── templates/
    └── state-template.yaml # 狀態模板

SKILL.md 必須包含

  • 階段定義
  • 狀態機邏輯
  • 階段轉換條件
  • 退回機制
  • 狀態持久化邏輯
  • 進度報告格式
  • 命令列表
    • /vibe-kanban start
    • /vibe-kanban status
    • /vibe-kanban next
    • /vibe-kanban back
    • /vibe-kanban skip

狀態模板 state-template.yaml

  • 專案名稱欄位
  • 當前階段欄位
  • 歷史記錄欄位
  • 產出文件欄位
  • 阻塞原因欄位
  • 下一步動作欄位

1.2 PRD 技能 - pm-prd

skills/pm-prd/
├── SKILL.md
└── templates/
    └── prd-template.md

SKILL.md 必須包含

  • 輸入格式定義
  • 輸出格式定義
  • 功能性需求模板
  • 非功能性需求模板
  • 驗收標準模板
  • 優先級排序邏輯
  • 人類審核流程

PRD 模板 prd-template.md

  • Metadata 區塊
  • 背景區塊
  • 功能性需求區塊 (FR-001, FR-002, ...)
  • 非功能性需求區塊 (NFR-001, NFR-002, ...)
  • 驗收標準區塊 (AC-001, AC-002, ...)
  • 排期建議區塊
  • 依賴區塊
  • 風險評估區塊

Phase 2: 設計階段技能

2.1 API 設計技能 - be-api-design

skills/be-api-design/
├── SKILL.md
└── templates/
    └── openapi-template.yaml

SKILL.md 必須包含

  • RESTful API 設計原則
  • OpenAPI 3.0 規格產出
  • 請求/回應 Schema 定義
  • 錯誤處理設計
  • 安全性考量清單
  • 效能考量清單
  • 人類審核流程

OpenAPI 模板 openapi-template.yaml

  • info 區塊 (標題、版本、描述)
  • paths 區塊 (端點定義)
  • components/schemas 區塊 (資料模型)
  • responses 區塊 (回應格式)
  • securitySchemes 區塊 (安全機制)

2.2 資料庫設計技能- dba-schema

skills/dba-schema/
├── SKILL.md
└── templates/
    └── schema-template.sql

SKILL.md 必須包含

  • 資料正規化原則
  • 索引策略
  • 外鍵關聯設計
  • 遷移計畫格式
  • 效能優化建議
  • 人類審核流程

Schema 模板 schema-template.sql

  • Migration 標頭
  • Table 定義
  • Index 定義
  • Constraint 定義
  • Trigger 定義
  • Comment 定義

2.3 UX 原型技能 - ux-prototype

skills/ux-prototype/
├── SKILL.md
└── templates/
    ├── user-flow-template.md
    └── component-mapping-template.md

SKILL.md 必須包含

  • 使用者流程圖產出
  • 線框圖描述格式
  • 元件與 API 對應邏輯
  • 原型工具建議
  • 人類審核流程

使用者流程模板 user-flow-template.md

  • Mermaid 流程圖
  • 頁面清單表格
  • 頁面 URL 對應

元件對應模板 component-mapping-template.md

  • 頁面元件列表
  • 元件資料來源
  • API 端點對應
  • 快取策略建議

Phase 3: 整合測試

3.1 端到端流程測試

  • 測試案例 1: 完整流程從頭到尾
    • [Brainstorming → CEO Review → PRD → ... → Deploy]
  • 測試案例 2: CEO 審核退回
    • [Brainstorming → CEO Review (失敗) → Brainstorming]
  • 測試案例 3: QA 失敗退回
    • [所有階段 → QA (失敗) → Task Breakdown]
  • 測試案例 4: PR 審核失敗退回
    • [所有階段 → PR Review (失敗) → Task Breakdown]

3.2 狀態持久化測試

  • 測試狀態檔案建立
  • 測試狀態檔案更新
  • 測試狀態檔案恢復
  • 測試狀態檔案損壞處理

3.3 退回機制測試

  • 測試退回到上一階段
  • 測試退回到特定階段
  • 測試退回後的產出清理
  • 測試退回後重新執行

3.4 併發測試

  • 測試多專案併發執行
  • 測試鎖機制
  • 測試資源競爭

Phase 4: 優化

4.1 效能優化

  • 階段轉換時間優化
  • 檔案讀寫優化
  • 快取機制實作

4.2 錯誤處理優化

  • 友善錯誤訊息
  • 錯誤恢復機制
  • 錯誤日誌記錄

4.3 使用者體驗優化

  • 進度視覺化
  • 預估時間顯示
  • 歷史記錄瀏覽

4.4 文件完善

  • 使用者指南
  • 開發者文件
  • API 文件
  • 最佳實踐指南

測試矩陣

功能測試

功能 測試案例 預期結果 實際結果 狀態
開始新專案 輸入專案名稱 建立狀態檔案 [ ]
查看狀態 執行status 顯示當前階段 [ ]
前往下一階段 執行 next 狀態更新 [ ]
退回上一階段 執行 back 狀態回滾 [ ]
跳過階段 執行 skip 狀態跳過 [ ]

整合測試

整合點 測試案例 預期結果 實際結果 狀態
PM → CEO PRD 審核通過 進入 API 設計 [ ]
CEO 失敗 PRD 審核失敗 退回Brainstorming [ ]
QA 失敗 測試不通過 退回 Task Breakdown [ ]
Deploy 部署成功 專案完成 [ ]

效能測試

指標 目標 實際 狀態
階段轉換時間 < 5 秒 [ ]
狀態載入時間 < 1 秒 [ ]
檔案寫入時間 < 2 秒 [ ]

部署檢查清單

部署前

  • 所有測試通過
  • 文件完整
  • 版本號更新
  • CHANGELOG 更新

部署中

  • 備份現有版本
  • 部署新版本
  • 驗證部署成功

部署後

  • 監控錯誤日誌
  • 驗證功能正常
  • 更新使用文件

維護檢查清單

每週

  • 檢查錯誤日誌
  • 檢查效能指標
  • 檢查使用者反饋

每月

  • 更新技能版本
  • 審核技術債
  • 優化流程

每季

  • 全面測試回歸
  • 安全性審核
  • 架構審核

簽核記錄

階段 審核人 日期 簽核
Phase 1 [ ]
Phase 2 [ ]
Phase 3 [ ]
Phase 4 [ ]
最終審核 [ ]