Skip to content

Commit 328805b

Browse files
authored
Merge pull request #93 from Nicered/feature/phase-002-documentation
docs: Add Phase 002 overview and reorganize design docs
2 parents 9c0459d + 312a7b5 commit 328805b

16 files changed

Lines changed: 1629 additions & 3 deletions

CLAUDE.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,34 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
1818
- `scripts/` - 일회성 스크립트
1919
- `playground/` - 웹 기반 다이어그램 에디터
2020

21+
## 개발 Phase
22+
23+
프로젝트는 Phase 단위로 개발을 진행하며, 설계 문서는 Phase별 폴더로 분리:
24+
25+
| Phase | 설명 | 폴더 |
26+
|-------|------|------|
27+
| **Phase 001** | MVP 초기 개발 | `design/phase-001/` |
28+
| **Phase 002** | 기능 고도화 (체크포인트, DB 뷰어, 아키텍처 리뷰 개선) | `design/phase-002/` |
29+
2130
## 문서 작성 규칙
2231

23-
- 설계 문서(`design/`): 파일명은 3자리 순서 번호로 시작 (예: `001-research.md`)
24-
- 사용자 문서(`docs/`): 명확한 주제별 이름 사용 (예: `getting-started.md`, `api-reference.md`)
25-
- 반드시 LLM이 전역적으로 확인해야하는 문서는 `GLOBAL-`이라는 접두어를 붙임.
32+
### 설계 문서 (`design/`)
33+
34+
- **Phase별 폴더**: `design/phase-{번호}/`
35+
- **파일명**: `{순번}-{주제}.md` (3자리 순번)
36+
- 예: `design/phase-001/001-research.md`
37+
- 예: `design/phase-002/001-checkpoint-research.md`
38+
- **기능별 분리**: 하나의 문서에 여러 기능을 합치지 않고 기능별로 분리
39+
- **하위 폴더 금지**: Phase 폴더 내에서는 추가 하위 폴더를 만들지 않음
40+
41+
### 전역 문서
42+
43+
- Phase와 관계없이 전역적으로 참조해야 하는 문서는 `design/GLOBAL-{주제}.md` 형식 사용
44+
- LLM이 항상 읽어야 하는 문서
45+
46+
### 사용자 문서 (`docs/`)
47+
48+
- 명확한 주제별 이름 사용 (예: `getting-started.md`, `api-reference.md`)
2649

2750
## 다이어그램 규칙
2851

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)