術語表
每個 OpenSpec 術語,一行一個。
OpenSpec 重複使用了在 git、CI 和代理工具中有其他含義的詞語。每一列給出 OpenSpec 的含義。最後一欄連結到更多詳細資訊(若有)。
| 術語 | 定義 | 更多資訊 |
|---|---|---|
| Apply | 實作變更提案中的任務。技能:openspec-apply-change。 | 套用變更 |
| Archive | 完成變更提案:將其差異合併到主規格中,並將其資料夾移至 openspec/changes/archive/。 | 快速入門 |
| Artifact | 變更提案內的規劃文件:proposal.md、差異規格、design.md、tasks.md。不是建置輸出。 | 產出物 |
| Capability | 系統的一個行為領域。每個功能在 openspec/specs/<capability>/spec.md 有一個規格。 | 功能 |
| Change proposal | 一個工作單元:openspec/changes/<name>/ 下的一個資料夾,包含其規劃產出物。常簡稱為「變更」。不是 git 提交。 | 提案 |
| Command | 工作流程的輸入入口點。不同工具的拼寫不同(/opsx:propose、/opsx-propose)。文件則以技能名稱來稱呼工作流程。 | 支援的工具 |
| Continue | 為現有的變更提案建立下一個規劃產出物。技能:openspec-continue-change。 | 技能 |
| Delivery | 工作流程的安裝方式:作為技能、指令或兩者兼有。 | 設定你的專案 |
| Delta spec | 變更提案中的一個規格,僅列出變更內容,置於 ADDED、MODIFIED、REMOVED 和 RENAMED 標題下。 | 差異規格 |
| Explore | 在提案前與代理一起深入思考一個想法。不撰寫程式碼。技能:openspec-explore。 | 探索想法 |
| Fast-forward | 一次建立包含所有規劃產出物的變更提案,即可開始實作。技能:openspec-ff-change。不是 git 的快進。 | 技能 |
| Legacy workflow | OPSX 之前的 /openspec:* 指令。 | |
| Loop | 變更提案經歷的循環:探索、提案、審查、套用、歸檔。 | 快速入門 |
| Main specs | openspec/specs/ 樹狀結構:系統當前約定的行為。歸檔時會將差異合併到其中。尚無規格的功能會從其 ADDED 需求獲得規格。 | 歸檔 |
| OpenSpec root | 指令解析並操作所在的 openspec/ 樹狀結構:你的儲存庫的,或是儲存區的。 | 儲存區 |
| OPSX | 目前的 OpenSpec 工作流程系統,以及它所安裝的指令前綴(/opsx:)。 | |
| Profile | 初始化時安裝哪些工作流程:core 或 custom。 | 設定檔 |
| Propose | 一步建立變更提案並產生所有規劃產出物。技能:openspec-propose。 | 快速入門 |
| Registry | 機器層級的已註冊儲存區清單,位於 registry.yaml。不是套件登錄庫。 | CLI |
| Requirement | 系統必須具有的行為,在規格中以 SHALL 撰寫:### Requirement:。 | 差異規格 |
| Scenario | 需求下的一個可測試範例,以 WHEN/THEN 形式呈現。 | 差異規格 |
| Schema | 定義變更提案會產生哪些產出物及其順序。不是 JSON Schema。 | 結構定義 |
| Skill | 工作流程的指令,安裝在 AI 工具讀取的地方(.agents/skills/ 等)。 | 技能 |
| Spec | 描述一個功能目前行為的檔案,位於 openspec/specs/<capability>/spec.md。 | 歸檔 |
| spec-driven | 預設結構定義:提案、差異規格、設計、任務。 | spec-driven |
| Store | 一個獨立的 OpenSpec 儲存庫,在你的機器上註冊,用於跨儲存庫的規劃。不是資料儲存區。 | 儲存區(測試版) |
| Sync | 無需歸檔,將已實作的差異合併到主規格中。技能:openspec-sync-specs。 | 技能 |
| Template | 結構定義提供給每個產出物的起始內容。 | 結構定義 |
| Update | 作為技能(openspec-update-change):修訂變更提案的規劃產出物。作為 CLI 指令(openspec update):重新整理 OpenSpec 已安裝的檔案。 | 更新變更, CLI |
| Verify | 在歸檔前檢查實作是否與變更提案的產出物相符。技能:openspec-verify-change。 | 技能 |
| Workflow | 一個命名的 OpenSpec 動作(提案、套用、歸檔等),以技能或指令形式安裝到你的 AI 工具中。 | 設定你的專案 |
| Workset | 個人的本機資料夾群組,在一個工具中一起開啟。不是儲存區,且不會共用任何東西。 | 工作集(測試版) |