board-workflow
v0.1.0
Published
Structured AI development workflow for Claude Code
Downloads
133
Maintainers
Readme
board-workflow
為 Claude Code 設計的結構化 AI 協作開發工作流程。讓每個任務都有可追蹤的生命週期——從需求確認到 commit——確保脈絡不因對話結束而消失。
安裝
npm install -g board-workflow快速開始
# 初始化到當前專案
cd your-project
board-workflow init
# 或指定路徑
board-workflow init /path/to/project接著在 Claude Code 中執行:
/board:init引導建立 project.md 與 FEATURE_MAP.md,讓 Claude 了解你的專案結構。
運作方式
任務透過目錄模擬看板狀態流轉:
/board:new → plan/ → todo/ → doing/ → done/每個任務是一個目錄,包含六個文件:
| 文件 | 職責 |
|------|------|
| issue.md | 任務描述(What & Why) |
| questions.md | 執行前待確認問題(gate) |
| criteria.md | 驗收條件 |
| spec.md | Claude 起草的開發規格書 |
| task.md | 執行時的可勾選工作清單 |
| context.md | 完整歷程紀錄 + git commits |
Gate 機制
questions.md 採用問答格式,只要有未回答的問題(空白 A:),工單就無法移至 doing/,防止帶著未確認的前提開始實作。
./scripts/issue.sh start TASK-0001
# ⚠ TASK-0001 的 questions.md 有未回答的問題,請先確認後再繼續指令
| 指令 | 說明 |
|------|------|
| /board:init | 初始化工作流程,建立 project.md 與 FEATURE_MAP.md |
| /board:new | 建立新工單,對話中逐題確認問題 |
| /board:plan | 列出 plan/ 工單,選擇移至 todo 或 doing |
| /board:execute | 執行 doing/ 的工單 |
| /board:status | 查看目前工單狀態 |
| /board:status done | 含已完成工單 |
Scripts
./scripts/issue.sh todo <ID> # plan → todo
./scripts/issue.sh start <ID> # plan/todo → doing
./scripts/issue.sh done <ID> # doing → done
./scripts/board.sh # 查看進行中工單
./scripts/board.sh all # 查看所有工單(含已完成)Container 環境
在 board.config.md 設定 EXEC_CMD,測試指令會自動在 container 內執行:
EXEC_CMD: docker-compose exec appscripts/run.sh 會自動讀取此設定。
License
MIT
