Skip to content

Commit f17aca7

Browse files
author
薛華慶, james.hsueh
committed
feat: modify readme
1 parent c524108 commit f17aca7

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SDD Workflow - Specification-Driven Development
1+
# GSI-Protocol, Gherkin-Structure-Implementation
22

33
A Claude Code workflow plugin that implements a strict **Specification-Driven Development (SDD)** process for building new software features using AI Agents.
44

@@ -122,30 +122,35 @@ For more control, run each phase separately:
122122
```
123123

124124
**When to use Auto vs Manual:**
125+
125126
- **Auto Mode (`/sdd-auto`)**: Quick prototyping, simple features, one-shot development
126127
- **Manual Mode**: Production code, complex features, need to review each phase before proceeding
127128

128129
## Workflow Phases
129130

130131
### Phase 1: Specification (The Soul)
132+
131133
- **Role:** Product Manager
132134
- **Input:** User's natural language requirement
133135
- **Output:** Gherkin `.feature` file with BDD scenarios
134136
- **Goal:** Translate vague requirements into strict behavioral specifications
135137

136138
### Phase 2: Structure (The Skeleton)
139+
137140
- **Role:** System Architect
138141
- **Input:** Gherkin specification from Phase 1
139142
- **Output:** Data models and interface definitions (Python/TypeScript)
140143
- **Goal:** Design the technical skeleton required to support the Gherkin scenarios
141144

142145
### Phase 3: Implementation (The Flesh)
146+
143147
- **Role:** Senior Engineer
144148
- **Input:** Gherkin specification + Structure design
145149
- **Output:** Fully functional code implementing the interfaces
146150
- **Goal:** Implement the logic within the defined structure to satisfy the specs
147151

148152
### Phase 4: Verification (The Check)
153+
149154
- **Role:** QA Automation
150155
- **Input:** Gherkin specification + Implementation
151156
- **Output:** Test results and feedback
@@ -158,6 +163,7 @@ The workflow adapts to your chosen language while maintaining the same SDD princ
158163
### Example: VIP Discount System
159164

160165
**Phase 1 - Gherkin (Language-Independent)**
166+
161167
```gherkin
162168
Feature: VIP Discount
163169
Scenario: Apply discount
@@ -167,6 +173,7 @@ Feature: VIP Discount
167173
```
168174

169175
**Phase 2 & 3 - Python**
176+
170177
```python
171178
from dataclasses import dataclass
172179
from enum import Enum
@@ -189,10 +196,11 @@ def calculate_discount(amount: float, user_type: UserType) -> DiscountResult:
189196
```
190197

191198
**Phase 2 & 3 - TypeScript**
199+
192200
```typescript
193201
enum UserType {
194202
VIP = "VIP",
195-
NORMAL = "NORMAL"
203+
NORMAL = "NORMAL",
196204
}
197205

198206
interface DiscountResult {
@@ -211,6 +219,7 @@ function calculateDiscount(amount: number, userType: UserType): DiscountResult {
211219
```
212220

213221
**Phase 2 & 3 - Go**
222+
214223
```go
215224
type UserType string
216225

0 commit comments

Comments
 (0)