1111GSI-Protocol 是一個 AI 驅動的工作流程插件,實作了** 規格驅動開發(SDD)** 。它透過嚴格的四階段流程,將模糊的需求轉化為經過驗證、可用於生產環境的程式碼。
1212
1313** 支援平台:**
14+
1415- ✅ Claude Code
1516- ✅ Codex (OpenAI)
1617
@@ -38,7 +39,7 @@ GSI-Protocol 是一個 AI 驅動的工作流程插件,實作了**規格驅動
3839** 選項 1:使用 uvx(最推薦,無需安裝)**
3940
4041``` bash
41- uvx gsi-protocol-installer
42+ uvx --from gsi-protocol-installer gsi-install
4243```
4344
4445** 選項 2:使用 pipx**
@@ -60,13 +61,15 @@ python3 gsi_installer.py
6061```
6162
6263安裝程式會引導您:
64+
63651 . 選擇 AI 平台(Claude Code、Codex 或兩者)
64662 . 選擇安裝位置(全域或當前專案)
65673 . 自動完成安裝
6668
6769** 選項 4:手動全域安裝**
6870
6971** Claude Code:**
72+
7073``` bash
7174mkdir -p ~ /.claude/commands
7275cd ~ /.claude/commands
@@ -78,6 +81,7 @@ curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.c
7881```
7982
8083** Codex (OpenAI):**
84+
8185``` bash
8286mkdir -p ~ /.codex/prompts
8387cd ~ /.codex/prompts
@@ -115,16 +119,16 @@ cd your-project
115119
116120## 📚 文件
117121
118- | 文件 | 說明 |
119- | ----------| -------------|
120- | ** [ 快速入門指南] ( docs/QUICKSTART.md ) ** | 5 分鐘教學 |
121- | ** [ 安裝指南] ( docs/INSTALL.md ) ** | 詳細安裝說明 |
122- | ** [ Python 安裝器] ( docs/PYTHON_INSTALLER.md ) ** | uvx 安裝方式(推薦) |
123- | ** [ 平台支援] ( docs/PLATFORM_SUPPORT.md ) ** | Claude Code vs Codex 比較 |
124- | ** [ 指令參考] ( docs/COMMANDS.md ) ** | 完整指令文件 |
125- | ** [ 語言指南] ( docs/LANGUAGE_GUIDE.md ) ** | 多語言支援指南 |
126- | ** [ 工作流程定義] ( docs/expected_workflow.md ) ** | 詳細方法論 |
127- | ** [ 貢獻指南] ( CONTRIBUTING.md ) ** | 如何貢獻 |
122+ | 文件 | 說明 |
123+ | --------------------------------------------- | ------------------------- |
124+ | ** [ 快速入門指南] ( docs/QUICKSTART.md ) ** | 5 分鐘教學 |
125+ | ** [ 安裝指南] ( docs/INSTALL.md ) ** | 詳細安裝說明 |
126+ | ** [ Python 安裝器] ( docs/PYTHON_INSTALLER.md ) ** | uvx 安裝方式(推薦) |
127+ | ** [ 平台支援] ( docs/PLATFORM_SUPPORT.md ) ** | Claude Code vs Codex 比較 |
128+ | ** [ 指令參考] ( docs/COMMANDS.md ) ** | 完整指令文件 |
129+ | ** [ 語言指南] ( docs/LANGUAGE_GUIDE.md ) ** | 多語言支援指南 |
130+ | ** [ 工作流程定義] ( docs/expected_workflow.md ) ** | 詳細方法論 |
131+ | ** [ 貢獻指南] ( CONTRIBUTING.md ) ** | 如何貢獻 |
128132
129133---
130134
@@ -152,13 +156,13 @@ Phase 4:驗證(QA)
152156
153157### 指令
154158
155- | 指令 | 用途 | 何時使用 |
156- | ---------| ---------| -------------|
157- | ` /sdd-auto ` | 自動執行全部 4 個階段 | 快速原型、簡單功能 |
158- | ` /sdd-spec ` | 生成 Gherkin 規格 | 定義需求 |
159- | ` /sdd-arch ` | 設計資料模型與介面 | 審查結構 |
160- | ` /sdd-impl ` | 實作邏輯 | 撰寫程式碼 |
161- | ` /sdd-verify ` | 根據規格驗證 | 測試實作 |
159+ | 指令 | 用途 | 何時使用 |
160+ | ------------- | --------------------- | ------------------ |
161+ | ` /sdd-auto ` | 自動執行全部 4 個階段 | 快速原型、簡單功能 |
162+ | ` /sdd-spec ` | 生成 Gherkin 規格 | 定義需求 |
163+ | ` /sdd-arch ` | 設計資料模型與介面 | 審查結構 |
164+ | ` /sdd-impl ` | 實作邏輯 | 撰寫程式碼 |
165+ | ` /sdd-verify ` | 根據規格驗證 | 測試實作 |
162166
163167---
164168
@@ -173,6 +177,7 @@ Phase 4:驗證(QA)
173177### 輸出
174178
175179** 階段 1:規格** (` features/vip_discount.feature ` )
180+
176181``` gherkin
177182Feature: VIP Discount
178183 Scenario: Apply discount to VIP user
@@ -182,22 +187,27 @@ Feature: VIP Discount
182187```
183188
184189** Phase 2:架構** (` docs/features/vip_discount/architecture.md ` )
190+
185191``` markdown
186192# VIP 折扣系統 - 架構設計
187193
188194## 1. 專案上下文
195+
189196- 程式語言:Python
190197- 架構模式:Service Layer
191198
192199## 3. 資料模型
200+
193201- UserType(列舉):VIP, NORMAL
194202- DiscountResult(實體):final_price, discount
195203
196204## 4. 服務介面
205+
197206- calculate_discount(amount, user_type) → DiscountResult
198207```
199208
200209** Phase 3:實作** (依 architecture.md 指定位置)
210+
201211``` python
202212# src/services/discount_service.py
203213def calculate_discount (amount : float , user_type : UserType) -> DiscountResult:
@@ -208,8 +218,10 @@ def calculate_discount(amount: float, user_type: UserType) -> DiscountResult:
208218```
209219
210220** Phase 4:驗證結論** (` docs/features/vip_discount/conclusion.md ` )
221+
211222``` markdown
212223## 3. 摘要
224+
213225- 架構:2/2 通過
214226- 情境:2/2 通過
215227- **狀態:** ✅ 完成
@@ -238,6 +250,7 @@ class IUserService(ABC):
238250 def authenticate (self , credentials : Credentials) -> User:
239251 pass
240252```
253+
241254</details >
242255
243256<details >
@@ -253,6 +266,7 @@ interface IUserService {
253266 authenticate(credentials : Credentials ): User ;
254267}
255268```
269+
256270</details >
257271
258272<details >
@@ -268,6 +282,7 @@ type UserService interface {
268282 Authenticate (credentials Credentials ) (User, error )
269283}
270284```
285+
271286</details >
272287
273288更多語言請參閱 [ 語言指南] ( docs/LANGUAGE_GUIDE.md ) ,包含 Rust、Java、C# 等。
@@ -277,25 +292,29 @@ type UserService interface {
277292## 🎓 使用案例
278293
279294### 1. API 開發
295+
280296``` bash
281297/sdd-spec Design a RESTful API for blog posts (CRUD operations)
282298/sdd-arch features/blog_api.feature
283299# 獲得清晰的 API 契約和資料結構
284300```
285301
286302### 2. 功能實作
303+
287304``` bash
288305/sdd-auto Implement user authentication with JWT tokens in TypeScript
289306# 幾分鐘內獲得可運行、已測試的程式碼
290307```
291308
292309### 3. 遺留程式碼重構
310+
293311``` bash
294312/sdd-spec The payment module should support credit card, PayPal, and crypto
295313# 在重構前定義清晰的需求
296314```
297315
298316### 4. 團隊協作
317+
299318``` bash
300319# PM:定義需求
301320/sdd-spec User registration with email verification
@@ -375,16 +394,19 @@ GSI-Protocol/
375394## 🚀 優勢
376395
377396### 對開發者
397+
378398- ✅ ** 更快開發** :自動生成樣板程式碼和結構
379399- ✅ ** 更高品質** :系統化方法減少 bug
380400- ✅ ** 清晰需求** :Gherkin 規格消除歧義
381401
382402### 對團隊
403+
383404- ✅ ** 共同語言** :所有人都能理解的 BDD 規格
384405- ✅ ** 更好溝通** :PM、架構師、工程師、QA 各有明確階段
385406- ✅ ** 可維護程式碼** :每一行都可追溯到需求
386407
387408### 對專案
409+
388410- ✅ ** 語言彈性** :切換語言不需改變方法論
389411- ✅ ** 框架無關** :使用任何函式庫或框架
390412- ✅ ** 可擴展** :適用於簡單功能到複雜系統
@@ -418,6 +440,7 @@ GSI-Protocol/
418440我們歡迎貢獻!請參閱 [ CONTRIBUTING.md] ( CONTRIBUTING.md ) 了解指南。
419441
420442### 貢獻方式
443+
421444- 🐛 回報 bug
422445- 💡 建議功能
423446- 📝 改善文件
@@ -435,6 +458,7 @@ MIT 授權 - 詳見 [LICENSE](LICENSE) 檔案。
435458## 🙏 致謝
436459
437460使用以下工具建置:
461+
438462- [ Claude Code] ( https://claude.ai/claude-code ) - AI 驅動開發
439463- [ Codex (OpenAI)] ( https://openai.com/blog/openai-codex ) - AI 程式碼生成
440464- [ Gherkin] ( https://cucumber.io/docs/gherkin/ ) - BDD 規格語言
0 commit comments