# 📚 Claude-X 문서 가이드

Claude-X 프로젝트의 모든 문서를 한 곳에서 찾을 수 있습니다.

## 🚀 시작하기

### 처음 사용하시나요?

1. **[QUICKSTART.md](QUICKSTART.md)** ⚡
   - 5분 빠른 시작 가이드
   - 필수 명령어만 간단히 설명
   - **추천**: 가장 먼저 읽어보세요!

2. **[README.md](README.md)** 📖
   - 프로젝트 전체 개요
   - 모든 기능 상세 설명
   - 완전한 레퍼런스 가이드

### 실제 사용 예시를 보고 싶으신가요?

3. **[EXAMPLES.md](EXAMPLES.md)** 💡
   - 10가지 실제 사용 시나리오
   - 워크플로우 예시
   - 프로젝트별/기능별 활용법
   - **추천**: README 읽은 후 실습

## 🛠️ 개발자용 문서

### 프로젝트 구조를 이해하고 싶으신가요?

4. **[PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md)** 📁
   - 전체 파일 구조
   - 모듈별 역할과 라인 수
   - 핵심 파일 설명
   - **추천**: 코드 수정 전 필독

### 아키텍처와 설계를 알고 싶으신가요?

5. **[ARCHITECTURE.md](ARCHITECTURE.md)** 🏗️
   - 시스템 아키텍처 다이어그램
   - 데이터 흐름 및 처리 과정
   - 데이터베이스 스키마 (ERD)
   - 성능 최적화 전략
   - **추천**: 깊이 있는 이해가 필요할 때

### 코드를 수정하거나 기여하고 싶으신가요?

6. **[CONTRIBUTING.md](CONTRIBUTING.md)** 🤝
   - 개발 환경 설정
   - 코드 작성 가이드라인
   - 새 기능 추가 방법
   - PR 제출 가이드
   - **추천**: 개발자라면 필수

## 📊 프로젝트 정보

### 변경 이력을 확인하고 싶으신가요?

7. **[CHANGELOG.md](CHANGELOG.md)** 📝
   - 버전별 변경 내용
   - 릴리즈 노트
   - 향후 계획

## 🎯 상황별 추천 문서

### 상황 1: "Claude-X가 뭔지 모르겠어요"
```
읽을 순서:
1. README.md (개요 부분만)
2. QUICKSTART.md
3. EXAMPLES.md (관심 있는 시나리오만)
```

### 상황 2: "빠르게 설치해서 써보고 싶어요"
```
읽을 순서:
1. QUICKSTART.md (전체)
2. EXAMPLES.md (필요시)
```

### 상황 3: "모든 기능을 제대로 알고 싶어요"
```
읽을 순서:
1. README.md (전체)
2. EXAMPLES.md (전체)
3. ARCHITECTURE.md (필요시)
```

### 상황 4: "코드를 수정하고 싶어요"
```
읽을 순서:
1. PROJECT_STRUCTURE.md
2. ARCHITECTURE.md
3. CONTRIBUTING.md
4. 관련 소스 코드
```

### 상황 5: "새 기능을 추가하고 싶어요"
```
읽을 순서:
1. CONTRIBUTING.md (새 기능 추가 섹션)
2. PROJECT_STRUCTURE.md (모듈 구조 확인)
3. ARCHITECTURE.md (설계 원칙 확인)
4. 관련 소스 코드
```

### 상황 6: "다음 작업자에게 인수인계해야 해요"
```
공유할 문서:
1. QUICKSTART.md (빠른 시작)
2. README.md (전체 기능)
3. PROJECT_STRUCTURE.md (구조 이해)
4. EXAMPLES.md (실제 활용)
필요시: ARCHITECTURE.md, CONTRIBUTING.md
```

## 📖 문서별 요약

| 문서 | 분량 | 대상 | 목적 |
|------|------|------|------|
| **QUICKSTART.md** | 100줄 | 신규 사용자 | 5분 안에 시작 |
| **README.md** | 450줄 | 모든 사용자 | 완전한 가이드 |
| **EXAMPLES.md** | 300줄 | 실무 사용자 | 실전 활용법 |
| **PROJECT_STRUCTURE.md** | 400줄 | 개발자 | 코드 구조 이해 |
| **ARCHITECTURE.md** | 400줄 | 개발자/아키텍트 | 설계 이해 |
| **CONTRIBUTING.md** | 300줄 | 기여자 | 개발 환경 설정 |
| **CHANGELOG.md** | 200줄 | 모든 사용자 | 버전 정보 |

## 🔍 핵심 개념 빠른 찾기

| 개념 | 문서 | 섹션 |
|------|------|------|
| 설치 방법 | README.md | 설치 |
| 첫 실행 | QUICKSTART.md | 첫 번째 명령어 |
| 명령어 전체 | README.md | 사용법 |
| 코드 검색 | EXAMPLES.md | 코드 스니펫 검색 |
| 프롬프트 분석 | EXAMPLES.md | 프롬프트 개선 |
| 데이터베이스 스키마 | ARCHITECTURE.md | 데이터베이스 설계 |
| 모듈 설명 | PROJECT_STRUCTURE.md | 모듈별 파일 설명 |
| 성능 최적화 | ARCHITECTURE.md | 성능 및 최적화 |
| 새 기능 추가 | CONTRIBUTING.md | 새 기능 추가하기 |
| 버그 수정 | CONTRIBUTING.md | 버그 수정 |

## 💡 팁

- **완전 초보**: QUICKSTART.md → README.md
- **바쁜 개발자**: EXAMPLES.md (관심 섹션만)
- **깊은 이해**: README.md → ARCHITECTURE.md → 소스 코드
- **기여하기**: CONTRIBUTING.md → PROJECT_STRUCTURE.md → 소스 코드

## 📞 추가 도움말

문서를 읽어도 해결되지 않는 경우:

1. **이슈 제출**: GitHub Issues에 질문/버그 리포트
2. **토론 시작**: GitHub Discussions에서 아이디어 공유
3. **코드 확인**: `src/claude_x/` 디렉토리의 실제 구현 참고

---

**어디서부터 시작해야 할지 모르겠다면?**

→ [QUICKSTART.md](QUICKSTART.md)를 먼저 읽어보세요! ⚡

**마지막 업데이트**: 2026-01-20
