OpenSpec

OpenSpecAI 助理的規格驅動開發

用於建置與管理 AI 助理專案的輕量級規格。

開始使用
首頁

  • 規格優先工作流程

    在撰寫程式碼之前先定義需求。

  • AI 原生設計

    專為 Claude Code、Cursor、Windsurf 等工具打造。

  • 多語言

    提供多語言文件。

OpenSpec 文件 ​

歡迎。這裡是 OpenSpec 的一切資訊中心。

OpenSpec 幫助你與你的 AI 程式助理在撰寫任何程式碼之前，就先對要建置的內容達成共識。你描述變更，AI 草擬一份簡短的規格與任務清單，你們一起審視同一份計畫，然後才開始實作。再也不會做到一半才發現 AI 做了錯誤的東西。

如果你只打算讀兩頁，就讀這兩頁：

  1. 開始使用：安裝、初始化並交付你的第一個變更。
  2. 命令如何運作：你在哪裡輸入 /opsx:propose（提示：在 AI 聊天中，而不是在終端機中）。幾乎每個人都會在這裡卡住一次。

第二點比表面上看起來更重要。OpenSpec 有兩個部分：你在終端機中執行的命令列工具，以及你下達給 AI 助理的斜線命令。搞清楚兩者的區別，可以幫你避開最常見的困惑時刻。

首先要建立的最佳習慣：當你不確定要建置什麼時，先從 /opsx:explore 開始。 它是一個零風險的思考夥伴，會閱讀你的程式碼、權衡選項，並在任何產出物或程式碼存在之前，將模糊的想法打磨成具體的計畫。探索優先 指南說明了這樣做的理由。

選擇你的路徑 ​

我是新手。 從 開始使用 開始，然後瀏覽 核心概念一覽。當有不清楚的地方時，常見問答 和 詞彙表 就在旁邊。

我有問題但沒有計畫。 這是常見的情況，而它有一個專屬的解答：探索優先。在承諾任何事情之前，使用 /opsx:explore 與 AI 一起想清楚。

我有一個龐大的現有程式碼庫。 你不需要為全部內容建立文件。在現有專案中使用 OpenSpec 說明了如何在真實的棕地程式碼上開始，而不會過於龐雜。

我只想讓它能用。 安裝，執行 openspec init，然後閱讀 命令如何運作，讓你的第一個斜線命令落在正確的地方。或者，使用 AI 輔助安裝提示 將設定工作交給你的助理。

我透過範例學習。 範例與食譜 頁面從頭到尾走過真實的變更：一個小功能、一個錯誤修復、一個重構、一個探索。

AI 剛草擬了一份計畫——然後呢？ 閱讀它。審查變更 展示了兩分鐘快速檢查，能在錯誤方向還不算昂貴時就發現它；撰寫良好的規格 則涵蓋了一份值得批准的計畫是由什麼構成的。

我在團隊中工作。 團隊中的 OpenSpec 說明了變更如何對應到分支與拉取請求，以及團隊成員如何在程式碼之前審查計畫。

我是從舊的工作流程轉過來的。 遷移指南 解釋了哪些地方改變了以及為什麼，並保證你現有的工作是安全的。

我想讓它配合我團隊的流程。 自訂 涵蓋專案設定、自訂綱要與共用前後文。

有東西壞掉了。 疑難排解 收集了人們實際遇到的失敗狀況與對應的修復方法。

完整地圖 ​

從這裡開始 ​

文件它能帶給你什麼
開始使用安裝、初始化，並從頭到尾執行你的第一個變更
探索優先在提交之前，使用 /opsx:explore 想清楚你的想法
命令如何運作斜線命令在哪裡執行、什麼是「互動模式」、終端機 vs 聊天
核心概念一覽一頁掌握整體心智模型：規格、變更、差異、歸檔
安裝npm、pnpm、yarn、bun、Nix、一個將設定工作交給 AI 助理的提示，以及如何驗證安裝成功

日常使用 ​

文件它能帶給你什麼
工作流程常見模式，以及何時使用每個命令
範例與食譜真實變更的完整逐步解說，可直接複製貼上
撰寫良好的規格一份強健的需求與場景是什麼樣子，以及如何適當調整變更的規模
審查變更在撰寫任何程式碼之前，對草擬計畫進行的兩分鐘快速檢查
團隊中的 OpenSpec變更如何融入分支、拉取請求與審查流程
在現有專案中使用 OpenSpec在大型棕地程式碼庫上採用 OpenSpec
編輯與迭代變更更新產出物、回溯、調和手動編輯
命令每個 /opsx:* 斜線命令的參考
CLI每個 openspec 終端機命令的參考

深入了解 ​

文件它能帶給你什麼
概念對規格、變更、產出物、綱要與歸檔的詳細解釋
OPSX 工作流程為什麼工作流程是流動的而非鎖定在特定階段，以及架構的深入探討
詞彙表所有術語的定義集中於一處

讓它成為你的 ​

文件它能帶給你什麼
自訂專案設定、自訂綱要、共用前後文
多語言以英文以外的語言產出產出物
支援的工具OpenSpec 整合的 30 多種 AI 工具，以及檔案存放的位置
社群展示使用 OpenSpec 或為其建立的專案與資源

當你需要幫助時 ​

文件它能帶給你什麼
常見問答對人們最常問的問題的快速解答
疑難排解針對具體失敗的具體修復方法
遷移指南從舊版工作流程遷移到 OPSX

跨儲存庫協調（測試版） ​

文件它能帶給你什麼
儲存庫：使用指南當你的工作跨越多個儲存庫或團隊時，在它自己的儲存庫中進行規劃
代理合約機器可讀的命令列介面，驅動代理程式

三十秒版本 ​

text
1. 安裝            npm install -g @fission-ai/openspec@latest
2. 初始化          cd your-project && openspec init
3. 探索            (在你的 AI 聊天中)  /opsx:explore           ← 可選，但是個好習慣
4. 提案            (在你的 AI 聊天中)  /opsx:propose add-dark-mode
5. 建置            (在你的 AI 聊天中)  /opsx:apply
6. 歸檔            (在你的 AI 聊天中)  /opsx:archive

步驟 1 和 2 在你的終端機中進行。其餘步驟在你的 AI 助理的聊天中進行。這個分工是值得記住的一件事，命令如何運作 詳細解釋了為什麼。步驟 3 是可選的，但在不確定時以 /opsx:explore 開始是最值得養成的習慣。

其他獲取幫助的管道 ​

發現在這些文件中有些錯誤、過時或令人困惑的內容？那就是一個錯誤。開啟一個 Issue 或提交一個 PR。文件改進是你能做出的最有價值的貢獻之一。