# TK-FB-Project 개발 문서

## 📚 문서 구조

이 디렉토리는 TK-FB-Project의 개발 및 유지보수를 위한 종합 문서 저장소입니다.

### 디렉토리 구조

```
docs/
├── README.md                          # 이 파일 - 문서 인덱스
├── architecture/                      # 아키텍처 관련 문서
│   ├── OVERVIEW.md                   # 시스템 아키텍처 개요
│   ├── DATABASE.md                   # 데이터베이스 스키마 및 설계
│   └── API_DESIGN.md                 # API 설계 원칙
├── refactoring/                      # 리팩토링 관련 문서
│   ├── PLAN.md                       # 리팩토링 계획 및 로드맵
│   ├── LOG.md                        # 리팩토링 작업 로그
│   └── ANALYSIS.md                   # 코드 분석 리포트
├── guides/                           # 개발 가이드
│   ├── SETUP.md                      # 개발 환경 설정
│   ├── CODING_STYLE.md               # 코딩 스타일 가이드
│   ├── GIT_WORKFLOW.md               # Git 워크플로우
│   ├── SECURITY.md                   # 보안 가이드라인
│   └── TROUBLESHOOTING.md            # 문제 해결 가이드
└── api/                              # API 문서
    ├── ENDPOINTS.md                  # API 엔드포인트 목록
    ├── AUTHENTICATION.md             # 인증 및 권한
    └── EXAMPLES.md                   # API 사용 예제
```

## 📖 주요 문서

### 시작하기
- [개발 환경 설정](guides/SETUP.md) - 프로젝트 설정 및 실행 방법
- [시스템 아키텍처](architecture/OVERVIEW.md) - 전체 시스템 구조 이해
- [코딩 스타일 가이드](guides/CODING_STYLE.md) - 코드 작성 규칙

### 개발
- [API 문서](api/ENDPOINTS.md) - REST API 엔드포인트 레퍼런스
- [데이터베이스 스키마](architecture/DATABASE.md) - DB 구조 및 관계
- [문제 해결](guides/TROUBLESHOOTING.md) - 자주 발생하는 문제 해결법

### 리팩토링
- [리팩토링 계획](refactoring/PLAN.md) - 개선 로드맵
- [리팩토링 로그](refactoring/LOG.md) - 변경 이력
- [코드 분석](refactoring/ANALYSIS.md) - 현재 코드베이스 분석

## 🔄 문서 업데이트 규칙

1. **리팩토링 시**: 변경 사항을 `refactoring/LOG.md`에 기록
2. **API 변경 시**: `api/ENDPOINTS.md` 업데이트
3. **아키텍처 변경 시**: 관련 다이어그램 및 문서 갱신
4. **새로운 기능 추가 시**: 해당 가이드 문서 작성

## 📝 문서 작성 가이드

### 문서 작성 원칙
- **명확성**: 기술 용어는 쉽게 설명
- **최신성**: 코드 변경 시 즉시 업데이트
- **완결성**: 독립적으로 이해 가능하도록 작성
- **예제 포함**: 코드 예제와 스크린샷 활용

### 마크다운 스타일
```markdown
# H1: 문서 제목 (한 문서에 한 개만)
## H2: 주요 섹션
### H3: 하위 섹션

- 리스트 사용
- 코드 블록 활용
- 테이블로 정보 정리
```

## 🔗 외부 리소스

- [프로젝트 README](../README.md)
- [데이터베이스 스키마](../DATABASE_SCHEMA.md)
- [MySQL 호환성 노트](../MYSQL_COMPATIBILITY_NOTES.md)

## 📅 문서 이력

| 날짜 | 버전 | 변경 내용 | 작성자 |
|------|------|----------|--------|
| 2025-12-11 | 1.0 | 문서 구조 초기 생성 | Claude Code |

## 📧 문의

문서 관련 질문이나 개선 제안은 프로젝트 관리자에게 문의하세요.