Skip to content

Commit d130ad5

Browse files
author
薛華慶, james.hsueh
committed
docs: add chinese documents
1 parent 8c38e50 commit d130ad5

File tree

6 files changed

+1062
-0
lines changed

6 files changed

+1062
-0
lines changed

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
77
[![Version](https://img.shields.io/badge/version-1.0.14-green)](https://github.com/CodeMachine0121/GSI-Protocol)
88

9+
**Language**: English | [繁體中文](./README.zh-TW.md)
10+
911
GSI-Protocol is an automated Specification-Driven Development (SDD) workflow system that transforms user requirements into production-ready code through a structured 4-phase process: Specification → Architecture → Implementation → Verification.
1012

1113
## Features

‎README.zh-TW.md‎

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
# GSI-Protocol
2+
3+
> 基於規格驅動開發（SDD）的 AI 輔助開發工作流程
4+
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
7+
[![Version](https://img.shields.io/badge/version-1.0.14-green)](https://github.com/CodeMachine0121/GSI-Protocol)
8+
9+
**語言**: [English](./README.md) | **繁體中文**
10+
11+
GSI-Protocol 是一個自動化的規格驅動開發（SDD）工作流程系統，透過結構化的 4 階段流程將使用者需求轉換為可投產的程式碼：規格 → 架構 → 實作 → 驗證。
12+
13+
## 特色
14+
15+
- **多平台支援**：支援 Claude Code、Codex (OpenAI) 和 GitHub Copilot
16+
- **語言無關**：架構設計獨立於程式語言
17+
- **自動化工作流程**：單一命令執行完整開發週期
18+
- **BDD 整合**：內建支援 Gherkin 規格與整合測試
19+
- **專案感知**：自動偵測並適應您專案的技術棧
20+
- **角色導向階段**：PM → 架構師 → 工程師 → QA 工作流程
21+
22+
## 📚 深入了解
23+
24+
**初次使用 GSI-Protocol？** 從這裡開始：
25+
26+
- **[GSI 理論與方法論](./docs/gsi-theory.zh-TW.md)** - 深入理解 **G**herkin-**S**tructure-**I**mplement 方法論
27+
- **[快速開始指南](./docs/quickstart.zh-TW.md)** - 逐步教學建立您的第一個功能
28+
29+
## 快速開始
30+
31+
### 安裝
32+
33+
使用 `uvx` 安裝（推薦）：
34+
35+
```bash
36+
uvx --from gsi-protocol-installer gsi-install
37+
```
38+
39+
或使用 `pipx`：
40+
41+
```bash
42+
pipx run gsi-protocol-installer
43+
```
44+
45+
安裝程式將引導您完成：
46+
1. 選擇 AI 平台（Claude Code、Codex、GitHub Copilot）
47+
2. 選擇安裝類型（全域或專案特定）
48+
3. 安裝工作流程指令
49+
50+
### 基本使用
51+
52+
#### 自動模式（推薦）
53+
54+
自動執行完整的 4 階段工作流程：
55+
56+
```bash
57+
# Claude Code / Codex
58+
/sdd-auto <您的需求>
59+
60+
# GitHub Copilot
61+
@workspace /sdd-auto <您的需求>
62+
```
63+
64+
範例：
65+
```bash
66+
/sdd-auto 新增使用者認證功能，包含電子郵件和密碼登入
67+
```
68+
69+
#### 手動模式
70+
71+
更精細地控制每個階段：
72+
73+
1. **生成規格**（PM 階段）
74+
```bash
75+
/sdd-spec <需求>
76+
```
77+
78+
2. **設計架構**（架構師階段）
79+
```bash
80+
/sdd-arch <feature_file_path>
81+
```
82+
83+
3. **實作程式碼**（工程師階段）
84+
```bash
85+
/sdd-impl <feature_file_path>
86+
```
87+
88+
4. **驗證實作**（QA 階段）
89+
```bash
90+
/sdd-verify <feature_file_path>
91+
```
92+
93+
5. **生成整合測試**（選用）
94+
```bash
95+
/sdd-integration-test <feature_file_path>
96+
```
97+
98+
## 工作流程概覽
99+
100+
GSI-Protocol 遵循結構化的 4 階段流程：
101+
102+
```
103+
使用者需求
104+
↓
105+
[階段 1: 規格（PM）]
106+
→ features/{feature}.feature (Gherkin)
107+
↓
108+
[階段 2: 架構（架構師）]
109+
→ docs/features/{feature}/architecture.md
110+
↓
111+
[階段 3: 實作（工程師）]
112+
→ 原始碼檔案
113+
↓
114+
[階段 4: 驗證（QA）]
115+
→ docs/features/{feature}/conclusion.md
116+
```
117+
118+
> **了解方法論**：閱讀我們的 [GSI 理論與方法論指南](./docs/gsi-theory.zh-TW.md) 來理解 **Gherkin**（規格）、**Structure**（架構）和 **Implement**（實作）如何協同運作。
119+
120+
## 可用指令
121+
122+
| 指令 | 說明 | 階段 |
123+
|---------|-------------|-------|
124+
| `/sdd-auto` | 自動執行完整工作流程 | 全部 |
125+
| `/sdd-spec` | 從需求生成 Gherkin 規格 | 1 |
126+
| `/sdd-arch` | 從規格設計架構 | 2 |
127+
| `/sdd-impl` | 基於架構實作程式碼 | 3 |
128+
| `/sdd-verify` | 驗證實作是否符合規格 | 4 |
129+
| `/sdd-integration-test` | 生成 BDD 整合測試 | 選用 |
130+
131+
## 輸出結構
132+
133+
執行工作流程後，您的專案將包含：
134+
135+
```
136+
project_root/
137+
├── features/
138+
│ └── {feature_name}.feature # Gherkin 規格
139+
├── docs/
140+
│ └── features/
141+
│ └── {feature_name}/
142+
│ ├── architecture.md # 架構設計
143+
│ └── conclusion.md # 驗證報告
144+
└── {your_project_structure}/
145+
├── {model_files} # 生成的模型
146+
└── {service_files} # 生成的服務
147+
```
148+
149+
## 平台特定用法
150+
151+
### Claude Code
152+
153+
指令可直接在 Claude Code CLI 中使用：
154+
```bash
155+
/sdd-auto <需求>
156+
/sdd-spec <需求>
157+
```
158+
159+
### Codex (OpenAI)
160+
161+
使用帶有參數佔位符的提示：
162+
```bash
163+
/sdd-auto <需求>
164+
```
165+
166+
### GitHub Copilot
167+
168+
在指令前加上 `@workspace`：
169+
```bash
170+
@workspace /sdd-auto <需求>
171+
@workspace /sdd-spec <需求>
172+
```
173+
174+
## 系統需求
175+
176+
- Python 3.10 或更高版本
177+
- Git
178+
- 以下其中一個支援的 AI 平台：
179+
- Claude Code CLI
180+
- Codex (OpenAI)
181+
- GitHub Copilot
182+
183+
## 文件
184+
185+
詳細文件請參閱 [docs](./docs) 目錄：
186+
- [GSI 理論與方法論](./docs/gsi-theory.zh-TW.md) - 理解 G-S-I 三大支柱
187+
- [快速開始指南](./docs/quickstart.zh-TW.md) - 數分鐘內開始使用
188+
189+
## 貢獻
190+
191+
歡迎貢獻！請隨時提交問題和拉取請求。
192+
193+
## 授權
194+
195+
本專案採用 MIT 授權 - 詳見 [LICENSE](LICENSE) 檔案。
196+
197+
## 作者
198+
199+
**James Hsueh** - [[email protected]](mailto:[email protected])
200+
201+
## 連結
202+
203+
- [首頁](https://github.com/CodeMachine0121/GSI-Protocol)
204+
- [問題追蹤](https://github.com/CodeMachine0121/GSI-Protocol/issues)
205+
- [程式碼庫](https://github.com/CodeMachine0121/GSI-Protocol)
206+
207+
## 更新日誌
208+
209+
版本歷史和更新請參閱專案儲存庫。

‎docs/QUICKSTART.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# GSI-Protocol Quick Start Guide
22

3+
**Language**: English | [繁體中文](./quickstart.zh-TW.md)
4+
35
This guide will help you get started with GSI-Protocol in minutes.
46

57
## Prerequisites

‎docs/gsi-theory.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# GSI-Protocol Theory
22

3+
**Language**: English | [繁體中文](./gsi-theory.zh-TW.md)
4+
35
## What is GSI?
46

57
GSI-Protocol is a systematic approach to software development that emphasizes **specification-driven, architecture-first development**. The acronym GSI represents the three core pillars of this methodology:

0 commit comments

Comments
 (0)