Skip to content

Commit 86a9bc4

Browse files
author
薛華慶, james.hsueh
committed
docs: update documents
1 parent 1f89b4c commit 86a9bc4

File tree

6 files changed

+203
-40
lines changed

6 files changed

+203
-40
lines changed

docs/COMMANDS.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
本文件說明所有可用的 SDD 工作流程指令以及何時使用它們。
44

5+
## 平台差異
6+
7+
不同 AI 平台使用不同的指令格式:
8+
9+
| 平台 | 格式 | 範例 |
10+
|------|------|------|
11+
| Claude Code | `/sdd-*` | `/sdd-auto Create a user login` |
12+
| Codex (OpenAI) | `/sdd-*` | `/sdd-auto Create a user login` |
13+
| GitHub Copilot | `@workspace /sdd-*` | `@workspace /sdd-auto Create a user login` |
14+
15+
> 本文件使用 Claude/Codex 格式 (`/sdd-*`)。如使用 GitHub Copilot,請在指令前加上 `@workspace`
16+
517
## 指令概覽
618

719
### 核心工作流程(必需)
@@ -34,6 +46,8 @@
3446
```
3547

3648
**範例:**
49+
50+
**Claude Code / Codex:**
3751
```bash
3852
/sdd-auto Implement a VIP discount system in Python where VIP users get 20% off purchases over $100
3953

@@ -42,6 +56,15 @@
4256
/sdd-auto Build a task manager in Go with create, update, delete, and list operations
4357
```
4458

59+
**GitHub Copilot:**
60+
```bash
61+
@workspace /sdd-auto Implement a VIP discount system in Python where VIP users get 20% off purchases over $100
62+
63+
@workspace /sdd-auto Create a referral bonus system in TypeScript. When an invited user makes a purchase over $50, the inviter gets 100 points
64+
65+
@workspace /sdd-auto Build a task manager in Go with create, update, delete, and list operations
66+
```
67+
4568
**它會做什麼:**
4669
1. ✅ 生成 Gherkin 規格(Phase 1)
4770
2. ✅ 設計架構文件(Phase 2)

docs/INDEX.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ GSI-Protocol(Gherkin-Structure-Implementation)工作流程的完整文件。
1313
| **[快速入門指南](QUICKSTART.md)** | 5 分鐘快速開始教學 | 5 分鐘 |
1414
| **[安裝指南](INSTALL.md)** | 所有情境的詳細安裝說明 | 10 分鐘 |
1515
| **[Python 安裝器](PYTHON_INSTALLER.md)** | 使用 uvx 的現代化安裝方式 | 3 分鐘 |
16-
| **[平台支援](PLATFORM_SUPPORT.md)** | Claude Code vs Codex 比較 | 5 分鐘 |
16+
| **[平台支援](PLATFORM_SUPPORT.md)** | Claude CodeCodex、GitHub Copilot 比較 | 5 分鐘 |
1717

1818
### 參考
1919

@@ -192,7 +192,7 @@ GSI-Protocol(Gherkin-Structure-Implementation)工作流程的完整文件。
192192
**"如何安裝?"**
193193
[安裝指南](INSTALL.md)
194194

195-
**"應該選 Claude Code 還是 Codex?"**
195+
**"應該選 Claude Code、Codex 還是 GitHub Copilot?"**
196196
[平台支援](PLATFORM_SUPPORT.md)
197197

198198
**"有哪些可用指令?"**

docs/INSTALL.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
**支援平台:**
66
- ✅ Claude Code
77
- ✅ Codex (OpenAI)
8+
- ✅ GitHub Copilot
89

910
---
1011

@@ -25,7 +26,7 @@ curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/in
2526
```
2627

2728
安裝腳本會引導您完成:
28-
1. 選擇 AI 平台(Claude Code、Codex 或兩者
29+
1. 選擇 AI 平台(Claude Code、Codex、GitHub Copilot 或多個
2930
2. 選擇安裝位置(全域或當前專案)
3031
3. 自動完成設定
3132

@@ -128,6 +129,20 @@ wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/
128129
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-verify.md
129130
```
130131

132+
**GitHub Copilot:**
133+
```bash
134+
mkdir -p ~/.copilot/commands
135+
cd ~/.copilot/commands
136+
137+
# 下載所有指令檔案
138+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-auto.md
139+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-spec.md
140+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-arch.md
141+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-integration-test.md
142+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-impl.md
143+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-verify.md
144+
```
145+
131146
### 手動專案內安裝
132147

133148
**在當前專案中:**
@@ -150,8 +165,18 @@ wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/
150165
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-impl.md
151166
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-verify.md
152167

168+
# GitHub Copilot
169+
mkdir -p .copilot/commands
170+
cd .copilot/commands
171+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-auto.md
172+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-spec.md
173+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-arch.md
174+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-integration-test.md
175+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-impl.md
176+
wget https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-verify.md
177+
153178
# 提交到 Git(可選)
154-
git add .claude/commands/ .codex/prompts/
179+
git add .claude/commands/ .codex/prompts/ .copilot/commands/
155180
git commit -m "Add GSI-Protocol workflow commands"
156181
```
157182

@@ -171,11 +196,18 @@ ls ~/.claude/commands/ | grep sdd
171196
ls ~/.codex/prompts/ | grep sdd
172197
```
173198

199+
**GitHub Copilot (全域安裝):**
200+
```bash
201+
ls ~/.copilot/commands/ | grep sdd
202+
```
203+
174204
**專案內安裝:**
175205
```bash
176206
ls .claude/commands/ | grep sdd
177207
#
178208
ls .codex/prompts/ | grep sdd
209+
#
210+
ls .copilot/commands/ | grep sdd
179211
```
180212

181213
應該看到:
@@ -201,12 +233,19 @@ sdd-verify.md
201233

202234
### 快速模式(推薦)
203235

236+
**Claude Code / Codex:**
204237
```bash
205238
/sdd-auto Create a shopping cart in TypeScript with add, remove, and checkout functions
206239
```
207240

241+
**GitHub Copilot:**
242+
```bash
243+
@workspace /sdd-auto Create a shopping cart in TypeScript with add, remove, and checkout functions
244+
```
245+
208246
### 手動模式(逐步執行)
209247

248+
**Claude Code / Codex:**
210249
```bash
211250
# 步驟 1:定義規格
212251
/sdd-spec Create a shopping cart with add, remove, checkout
@@ -221,6 +260,21 @@ sdd-verify.md
221260
/sdd-verify features/shopping_cart.feature
222261
```
223262

263+
**GitHub Copilot:**
264+
```bash
265+
# 步驟 1:定義規格
266+
@workspace /sdd-spec Create a shopping cart with add, remove, checkout
267+
268+
# 步驟 2:設計架構(審查 features/shopping_cart.feature 後)
269+
@workspace /sdd-arch features/shopping_cart.feature
270+
271+
# 步驟 3:實作程式碼(審查 docs/ 後)
272+
@workspace /sdd-impl features/shopping_cart.feature
273+
274+
# 步驟 4:驗證實作(審查 src/ 後)
275+
@workspace /sdd-verify features/shopping_cart.feature
276+
```
277+
224278
---
225279

226280
## 專案結構
@@ -249,6 +303,17 @@ sdd-verify.md
249303
└── sdd-verify.md
250304
```
251305

306+
**GitHub Copilot:**
307+
```
308+
~/.copilot/commands/
309+
├── sdd-auto.md
310+
├── sdd-spec.md
311+
├── sdd-arch.md
312+
├── sdd-integration-test.md
313+
├── sdd-impl.md
314+
└── sdd-verify.md
315+
```
316+
252317
**您的專案保持乾淨,只有生成的程式碼:**
253318
```
254319
your-project/

docs/PLATFORM_SUPPORT.md

Lines changed: 71 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,42 @@ GSI-Protocol 現在支援多個 AI 平台,讓您可以使用您偏好的 AI
99
### Claude Code
1010
- **開發商:** Anthropic
1111
- **特色:** 強大的程式碼理解與生成能力
12+
- **指令格式:** `/sdd-*`
1213
- **指令目錄:** `~/.claude/commands/` (全域) 或 `.claude/commands/` (專案)
1314
- **狀態:** ✅ 完整支援
1415

1516
### Codex (OpenAI)
1617
- **開發商:** OpenAI
1718
- **特色:** 基於 GPT 技術的程式碼生成
19+
- **指令格式:** `/sdd-*`
1820
- **指令目錄:** `~/.codex/prompts/` (全域) 或 `.codex/prompts/` (專案)
1921
- **狀態:** ✅ 完整支援
2022

23+
### GitHub Copilot
24+
- **開發商:** GitHub (Microsoft)
25+
- **特色:** 整合 VS Code 與 CLI 的 AI 程式輔助
26+
- **指令格式:** `@workspace /sdd-*`
27+
- **指令目錄:** `~/.copilot/commands/` (全域) 或 `.copilot/commands/` (專案)
28+
- **狀態:** ✅ 完整支援
29+
2130
---
2231

2332
## 📊 平台比較
2433

25-
| 特性 | Claude Code | Codex (OpenAI) |
26-
|------|------------|----------------|
27-
| SDD 工作流程 |||
28-
| Gherkin 規格生成 |||
29-
| 架構設計 |||
30-
| 程式碼實作 |||
31-
| 驗證測試 |||
32-
| 多語言支援 |||
33-
| 框架無關 |||
34-
| 專案感知 |||
35-
36-
**結論:** 兩個平台在 GSI-Protocol 工作流程中功能完全相同,選擇您偏好的平台即可。
34+
| 特性 | Claude Code | Codex (OpenAI) | GitHub Copilot |
35+
|------|------------|----------------|----------------|
36+
| SDD 工作流程 ||||
37+
| Gherkin 規格生成 ||||
38+
| 架構設計 ||||
39+
| 程式碼實作 ||||
40+
| 驗證測試 ||||
41+
| 多語言支援 ||||
42+
| 框架無關 ||||
43+
| 專案感知 ||||
44+
| 指令格式 | `/sdd-*` | `/sdd-*` | `@workspace /sdd-*` |
45+
| VS Code 整合 | - | - ||
46+
47+
**結論:** 三個平台在 GSI-Protocol 工作流程中功能完全相同,選擇您偏好的平台即可。
3748

3849
---
3950

@@ -44,14 +55,15 @@ GSI-Protocol 現在支援多個 AI 平台,讓您可以使用您偏好的 AI
4455
**只用一個平台:**
4556
```bash
4657
# 安裝時選擇您要使用的平台
47-
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/install.sh | bash
48-
# 選擇選項 1 (Claude Code) 或 2 (Codex)
58+
uvx gsi-protocol-installer
59+
# 選擇選項 1 (Claude Code)、2 (Codex) 或 3 (GitHub Copilot)
4960
```
5061

51-
**同時使用兩個平台**
62+
**同時使用多個平台**
5263
```bash
53-
# 安裝時選擇選項 3 (Both)
54-
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/install.sh | bash
64+
# 安裝時可以選擇多個平台(用逗號分隔)
65+
uvx gsi-protocol-installer
66+
# 輸入 1,2,3 或 all 來安裝所有平台
5567
# 可以在不同專案中使用不同的 AI 工具
5668
```
5769

@@ -69,11 +81,16 @@ curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/in
6981
- 標準化程式碼生成
7082
- OpenAI 生態系整合
7183

84+
### 何時使用 GitHub Copilot
85+
- VS Code 開發環境
86+
- CLI 工作流程整合
87+
- 需要 GitHub 生態系整合
88+
7289
### 混合使用
7390
您可以在同一專案中混合使用:
7491
- Phase 1-2 用 Claude Code(規格與架構)
75-
- Phase 3-4 用 Codex(實作與驗證)
76-
- 或反之
92+
- Phase 3-4 用 Copilot(實作與驗證)
93+
- 或任意組合
7794

7895
---
7996

@@ -88,10 +105,25 @@ cd ~/.codex/prompts
88105
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-auto.md -o sdd-auto.md
89106
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-spec.md -o sdd-spec.md
90107
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-arch.md -o sdd-arch.md
108+
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-integration-test.md -o sdd-integration-test.md
91109
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-impl.md -o sdd-impl.md
92110
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.codex/prompts/sdd-verify.md -o sdd-verify.md
93111
```
94112

113+
### 想加入 GitHub Copilot
114+
115+
```bash
116+
# 全域安裝
117+
mkdir -p ~/.copilot/commands
118+
cd ~/.copilot/commands
119+
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-auto.md -o sdd-auto.md
120+
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-spec.md -o sdd-spec.md
121+
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-arch.md -o sdd-arch.md
122+
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-integration-test.md -o sdd-integration-test.md
123+
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-impl.md -o sdd-impl.md
124+
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.copilot/commands/sdd-verify.md -o sdd-verify.md
125+
```
126+
95127
### 已安裝 Codex,想加入 Claude Code
96128

97129
```bash
@@ -101,6 +133,7 @@ cd ~/.claude/commands
101133
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.claude/commands/sdd-auto.md -o sdd-auto.md
102134
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.claude/commands/sdd-spec.md -o sdd-spec.md
103135
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.claude/commands/sdd-arch.md -o sdd-arch.md
136+
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.claude/commands/sdd-integration-test.md -o sdd-integration-test.md
104137
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.claude/commands/sdd-impl.md -o sdd-impl.md
105138
curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.claude/commands/sdd-verify.md -o sdd-verify.md
106139
```
@@ -116,13 +149,23 @@ curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/.c
116149
├── sdd-auto.md
117150
├── sdd-spec.md
118151
├── sdd-arch.md
152+
├── sdd-integration-test.md
119153
├── sdd-impl.md
120154
└── sdd-verify.md
121155
122156
~/.codex/prompts/ # Codex 全域 prompts
123157
├── sdd-auto.md
124158
├── sdd-spec.md
125159
├── sdd-arch.md
160+
├── sdd-integration-test.md
161+
├── sdd-impl.md
162+
└── sdd-verify.md
163+
164+
~/.copilot/commands/ # GitHub Copilot 全域指令
165+
├── sdd-auto.md
166+
├── sdd-spec.md
167+
├── sdd-arch.md
168+
├── sdd-integration-test.md
126169
├── sdd-impl.md
127170
└── sdd-verify.md
128171
@@ -139,6 +182,7 @@ your-project/
139182
your-project/
140183
├── .claude/commands/ # Claude Code 專案指令(可選)
141184
├── .codex/prompts/ # Codex 專案 prompts(可選)
185+
├── .copilot/commands/ # GitHub Copilot 專案指令(可選)
142186
├── features/
143187
├── docs/features/
144188
└── src/
@@ -150,22 +194,24 @@ your-project/
150194

151195
### Q: 指令內容有差異嗎?
152196

153-
**A:** 有些許差異。兩個平台的**工作流程和輸出格式完全相同**,但指令格式略有不同:
197+
**A:** 有些許差異。三個平台的**工作流程和輸出格式完全相同**,但指令格式略有不同:
154198

155-
- **Claude Code**: 使用 `{{prompt}}` 變數來接收參數
156-
- **Codex**: 使用 `argument-hint` 欄位和 `$1` 參數
199+
- **Claude Code**: 使用 `{{prompt}}` 變數,指令前綴為 `/sdd-*`
200+
- **Codex**: 使用 `{{prompt}}` 變數,指令前綴為 `/sdd-*`
201+
- **GitHub Copilot**: 使用 `{{ARG}}` 變數,指令前綴為 `@workspace /sdd-*`
157202

158203
這些差異是為了符合各平台的技術規範,但不影響實際使用體驗。
159204

160-
### Q: 可以同時安裝兩個平台嗎
205+
### Q: 可以同時安裝多個平台嗎
161206

162-
**A:** 可以!您可以同時安裝,然後根據需求選擇使用哪個 AI 工具。
207+
**A:** 可以!您可以同時安裝所有三個平台,然後根據需求選擇使用哪個 AI 工具。
163208

164209
### Q: 哪個平台比較好?
165210

166-
**A:** 兩者都很優秀,取決於您的偏好和使用情境:
211+
**A:** 三者都很優秀,取決於您的偏好和使用情境:
167212
- 如果您已經在使用 Claude Code → 繼續使用
168213
- 如果您偏好 OpenAI 生態系 → 使用 Codex
214+
- 如果您喜歡 VS Code 與 CLI 整合 → 使用 GitHub Copilot
169215
- 不確定 → 同時安裝,實際使用後再決定
170216

171217
### Q: 生成的檔案格式相容嗎?

0 commit comments

Comments
 (0)