# TK-FB-Project 문서 가이드

> **최종 업데이트**: 2026-02-03
> **버전**: 2.1.0

이 문서는 TK-FB-Project의 모든 개발 문서를 안내합니다.

---

## 문서 구조 개요

```
TK-FB-Project/
├── CODING_GUIDE.md          # [메인] 통합 개발 가이드 (필독)
├── DEV_LOG.md               # [메인] 개발 진행 현황
├── CHECKLIST.md             # 프로젝트 체크리스트
│
├── docs/                    # 상세 문서
│   ├── README.md            # (이 파일) 문서 인덱스
│   ├── CLEANUP_TODO.md      # 문서 정리 체크리스트
│   ├── guides/              # 개발 가이드
│   └── architecture/        # 아키텍처 문서
│
├── 개발 log/                # 일별 개발 로그
│
└── _archive/                # 레거시 문서 (참고용)
```

---

## 필독 문서 (Quick Start)

| 순서 | 문서 | 설명 | 대상 |
|:---:|------|------|------|
| 1 | [CODING_GUIDE.md](../CODING_GUIDE.md) | 프로젝트 실행, 코딩 규칙, API 개발 | 모든 개발자 |
| 2 | [DEV_LOG.md](../DEV_LOG.md) | 최근 개발 현황 및 변경사항 | 모든 개발자 |
| 3 | [guides/SETUP.md](guides/SETUP.md) | 개발 환경 상세 설정 | 신규 개발자 |
| 4 | [SECURITY_GUIDE.md](SECURITY_GUIDE.md) | 보안 취약점 및 개발 가이드 | 모든 개발자 |

---

## 문서 분류

### 1. 표준 문서 (Standards)

| 문서 | 설명 |
|------|------|
| [DOCUMENTATION_STANDARD.md](DOCUMENTATION_STANDARD.md) | 문서 작성 표준 |
| [ADMIN_PAGE_STANDARD.md](ADMIN_PAGE_STANDARD.md) | 관리 페이지 개발 표준 |
| [guides/CODING_STYLE.md](guides/CODING_STYLE.md) | JavaScript/HTML/CSS 코딩 스타일 |

### 2. 개발 가이드 (Guides)

| 문서 | 설명 |
|------|------|
| [guides/SETUP.md](guides/SETUP.md) | 개발 환경 설정 |
| [guides/work-report-time-input-guide.md](guides/work-report-time-input-guide.md) | 작업보고서 시간 입력 UX |
| [TBM_DEPLOYMENT_GUIDE.md](TBM_DEPLOYMENT_GUIDE.md) | TBM 시스템 배포/사용 가이드 |
| [SECURITY_GUIDE.md](SECURITY_GUIDE.md) | **보안 가이드 (필독)** - 취약점 분석 및 보안 개발 가이드 |

### 3. 아키텍처 문서 (Architecture)

| 문서 | 설명 | 상태 |
|------|------|:----:|
| [architecture/OVERVIEW.md](architecture/OVERVIEW.md) | 시스템 아키텍처 개요 | 업데이트 필요 |

---

## 웹 UI 페이지 구조 (35개)

```
web-ui/pages/
├── dashboard.html              # 메인 대시보드
│
├── work/                       # 작업 관리 (5개)
│   ├── tbm.html               # TBM 관리
│   ├── report-create.html     # 작업보고서 작성
│   ├── report-view.html       # 작업보고서 조회
│   ├── nonconformity.html     # 부적합 현황
│   └── analysis.html          # 작업 분석
│
├── [일간작업장 점검]            # 일간작업장 점검 (2개)
│   ├── attendance/checkin.html    # 출근 체크
│   └── attendance/work-status.html # 근무 현황
│
├── safety/                     # 안전 관리 (5개)
│   ├── report.html            # 신고 (공통)
│   ├── report-status.html     # 안전신고 현황
│   ├── issue-detail.html      # 이슈 상세
│   ├── visit-request.html     # 출입 신청
│   └── management.html        # 안전 관리
│
├── attendance/                 # 근태 관리 (7개)
│   ├── monthly.html           # 월간 근태
│   ├── vacation-request.html  # 휴가 신청
│   ├── vacation-approval.html # 휴가 승인
│   ├── vacation-input.html    # 휴가 직접 입력
│   ├── vacation-management.html # 휴가 관리
│   ├── vacation-allocation.html # 휴가 발생 입력
│   └── annual-overview.html   # 연간 휴가 현황
│
├── admin/                      # 시스템 관리 (12개)
│   ├── accounts.html          # 계정 관리
│   ├── page-access.html       # 권한 관리
│   ├── workers.html           # 작업자 관리
│   ├── projects.html          # 프로젝트 관리
│   ├── tasks.html             # 작업 관리
│   ├── workplaces.html        # 작업장 관리
│   ├── equipments.html        # 설비 관리
│   ├── codes.html             # 코드 관리
│   ├── issue-categories.html  # 신고 카테고리 관리
│   ├── attendance-report.html # 출퇴근-보고서 대조
│   ├── checklist-manage.html  # 체크리스트 관리
│   └── training-conduct.html  # 안전교육 진행
│
└── profile/                    # 개인 설정 (2개)
    ├── info.html              # 내 정보
    └── password.html          # 비밀번호 변경
```

---

## 문서 업데이트 규칙

### 언제 업데이트하나요?

| 상황 | 업데이트 대상 |
|------|--------------|
| 새 기능 추가 | DEV_LOG.md + 해당 기능 문서 |
| 버그 수정 | DEV_LOG.md |
| 코딩 규칙 변경 | CODING_GUIDE.md + guides/CODING_STYLE.md |
| 페이지 추가/삭제 | CODING_GUIDE.md 페이지 구조 섹션 |
| DB 스키마 변경 | CHECKLIST.md |

---

## 문서 정리

문서 정리가 필요한 항목은 [CLEANUP_TODO.md](CLEANUP_TODO.md)를 참고하세요.