使用者輸入
$ARGUMENTS
在繼續之前,你必須考慮使用者輸入(若非空)。
執行前檢查
檢查擴充掛鉤(規劃前):
- 檢查專案根目錄是否存在
.specify/extensions.yml。 - 若存在,則讀取其內容,並查找
hooks.before_plan鍵下的條目。 - 若 YAML 無法解析或無效,不要直接跳過:告知使用者無法讀取
.specify/extensions.yml(包含解析器錯誤),且未檢查任何掛鉤,包括其中註冊的任何強制性(optional: false)掛鉤,然後繼續正常執行。 - 篩選掉
enabled明確設為false的掛鉤。對於沒有enabled欄位的掛鉤,視為預設啟用。 - 對於其餘每個掛鉤,不要嘗試解釋或評估掛鉤的
condition表達式:- 若掛鉤沒有
condition欄位,或該欄位為 null/空,則將掛鉤視為可執行。 - 若掛鉤定義了非空的
condition,則跳過該掛鉤,將條件評估留給 HookExecutor 實作。
- 若掛鉤沒有
- 建構來自掛鉤命令名稱的命令調用時,將點號 (
.) 替換為連字號 (-)。例如,speckit.git.commit→/speckit-git-commit。 - 對於每個可執行的掛鉤,根據其
optional標記輸出以下內容:- 可選掛鉤(
optional: true):## 擴充掛鉤 **可選前置掛鉤**:{extension} 命令:`/{command}` 描述:{description} 提示:{prompt} 要執行:`/{command}` - 強制性掛鉤(
optional: false):
輸出上述區塊後,你必須實際調用該掛鉤並等待其完成,然後再繼續。以你在此代理/會話中執行命令的相同方式執行它(調用方式可能與上面顯示的字面## 擴充掛鉤 **自動前置掛鉤**:{extension} 正在執行:`/{command}` EXECUTE_COMMAND:{command} 在繼續到大綱之前,請等待掛鉤命令的結果。{command}ID 不同,例如,技能模式代理會將其作為/skill:speckit-...或$speckit-...執行)。僅輸出區塊並不會執行掛鉤。
- 可選掛鉤(
- 若沒有註冊掛鉤或
.specify/extensions.yml不存在,則直接跳過。
大綱
-
設定:從倉庫根目錄執行
.specify/scripts/bash/setup-plan.sh --json並解析 JSON 以獲取 FEATURE_SPEC、IMPL_PLAN、FEATURE_DIR、BRANCH。對於參數中的單引號(例如 "I'm Groot"),使用跳脫語法:例如 'I'''m Groot'(或盡可能使用雙引號:"I'm Groot")。 -
載入上下文:讀取 FEATURE_SPEC 和
.specify/memory/constitution.md。載入 IMPL_PLAN 模板(已複製)。 -
執行計畫工作流程:遵循 IMPL_PLAN 模板中的結構:
- 填寫技術背景(將未知項標記為「需要釐清」)
- 從 constitution 填寫憲法檢查章節
- 評估閘門(若違規無正當理由則報錯)
- 階段 0:產生 research.md(解決所有「需要釐清」問題)
- 階段 1:產生 data-model.md、contracts/、quickstart.md
- 設計完成後重新評估憲法檢查
強制性執行後掛鉤
在向使用者報告完成之前,你必須完成此部分。
檢查專案根目錄是否存在 .specify/extensions.yml。
- 若不存在,或
hooks.after_plan下沒有註冊掛鉤,則跳至完成報告。 - 若存在,則讀取其內容,並查找
hooks.after_plan鍵下的條目。 - 若 YAML 無法解析或無效,不要直接跳過:告知使用者無法讀取
.specify/extensions.yml(包含解析器錯誤),且未檢查任何掛鉤,包括其中註冊的任何強制性(optional: false)掛鉤,然後繼續到完成報告。 - 篩選掉
enabled明確設為false的掛鉤。對於沒有enabled欄位的掛鉤,視為預設啟用。 - 對於其餘每個掛鉤,不要嘗試解釋或評估掛鉤的
condition表達式:- 若掛鉤沒有
condition欄位,或該欄位為 null/空,則將掛鉤視為可執行。 - 若掛鉤定義了非空的
condition,則跳過該掛鉤,將條件評估留給 HookExecutor 實作。
- 若掛鉤沒有
- 建構來自掛鉤命令名稱的命令調用時,將點號 (
.) 替換為連字號 (-)。例如,speckit.git.commit→/speckit-git-commit。 - 對於每個可執行的掛鉤,根據其
optional標記輸出以下內容:- 強制性掛鉤(
optional: false)— 你必須為每個強制性掛鉤輸出EXECUTE_COMMAND::
輸出上述區塊後,你必須實際調用該掛鉤並等待其完成,然後再繼續。以你在此代理/會話中執行命令的相同方式執行它(調用方式可能與上面顯示的字面## 擴充掛鉤 **自動掛鉤**:{extension} 正在執行:`/{command}` EXECUTE_COMMAND:{command}{command}ID 不同,例如,技能模式代理會將其作為/skill:speckit-...或$speckit-...執行)。僅輸出區塊並不會執行掛鉤。 - 可選掛鉤(
optional: true):## 擴充掛鉤 **可選掛鉤**:{extension} 命令:`/{command}` 描述:{description} 提示:{prompt} 要執行:`/{command}`
- 強制性掛鉤(
完成報告
命令在階段 1 設計完成後結束。報告分支、IMPL_PLAN 路徑以及產生的產出物。
階段
階段 0:大綱與研究
-
從上述技術背景中提取未知項:
- 對於每個「需要釐清」→ 研究任務
- 對於每個依賴項 → 最佳實踐任務
- 對於每個整合 → 模式任務
-
產生並分派研究代理:
對於技術背景中的每個未知項: 任務:「為 {feature context} 研究 {unknown}」 對於每個技術選擇: 任務:「尋找 {domain} 中 {tech} 的最佳實踐」 -
在
research.md中整合發現,使用以下格式:- 決策:[選擇了什麼]
- 理由:[為什麼選擇]
- 考慮過的替代方案:[還評估了哪些]
輸出:包含所有已解決「需要釐清」問題的 research.md
階段 1:設計與合約
先決條件: research.md 完成
-
從功能規格中提取實體 →
data-model.md:- 實體名稱、欄位、關係
- 根據需求的驗證規則
- 狀態轉換(若適用)
-
定義介面合約(若專案有外部介面)→
/contracts/:- 確定專案向使用者或其他系統暴露哪些介面
- 記錄適合專案類型的合約格式
- 範例:函式庫的公開 API、CLI 工具的命令結構、Web 服務的端點、解析器的語法、應用程式的 UI 合約
- 若專案純為內部使用(建置腳本、一次性工具等),則跳過此步驟
-
建立快速入門驗證指南 →
quickstart.md:- 記錄可執行的驗證場景,以證明功能端到端運作
- 包含先決條件、設定命令、測試/運行命令以及預期結果
- 使用連結或引用合約和資料模型詳細資訊,而不是重複它們
- 不要包含完整的實作程式碼、模型/服務/控制器主體、遷移或完整的測試套件
- 將此產出物保留為驗證/運行指南;實作細節屬於
tasks.md和實作階段
輸出:data-model.md、/contracts/*、quickstart.md
關鍵規則
- 檔案系統操作使用絕對路徑;文件中的參考使用相對於專案的路徑
- 閘門失敗或未解決的釐清事項則報錯
完成條件
- 計畫工作流程已執行並產生設計產出物
- 擴充掛鉤已依照上述強制性執行後掛鉤中的規則分派或跳過
- 已向使用者報告完成,包含分支、計畫路徑和產生的產出物