sdd-tool 0.6.1 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SDD Tool
2
2
 
3
- **Spec-Driven Development CLI** - 명세 기반 개발을 위한 통합 CLI 도구
3
+ **Spec-Driven Development CLI** - AI와 함께하는 명세 기반 개발 도구
4
4
 
5
5
  [![npm version](https://img.shields.io/npm/v/sdd-tool)](https://www.npmjs.com/package/sdd-tool)
6
6
  [![Node.js](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org/)
@@ -9,668 +9,419 @@
9
9
 
10
10
  ## 개요
11
11
 
12
- SDD Tool은 명세(Specification)를 중심으로 소프트웨어를 개발하는 방법론을 지원하는 CLI 도구입니다. 코드보다 명세를 우선시하여, 명세가 구현의 진실 공급원(Source of Truth)이 되도록 합니다.
12
+ SDD Tool은 **Claude Code**와 함께 사용하도록 설계된 명세 기반 개발(Spec-Driven Development) CLI입니다. 슬래시 커맨드를 통해 AI와 대화하며 명세를 작성하고, 코드를 구현합니다.
13
13
 
14
14
  ### 핵심 개념
15
15
 
16
16
  - **명세 우선**: 코드 작성 전 명세 작성
17
- - **RFC 2119 키워드**: SHALL, MUST, SHOULD, MAY, SHALL NOT
17
+ - **AI 협업**: Claude Code 슬래시 커맨드로 워크플로우 자동화
18
+ - **RFC 2119 키워드**: SHALL, MUST, SHOULD, MAY로 요구사항 명확화
18
19
  - **GIVEN-WHEN-THEN**: 시나리오 기반 요구사항 정의
19
- - **델타 시스템**: ADDED, MODIFIED, REMOVED로 변경 추적
20
20
  - **헌법(Constitution)**: 프로젝트 핵심 원칙 정의
21
21
 
22
+ ---
23
+
22
24
  ## 설치
23
25
 
24
26
  ```bash
25
- # npm
26
27
  npm install -g sdd-tool
27
-
28
- # pnpm
29
- pnpm add -g sdd-tool
30
-
31
- # 또는 로컬에서 실행
32
- git clone https://github.com/JakeB-5/sdd-tool.git
33
- cd sdd-tool
34
- pnpm install
35
- pnpm run build
36
28
  ```
37
29
 
38
- ## 빠른 시작
39
-
40
- ```bash
41
- # 1. 프로젝트 초기화
42
- sdd init
43
-
44
- # 2. 워크플로우 시작 (통합 진입점)
45
- sdd start
46
-
47
- # 3. 새 기능 생성
48
- sdd new user-auth --title "사용자 인증" --all
49
-
50
- # 4. 스펙 검증
51
- sdd validate
52
-
53
- # 5. 프로젝트 상태 확인
54
- sdd status
55
- ```
30
+ ---
56
31
 
57
- ## 명령어
32
+ ## Claude Code와 함께 시작하기
58
33
 
59
- ### `sdd init`
34
+ SDD Tool은 Claude Code의 슬래시 커맨드와 통합되어, AI와 대화하며 명세 기반 개발을 진행합니다.
60
35
 
61
- SDD 프로젝트를 초기화합니다.
36
+ ### Step 1: 프로젝트 초기화
62
37
 
63
38
  ```bash
64
- sdd init # 기본 초기화
65
- sdd init --force # 기존 파일 덮어쓰기
39
+ sdd init
66
40
  ```
67
41
 
68
- 생성되는 구조:
69
- ```
70
- .sdd/
71
- ├── constitution.md # 프로젝트 헌법 (핵심 원칙)
72
- ├── AGENTS.md # AI 워크플로우 가이드
73
- ├── specs/ # 기능 명세
74
- ├── changes/ # 변경 제안
75
- ├── archive/ # 완료된 변경
76
- └── templates/ # 템플릿 파일
77
- .claude/
78
- └── commands/ # Claude 슬래시 커맨드
79
- ```
42
+ 명령은 다음을 생성합니다:
43
+ - `.sdd/` - 명세 디렉토리 (constitution.md, specs/, changes/)
44
+ - `.claude/commands/` - **26개의 슬래시 커맨드** 자동 생성
80
45
 
81
- ### `sdd start`
46
+ ### Step 2: Claude Code 실행
82
47
 
83
- 통합 워크플로우 진입점입니다.
48
+ 프로젝트 디렉토리에서 Claude Code를 실행합니다:
84
49
 
85
50
  ```bash
86
- sdd start # 상태 확인 및 워크플로우 메뉴
87
- sdd start --status # 상태만 표시
88
- sdd start --workflow new-feature # 특정 워크플로우 시작
89
- sdd start --workflow change-spec # 변경 워크플로우
51
+ claude
90
52
  ```
91
53
 
92
- ### `sdd new`
93
-
94
- 새로운 기능을 생성합니다.
54
+ ### Step 3: 워크플로우 시작
95
55
 
96
- ```bash
97
- # 기본 사용
98
- sdd new <feature-name>
99
-
100
- # 옵션
101
- sdd new auth --title "인증 기능" --description "사용자 인증"
102
- sdd new auth --all # spec, plan, tasks, checklist 모두 생성
103
- sdd new auth --numbered # 자동 번호 부여 (feature/001-auth)
104
- sdd new auth --no-branch # Git 브랜치 생성 안 함
56
+ Claude Code에서 슬래시 커맨드를 입력합니다:
105
57
 
106
- # 서브커맨드
107
- sdd new plan <feature> # 구현 계획 생성
108
- sdd new tasks <feature> # 작업 분해 생성
109
- sdd new checklist # 워크플로우 체크리스트 생성
110
- sdd new counter # 기능 번호 카운터 관리
111
- sdd new counter --peek # 다음 번호 확인
112
- sdd new counter --history # 생성 이력
113
- sdd new counter --set <n> # 번호 설정
114
58
  ```
115
-
116
- ### `sdd validate`
117
-
118
- 스펙 파일의 형식을 검증합니다.
119
-
120
- ```bash
121
- sdd validate # 전체 검증
122
- sdd validate path/to/spec.md # 특정 파일 검증
123
- sdd validate --strict # 엄격 모드 (경고도 에러)
124
- sdd validate --check-links # 참조 링크 유효성 검사
125
- sdd validate --constitution # Constitution 위반 검사 (기본값)
126
- sdd validate --no-constitution # Constitution 검사 스킵
127
- sdd validate --quiet # 조용한 모드
59
+ /sdd.start
128
60
  ```
129
61
 
130
- 검증 항목:
131
- - YAML frontmatter 존재 형식
132
- - RFC 2119 키워드 사용
133
- - GIVEN-WHEN-THEN 시나리오 포함
134
- - 참조 링크 유효성 (--check-links)
135
- - Constitution 원칙 위반 (--constitution)
62
+ AI가 프로젝트 상태를 분석하고, 다음 작업을 안내합니다:
63
+ - 신규 프로젝트: Constitution 작성 권장
64
+ - 기존 프로젝트: 워크플로우 선택 메뉴 제공
136
65
 
137
- ### `sdd constitution`
66
+ ### Step 4: Constitution(헌법) 작성
138
67
 
139
- 프로젝트 Constitution(헌법)을 관리합니다.
68
+ 프로젝트의 핵심 원칙을 정의합니다:
140
69
 
141
- ```bash
142
- sdd constitution # Constitution 표시
143
- sdd constitution show # Constitution 내용 표시
144
- sdd constitution version # 버전만 표시
145
- sdd constitution validate # 형식 검증
146
- sdd constitution history # 변경 이력 조회
147
- sdd constitution bump # 버전 업데이트
148
- sdd constitution bump --major # 주요 변경 (원칙 삭제 등)
149
- sdd constitution bump --minor # 기능 추가
150
- sdd constitution bump --patch # 문구 수정
151
70
  ```
152
-
153
- ### `sdd change`
154
-
155
- 변경 제안을 생성하고 관리합니다.
156
-
157
- ```bash
158
- sdd change # 새 변경 제안 생성
159
- sdd change -t "제목" # 제목과 함께 생성
160
- sdd change -l # 진행 중인 변경 목록
161
- sdd change <id> # 특정 변경 조회
162
- sdd change diff <id> # 변경 내용 diff
163
- sdd change validate <id> # 변경 제안 검증
164
- sdd change apply <id> # 변경 적용
165
- sdd change archive <id> # 변경 아카이브
71
+ /sdd.constitution
166
72
  ```
167
73
 
168
- ### `sdd impact`
169
-
170
- 스펙 변경의 영향도를 분석합니다.
74
+ 신규 프로젝트의 경우, 프로젝트 설명을 함께 입력할 수 있습니다:
171
75
 
172
- ```bash
173
- # 기본 영향도 분석
174
- sdd impact <feature> # 특정 기능 영향도 분석
175
- sdd impact <feature> --graph # 의존성 그래프 출력 (Mermaid)
176
- sdd impact <feature> --json # JSON 형식 출력
177
-
178
- # 코드 영향도 분석
179
- sdd impact <feature> --code # 스펙 변경이 코드에 미치는 영향 분석
180
- sdd impact <feature> --code --json # JSON 형식
181
-
182
- # 리포트 및 변경 분석
183
- sdd impact report # 전체 프로젝트 리포트
184
- sdd impact report --json # JSON 형식 리포트
185
- sdd impact change <id> # 변경 제안 영향도 분석
186
-
187
- # What-if 시뮬레이션
188
- sdd impact simulate <feature> <proposal> # 변경 전 영향도 예측
189
- sdd impact simulate auth change-001 # 예시
76
+ ```
77
+ /sdd.constitution React 기반 할일 관리 앱
190
78
  ```
191
79
 
192
- 코드 영향도 분석은 다음 방법으로 스펙-코드 연결을 탐지합니다:
193
- - 주석 참조: `// spec: feature-id`, `/* spec: feature-id */`, `@spec feature-id`
194
- - 파일명/디렉토리명 매칭: `auth.ts` ↔ `auth` 스펙
195
- - 매핑 설정: `.sdd/code-mapping.json` 파일 사용
80
+ AI가 `.sdd/constitution.md`를 분석하고, 프로젝트 원칙 작성을 도와줍니다:
81
+ - 핵심 원칙 (Core Principles)
82
+ - 기술 원칙 (Technical Principles)
83
+ - 금지 사항 (Forbidden)
196
84
 
197
- ### `sdd transition`
85
+ ### Step 5: 새 기능 명세 작성
198
86
 
199
- 워크플로우 전환을 수행합니다.
87
+ 기능 명세를 AI와 함께 작성합니다:
200
88
 
201
- ```bash
202
- sdd transition new-to-change <spec-id> # new → change 전환
203
- sdd transition change-to-new <change-id> # change → new 전환
204
- sdd transition guide # 전환 가이드
89
+ ```
90
+ /sdd.new
205
91
  ```
206
92
 
207
- ### `sdd watch`
208
-
209
- 스펙 파일 변경을 실시간으로 감시합니다.
93
+ 필요한 기능을 함께 입력하면 AI가 바로 명세 작성을 시작합니다:
210
94
 
211
- ```bash
212
- sdd watch # 기본 실행 (자동 검증 포함)
213
- sdd watch --no-validate # 자동 검증 비활성화
214
- sdd watch --impact # 영향도 분석 포함
215
- sdd watch --quiet # 성공 시 출력 생략
216
- sdd watch --debounce 1000 # 디바운스 시간 설정 (ms)
95
+ ```
96
+ /sdd.new 사용자 인증 기능
217
97
  ```
218
98
 
219
- Ctrl+C로 종료 세션 통계가 표시됩니다.
99
+ AI가 대화를 통해 다음을 생성합니다:
100
+ - `spec.md` - 기능 명세 (RFC 2119 + GIVEN-WHEN-THEN)
101
+ - `plan.md` - 구현 계획
102
+ - `tasks.md` - 작업 분해
220
103
 
221
- ### `sdd quality`
104
+ ### Step 6: 구현 진행
222
105
 
223
- 스펙 품질을 분석하고 점수를 산출합니다.
106
+ 작업 목록을 기반으로 순차적 구현:
224
107
 
225
- ```bash
226
- sdd quality # 전체 프로젝트 분석
227
- sdd quality <feature> # 개별 스펙 분석
228
- sdd quality --all # 전체 분석 (명시적)
229
- sdd quality --json # JSON 형식 출력
230
- sdd quality --min-score 70 # 최소 점수 기준 (미달 시 에러)
108
+ ```
109
+ /sdd.implement
231
110
  ```
232
111
 
233
- 품질 평가 기준:
234
- - RFC 2119 키워드 사용 (SHALL, MUST, SHOULD, MAY)
235
- - GIVEN-WHEN-THEN 시나리오 존재
236
- - 요구사항 섹션 존재
237
- - 의존성 명시
238
- - 구조 완성도 (제목/설명/목표/범위 등)
239
- - Constitution 버전 참조
240
- - 내부 링크 무결성
241
- - 메타데이터 완성도
242
-
243
- 등급: A (90%+), B (80%+), C (70%+), D (60%+), F (<60%)
112
+ AI가 tasks.md를 읽고, TDD 방식으로 구현을 안내합니다.
244
113
 
245
- ### `sdd report`
114
+ ---
246
115
 
247
- 스펙 리포트를 생성합니다.
116
+ ## 전체 워크플로우 예시
248
117
 
249
- ```bash
250
- sdd report # HTML 리포트 (기본)
251
- sdd report --format markdown # Markdown 형식
252
- sdd report --format json # JSON 형식
253
- sdd report -o report.html # 출력 경로 지정
254
- sdd report --title "My Report" # 리포트 제목 설정
255
- sdd report --no-quality # 품질 분석 제외
256
- sdd report --no-validation # 검증 결과 제외
257
118
  ```
258
-
259
- ### `sdd search`
260
-
261
- 스펙을 검색합니다.
262
-
263
- ```bash
264
- sdd search <query> # 키워드로 검색
265
- sdd search auth # "auth" 포함 스펙 검색
266
- sdd search --status draft # 상태별 필터링
267
- sdd search --phase phase-1 # 페이즈별 필터링
268
- sdd search --type spec # 타입별 필터링 (spec, change)
269
- sdd search --json # JSON 형식 출력
270
- sdd search --limit 10 # 결과 수 제한
119
+ ┌─────────────────────────────────────────────────────────────┐
120
+ │ 1. sdd init → 프로젝트 초기화 │
121
+ │ 2. claude → Claude Code 실행 │
122
+ │ 3. /sdd.start → 워크플로우 시작 │
123
+ │ 4. /sdd.constitution → 프로젝트 원칙 정의 │
124
+ │ 5. /sdd.new → 기능 명세 작성 │
125
+ │ 6. /sdd.plan → 구현 계획 수립 │
126
+ │ 7. /sdd.tasks → 작업 분해 │
127
+ │ 8. /sdd.implement → 순차적 구현 │
128
+ │ 9. /sdd.validate → 명세 검증 │
129
+ └─────────────────────────────────────────────────────────────┘
271
130
  ```
272
131
 
273
- 검색 대상:
274
- - 스펙 제목 및 내용
275
- - 요구사항 텍스트
276
- - 시나리오 (GIVEN-WHEN-THEN)
277
- - 메타데이터 (id, status, phase)
132
+ ---
278
133
 
279
- ### `sdd migrate`
134
+ ## 구현 준비: sdd prepare
280
135
 
281
- 기존 문서나 외부 SDD 도구에서 마이그레이션합니다.
136
+ 구현 필요한 Claude Code 서브에이전트와 스킬을 점검합니다.
282
137
 
283
- ```bash
284
- # 문서 마이그레이션
285
- sdd migrate docs <source> # 문서 마이그레이션
286
- sdd migrate analyze <file> # 문서 분석
287
- sdd migrate scan [dir] # 디렉토리 스캔
138
+ ### 워크플로우
288
139
 
289
- # 외부 도구 감지 및 마이그레이션
290
- sdd migrate detect # 외부 SDD 도구 감지
291
- sdd migrate openspec [source] # OpenSpec에서 마이그레이션
292
- sdd migrate speckit [source] # Spec Kit에서 마이그레이션
293
- sdd migrate openspec --dry-run # 미리보기 모드
294
- sdd migrate speckit --overwrite # 기존 스펙 덮어쓰기
295
140
  ```
296
-
297
- 지원 외부 도구:
298
- - **OpenSpec**: `openspec/` 디렉토리, AGENTS.md, specs/changes 구조
299
- - **Spec Kit**: `.specify/` 디렉토리, memory/constitution.md
300
-
301
- ### `sdd cicd`
302
-
303
- CI/CD 파이프라인을 설정합니다.
304
-
305
- ```bash
306
- sdd cicd setup # GitHub Actions 설정
307
- sdd cicd setup gitlab # GitLab CI 설정
308
- sdd cicd setup all # 모든 플랫폼 설정
309
- sdd cicd hooks # Git hooks 설정
310
- sdd cicd check # CI 검증 실행
141
+ /sdd.new → /sdd.plan → /sdd.tasks → sdd prepare → /sdd.implement
142
+
143
+ 서브에이전트/스킬 점검
311
144
  ```
312
145
 
313
- ### `sdd status`
314
-
315
- 프로젝트 상태를 조회합니다.
146
+ ### 사용법
316
147
 
317
148
  ```bash
318
- sdd status # 기본 상태
319
- sdd status --verbose # 상세 정보
320
- sdd status --json # JSON 형식
149
+ sdd prepare user-auth
321
150
  ```
322
151
 
323
- ### `sdd list`
152
+ tasks.md를 분석하여 필요한 도구를 자동으로 감지합니다:
324
153
 
325
- 항목 목록을 조회합니다.
326
-
327
- ```bash
328
- sdd list # 전체 요약
329
- sdd list features # 기능 목록
330
- sdd list changes # 변경 목록
331
- sdd list specs # 스펙 파일 목록
332
- sdd list templates # 템플릿 목록
333
154
  ```
155
+ ℹ 기능 'user-auth' 준비 점검 중...
334
156
 
335
- ### `sdd prompt`
157
+ 분석 완료
336
158
 
337
- AI 도구용 슬래시 커맨드 프롬프트를 출력합니다.
159
+ 작업 수: 5개
160
+ 서브에이전트: 2개 필요 (존재: 0, 누락: 2)
161
+ 스킬: 3개 필요 (존재: 1, 누락: 2)
338
162
 
339
- ```bash
340
- sdd prompt # 사용 가능한 명령어 목록
341
- sdd prompt --list # 명령어 목록
342
- sdd prompt new # /sdd.new 프롬프트
343
- sdd prompt change # /sdd.change 프롬프트
344
- ```
163
+ ⚠ 누락된 서브에이전트:
164
+ - test-runner: 테스트 실행 결과 분석 에이전트
165
+ - api-scaffold: REST API 보일러플레이트 생성 에이전트
345
166
 
346
- ## 워크플로우
167
+ 누락된 스킬:
168
+ - gen-api: API 엔드포인트 생성 스킬
169
+ - review: 코드 리뷰 스킬
347
170
 
348
- ### 신규 기능 개발
349
-
350
- ```
351
- 1. sdd start # 워크플로우 시작
352
- 2. sdd new <feature> --all # 기능 생성 (spec, plan, tasks)
353
- 3. spec.md 작성 # 요구사항 정의
354
- 4. sdd validate # 명세 검증
355
- 5. plan.md 작성 # 구현 계획
356
- 6. tasks.md 기반 구현 # 작업별 구현
357
- 7. sdd change archive # 완료 후 아카이브
171
+ 보고서: .sdd/specs/user-auth/prepare.md
172
+ ℹ 누락된 도구를 자동 생성하려면: sdd prepare user-auth --auto-approve
358
173
  ```
359
174
 
360
- ### 기존 기능 변경
175
+ ### Claude Code 도구 위치
361
176
 
362
- ```
363
- 1. sdd change -t "변경 제목" # 변경 제안 생성
364
- 2. proposal.md 작성 # 변경 내용 정의
365
- 3. sdd impact <feature> # 영향도 분석
366
- 4. sdd change validate <id> # 검증
367
- 5. sdd change apply <id> # 변경 적용
368
- 6. sdd change archive <id> # 아카이브
369
- ```
177
+ | 도구 유형 | 위치 |
178
+ |-----------|------|
179
+ | 서브에이전트 | `.claude/agents/<name>.md` |
180
+ | 스킬 | `.claude/skills/<name>/SKILL.md` |
181
+ | 슬래시 커맨드 | `.claude/commands/<name>.md` |
370
182
 
371
- ### 워크플로우 전환
183
+ ### 옵션
372
184
 
373
- 작업 워크플로우를 변경해야 할 때:
185
+ | 옵션 | 설명 |
186
+ |------|------|
187
+ | `--dry-run` | 파일 생성 없이 분석 결과만 출력 |
188
+ | `--auto-approve` | 누락된 도구를 자동으로 생성 |
189
+ | `--json` | JSON 형식으로 출력 |
374
190
 
375
- ```
376
- # 새 기능 → 변경 제안 (기존 스펙과 중복 발견 시)
377
- sdd transition new-to-change <spec-id>
191
+ ---
378
192
 
379
- # 변경 새 기능 (범위가 커서 분리 필요 시)
380
- sdd transition change-to-new <change-id>
381
- ```
193
+ ## 슬래시 커맨드 (26개)
382
194
 
383
- ## Claude 슬래시 커맨드
195
+ `sdd init` 실행 시 `.claude/commands/`에 자동 생성됩니다.
384
196
 
385
- `sdd init` 실행 시 `.claude/commands/` 디렉토리에 Claude Code용 슬래시 커맨드가 자동 생성됩니다.
197
+ ### 핵심 워크플로우
386
198
 
387
- ### 전체 슬래시 커맨드 목록 (26개)
199
+ | 커맨드 | 설명 | 사용 시점 |
200
+ |--------|------|----------|
201
+ | `/sdd.start` | 통합 진입점 | 작업 시작 시 |
202
+ | `/sdd.constitution` | 프로젝트 원칙 관리 | 프로젝트 초기 설정 |
203
+ | `/sdd.new` | 새 기능 명세 작성 | 새 기능 개발 시 |
204
+ | `/sdd.plan` | 구현 계획 작성 | 명세 작성 후 |
205
+ | `/sdd.tasks` | 작업 분해 | 계획 수립 후 |
206
+ | `/sdd.implement` | 순차적 구현 | 작업 분해 후 |
207
+ | `/sdd.validate` | 스펙 검증 | 작성/수정 후 |
388
208
 
389
- #### 워크플로우 커맨드
209
+ ### 변경 관리
390
210
 
391
211
  | 커맨드 | 설명 |
392
212
  |--------|------|
393
- | `/sdd.start` | 통합 진입점 - 워크플로우 시작 |
394
- | `/sdd.new` | 기능 명세 작성 |
395
- | `/sdd.plan` | 구현 계획 작성 |
396
- | `/sdd.tasks` | 작업 분해 |
397
- | `/sdd.implement` | 순차적 구현 진행 |
398
- | `/sdd.validate` | 스펙 형식 검증 |
399
- | `/sdd.status` | 프로젝트 상태 확인 |
400
- | `/sdd.change` | 변경 제안 작성 |
401
- | `/sdd.constitution` | Constitution 관리 |
402
- | `/sdd.transition` | 워크플로우 전환 |
213
+ | `/sdd.change` | 기존 스펙 변경 제안 |
214
+ | `/sdd.impact` | 변경 영향도 분석 |
215
+ | `/sdd.transition` | new change 워크플로우 전환 |
403
216
 
404
- #### 분석 및 품질 커맨드
217
+ ### 분석 및 품질
405
218
 
406
219
  | 커맨드 | 설명 |
407
220
  |--------|------|
408
221
  | `/sdd.analyze` | 요청 분석 및 규모 판단 |
409
- | `/sdd.impact` | 영향도 분석 |
410
- | `/sdd.quality` | 스펙 품질 분석 |
411
- | `/sdd.report` | 리포트 생성 |
222
+ | `/sdd.quality` | 스펙 품질 점수 산출 |
223
+ | `/sdd.report` | 프로젝트 리포트 생성 |
412
224
  | `/sdd.search` | 스펙 검색 |
225
+ | `/sdd.status` | 프로젝트 상태 확인 |
413
226
 
414
- #### 문서 생성 커맨드
227
+ ### 문서 생성
415
228
 
416
229
  | 커맨드 | 설명 |
417
230
  |--------|------|
418
- | `/sdd.research` | 기술 리서치 문서 작성 |
419
- | `/sdd.data-model` | 데이터 모델 문서 작성 |
420
- | `/sdd.guide` | 전체 워크플로우 가이드 |
421
- | `/sdd.prepare` | 환경 준비 가이드 |
231
+ | `/sdd.research` | 기술 리서치 문서 |
232
+ | `/sdd.data-model` | 데이터 모델 문서 |
233
+ | `/sdd.guide` | 워크플로우 가이드 |
234
+ | `/sdd.prepare` | 서브에이전트/스킬 점검 |
422
235
 
423
- #### 운영 커맨드
236
+ ### 운영
424
237
 
425
238
  | 커맨드 | 설명 |
426
239
  |--------|------|
427
240
  | `/sdd.chat` | 대화형 SDD 어시스턴트 |
428
241
  | `/sdd.list` | 항목 목록 조회 |
429
242
  | `/sdd.watch` | 파일 감시 모드 |
430
- | `/sdd.migrate` | 마이그레이션 |
243
+ | `/sdd.migrate` | 외부 도구에서 마이그레이션 |
431
244
  | `/sdd.cicd` | CI/CD 설정 |
432
245
  | `/sdd.prompt` | 프롬프트 출력 |
433
246
 
434
- ### 사용법
247
+ ---
248
+
249
+ ## 대화형 모드: /sdd.chat
435
250
 
436
- Claude Code에서 슬래시 커맨드를 입력하면 해당 워크플로우가 자동으로 실행됩니다:
251
+ 자연어로 SDD 작업을 수행할 있습니다:
437
252
 
438
253
  ```
439
- /sdd.start # 워크플로우 시작
440
- /sdd.new # 새 기능 명세 작성 시작
441
- /sdd.chat # 대화형 모드로 SDD 작업
254
+ /sdd.chat
442
255
  ```
443
256
 
444
- ### 워크플로우 예시
445
-
446
- 1. **대화형 모드로 시작**
447
- ```
448
- /sdd.chat
449
- 자연어로 SDD 작업 수행
450
- → 질문/작성/검토/실행 모드 지원
451
- ```
452
-
453
- 2. **새 기능 개발**
454
- ```
455
- /sdd.new
456
- → 기능명과 설명 입력
457
- → spec.md 자동 생성 및 작성 안내
458
- ```
257
+ 예시 대화:
258
+ ```
259
+ You: 사용자 인증 기능을 만들고 싶어
260
+ AI: 사용자 인증 기능의 명세를 작성해 드릴게요. 먼저 몇 가지 질문이 있습니다...
261
+ 1. 어떤 인증 방식을 사용하시나요? (JWT, 세션, OAuth)
262
+ 2. 소셜 로그인이 필요한가요?
263
+ ...
264
+ ```
459
265
 
460
- 3. **워크플로우 전환**
461
- ```
462
- /sdd.transition
463
- → new ↔ change 워크플로우 전환
464
- → 전환 가이드 제공
465
- ```
266
+ ---
466
267
 
467
268
  ## 스펙 파일 형식
468
269
 
469
- ### spec.md
270
+ ### spec.md 예시
470
271
 
471
272
  ```markdown
472
273
  ---
473
- id: feature-id
474
- title: "기능 제목"
274
+ id: user-auth
275
+ title: "사용자 인증"
475
276
  status: draft
476
- created: 2025-12-21
277
+ created: 2025-12-24
477
278
  constitution_version: 1.0.0
478
- depends: null
479
279
  ---
480
280
 
481
- # 기능 제목
482
-
483
- > 기능 설명
281
+ # 사용자 인증
484
282
 
485
- ---
283
+ > JWT 기반 사용자 인증 시스템
486
284
 
487
285
  ## 요구사항
488
286
 
489
- ### REQ-01: 요구사항 제목
490
-
491
- - 시스템은 [기능]을 지원해야 한다(SHALL)
492
- - 응답 시간은 1초 이내여야 한다(SHOULD)
287
+ ### REQ-01: 로그인
493
288
 
494
- ---
289
+ - 시스템은 이메일/비밀번호 로그인을 지원해야 한다(SHALL)
290
+ - 로그인 실패 시 구체적인 에러 메시지를 반환해야 한다(SHOULD)
495
291
 
496
292
  ## 시나리오
497
293
 
498
- ### Scenario 1: 성공 케이스
294
+ ### Scenario 1: 성공적인 로그인
499
295
 
500
- - **GIVEN** 유효한 사용자가 있을 때
501
- - **WHEN** 로그인을 시도하면
502
- - **THEN** 메인 페이지로 이동한다
296
+ - **GIVEN** 유효한 사용자 계정이 있을 때
297
+ - **WHEN** 올바른 이메일과 비밀번호로 로그인하면
298
+ - **THEN** JWT 토큰이 반환된다
299
+ - **AND** 토큰 만료 시간이 설정된다
503
300
  ```
504
301
 
505
302
  ### RFC 2119 키워드
506
303
 
507
- | 키워드 | 의미 | 사용 예시 |
508
- |--------|------|-----------|
509
- | **SHALL** / **MUST** | 절대 필수 | "시스템은 인증을 지원해야 한다(SHALL)" |
510
- | **SHOULD** | 권장 (예외 가능) | "응답 시간은 1초 이내여야 한다(SHOULD)" |
511
- | **MAY** | 선택적 | "다크 모드를 지원할 수 있다(MAY)" |
512
- | **SHALL NOT** | 절대 금지 | "평문 비밀번호를 저장해서는 안 된다(SHALL NOT)" |
304
+ | 키워드 | 의미 |
305
+ |--------|------|
306
+ | **SHALL** / **MUST** | 절대 필수 |
307
+ | **SHOULD** | 권장 (예외 허용) |
308
+ | **MAY** | 선택적 |
309
+ | **SHALL NOT** | 절대 금지 |
513
310
 
514
- ## CI/CD 통합
311
+ ---
515
312
 
516
- ### GitHub Actions
313
+ ## CLI 명령어
314
+
315
+ 슬래시 커맨드 외에 터미널에서 직접 사용할 수 있는 명령어들입니다.
316
+
317
+ ### 기본 명령어
517
318
 
518
319
  ```bash
519
- sdd cicd setup github
520
- # .github/workflows/sdd-validate.yml 생성
320
+ sdd init # 프로젝트 초기화
321
+ sdd validate # 스펙 검증
322
+ sdd status # 상태 확인
323
+ sdd list # 목록 조회
521
324
  ```
522
325
 
523
- ### GitLab CI
326
+ ### 기능 개발
524
327
 
525
328
  ```bash
526
- sdd cicd setup gitlab
527
- # .gitlab-ci-sdd.yml 생성
329
+ sdd new <name> # 새 기능 생성
330
+ sdd new <name> --all # spec + plan + tasks 모두 생성
528
331
  ```
529
332
 
530
- ### Git Hooks
333
+ ### 변경 관리
531
334
 
532
335
  ```bash
533
- sdd cicd hooks
534
- # .husky/pre-commit, pre-push 생성
535
- ```
536
-
537
- ## 고급 기능
538
-
539
- ### 코드 매핑 설정
540
-
541
- `.sdd/code-mapping.json` 파일을 사용하여 스펙과 코드 파일 간의 명시적 매핑을 정의할 수 있습니다:
542
-
543
- ```json
544
- {
545
- "version": "1.0.0",
546
- "mappings": [
547
- {
548
- "specId": "user-auth",
549
- "files": [
550
- "src/core/auth.ts",
551
- "src/services/auth-service.ts"
552
- ],
553
- "directories": [
554
- "src/auth/"
555
- ]
556
- },
557
- {
558
- "specId": "payment",
559
- "files": [
560
- "src/payment/handler.ts"
561
- ]
562
- }
563
- ],
564
- "patterns": {
565
- "include": ["src/**/*.ts"],
566
- "exclude": ["**/*.test.ts", "**/*.spec.ts"]
567
- }
568
- }
569
- ```
570
-
571
- ### Constitution 위반 검증
572
-
573
- 스펙이 Constitution에 정의된 원칙을 위반하는지 자동으로 검사합니다:
336
+ sdd change # 변경 제안 생성
337
+ sdd change apply <id> # 변경 적용
338
+ sdd impact <feature> # 영향도 분석
339
+ ```
340
+
341
+ ### 품질 및 분석
574
342
 
575
343
  ```bash
576
- # Constitution 위반 검사 포함 (기본값)
577
- sdd validate
344
+ sdd quality # 품질 분석
345
+ sdd quality --min-score 70 # 최소 점수 기준
346
+ sdd report # 리포트 생성
347
+ sdd search <query> # 스펙 검색
348
+ ```
349
+
350
+ ### 구현 준비
351
+
352
+ ```bash
353
+ sdd prepare <feature> # 서브에이전트/스킬 점검
354
+ sdd prepare <feature> --dry-run # 변경 없이 분석만
355
+ sdd prepare <feature> --auto-approve # 누락 도구 자동 생성
356
+ ```
357
+
358
+ ### 운영
578
359
 
579
- # Constitution 검사 스킵
580
- sdd validate --no-constitution
360
+ ```bash
361
+ sdd watch # 파일 감시
362
+ sdd migrate detect # 외부 도구 감지
363
+ sdd cicd setup # CI/CD 설정
581
364
  ```
582
365
 
583
- 위반 감지 예시:
584
- - Constitution: "평문 비밀번호를 저장해서는 안 된다(SHALL NOT)"
585
- - 스펙: "비밀번호를 평문으로 저장한다" → 위반 경고 출력
366
+ ---
367
+
368
+ ## CI/CD 통합
369
+
370
+ ### GitHub Actions
586
371
 
587
- ### What-if 시뮬레이션
372
+ ```bash
373
+ sdd cicd setup github
374
+ ```
588
375
 
589
- 변경을 적용하기 전에 영향도를 예측합니다:
376
+ ### Git Hooks
590
377
 
591
378
  ```bash
592
- sdd impact simulate <feature> <proposal>
379
+ sdd cicd hooks
380
+ ```
381
+
382
+ 커밋 전 자동으로 스펙 검증이 실행됩니다.
383
+
384
+ ---
385
+
386
+ ## 디렉토리 구조
387
+
388
+ `sdd init` 실행 후 생성되는 구조:
389
+
390
+ ```
391
+ your-project/
392
+ ├── .sdd/
393
+ │ ├── constitution.md # 프로젝트 헌법
394
+ │ ├── AGENTS.md # AI 워크플로우 가이드
395
+ │ ├── specs/ # 기능 명세
396
+ │ │ └── feature-name/
397
+ │ │ ├── spec.md
398
+ │ │ ├── plan.md
399
+ │ │ └── tasks.md
400
+ │ ├── changes/ # 변경 제안
401
+ │ ├── archive/ # 완료된 변경
402
+ │ └── templates/ # 템플릿
403
+ └── .claude/
404
+ └── commands/ # 슬래시 커맨드 (26개)
405
+ ├── sdd.start.md
406
+ ├── sdd.new.md
407
+ ├── sdd.constitution.md
408
+ └── ...
593
409
  ```
594
410
 
595
- 시뮬레이션 결과:
596
- - 현재 상태 vs 변경 후 상태 비교
597
- - 리스크 점수 변화
598
- - 새로 영향받는 스펙 목록
599
- - 권장사항 및 경고
411
+ ---
600
412
 
601
413
  ## 개발
602
414
 
603
415
  ```bash
604
- # 의존성 설치
416
+ git clone https://github.com/JakeB-5/sdd-tool.git
417
+ cd sdd-tool
605
418
  pnpm install
606
-
607
- # 빌드
608
419
  pnpm run build
609
-
610
- # 개발 모드 (watch)
611
- pnpm run dev
612
-
613
- # 테스트
614
- pnpm test # watch 모드
615
- pnpm run test:run # 단일 실행
616
- pnpm run test:coverage # 커버리지
617
-
618
- # 린트
619
- pnpm run lint
620
-
621
- # 타입 체크
622
- pnpm run typecheck
623
- ```
624
-
625
- ### 프로젝트 구조
626
-
627
- ```
628
- sdd-tool/
629
- ├── bin/ # CLI 진입점
630
- │ └── sdd.js
631
- ├── src/
632
- │ ├── cli/ # CLI 명령어
633
- │ │ ├── commands/
634
- │ │ │ ├── init.ts
635
- │ │ │ ├── new.ts
636
- │ │ │ ├── validate.ts
637
- │ │ │ ├── change.ts
638
- │ │ │ ├── impact.ts
639
- │ │ │ ├── status.ts
640
- │ │ │ ├── list.ts
641
- │ │ │ ├── prompt.ts
642
- │ │ │ ├── constitution.ts
643
- │ │ │ ├── start.ts
644
- │ │ │ ├── transition.ts
645
- │ │ │ ├── migrate.ts
646
- │ │ │ ├── cicd.ts
647
- │ │ │ ├── watch.ts
648
- │ │ │ ├── quality.ts
649
- │ │ │ ├── report.ts
650
- │ │ │ └── search.ts
651
- │ │ └── index.ts
652
- │ ├── core/ # 핵심 로직
653
- │ │ ├── spec/ # 스펙 파서/검증
654
- │ │ ├── constitution/ # 헌법 시스템
655
- │ │ ├── change/ # 변경 워크플로우
656
- │ │ ├── impact/ # 영향도 분석
657
- │ │ ├── new/ # 신규 기능 워크플로우
658
- │ │ ├── watch/ # 파일 감시
659
- │ │ ├── quality/ # 품질 분석
660
- │ │ ├── report/ # 리포트 생성
661
- │ │ ├── search/ # 스펙 검색
662
- │ │ └── migrate/ # 마이그레이션
663
- │ ├── generators/ # 파일 생성기
664
- │ ├── prompts/ # 슬래시 커맨드
665
- │ ├── errors/ # 에러 처리
666
- │ ├── utils/ # 유틸리티
667
- │ └── types/ # 타입 정의
668
- ├── templates/ # 기본 템플릿
669
- └── tests/ # 테스트
670
- ├── unit/
671
- └── integration/
420
+ pnpm test
672
421
  ```
673
422
 
423
+ ---
424
+
674
425
  ## 라이선스
675
426
 
676
427
  MIT License