09b3cf8e65
- docs/README.md 전면 개편 (문서 인덱스, 구조 설명) - 31개 페이지 종합 검토 보고서 작성 - 이모지 사용, 사이드바 불일치, 인라인 스타일 등 문제점 식별 주요 발견: - 이모지 300개+ 사용 (CODING_GUIDE 위반) - 27/31 페이지에서 이모지 사용 - admin/ 6개 페이지 사이드바 HTML 직접 작성 (중복) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
TK-FB-Project 문서 가이드
최종 업데이트: 2026-02-02 버전: 2.0.0
이 문서는 TK-FB-Project의 모든 개발 문서를 안내합니다.
📚 문서 구조 개요
TK-FB-Project/
├── CODING_GUIDE.md # [메인] 통합 개발 가이드 (필독)
├── DEV_LOG.md # [메인] 개발 진행 현황
├── CHECKLIST.md # 프로젝트 체크리스트
│
├── docs/ # 상세 문서
│ ├── README.md # (이 파일) 문서 인덱스
│ ├── standards/ # 표준 문서
│ ├── guides/ # 개발 가이드
│ ├── features/ # 기능별 문서
│ └── architecture/ # 아키텍처 문서
│
├── 개발 log/ # 일별 개발 로그 (2025-12 ~ )
├── 개발로그/ # 일별 개발 로그 (2026-01)
│ # ⚠️ 두 폴더 통합 예정
│
└── _archive/ # 레거시 문서 (참고용)
🎯 필독 문서 (Quick Start)
| 순서 | 문서 | 설명 | 대상 |
|---|---|---|---|
| 1 | CODING_GUIDE.md | 프로젝트 실행, 코딩 규칙, API 개발 | 모든 개발자 |
| 2 | DEV_LOG.md | 최근 개발 현황 및 변경사항 | 모든 개발자 |
| 3 | guides/SETUP.md | 개발 환경 상세 설정 | 신규 개발자 |
📁 문서 분류
1. 표준 문서 (Standards)
프로젝트 전반에 적용되는 규칙과 표준입니다.
| 문서 | 설명 | 상태 |
|---|---|---|
| DOCUMENTATION_STANDARD.md | 문서 작성 표준 | ✅ 현행 |
| ADMIN_PAGE_STANDARD.md | 관리 페이지 개발 표준 | ✅ 현행 |
| guides/CODING_STYLE.md | JavaScript/HTML/CSS 코딩 스타일 | ✅ 현행 |
2. 개발 가이드 (Guides)
특정 기능이나 작업에 대한 상세 가이드입니다.
| 문서 | 설명 | 상태 |
|---|---|---|
| guides/SETUP.md | 개발 환경 설정 | ✅ 현행 |
| guides/work-report-time-input-guide.md | 작업보고서 시간 입력 UX | ✅ 현행 |
| TBM_DEPLOYMENT_GUIDE.md | TBM 시스템 배포/사용 가이드 | ✅ 현행 |
3. 아키텍처 문서 (Architecture)
시스템 구조와 설계에 대한 문서입니다.
| 문서 | 설명 | 상태 |
|---|---|---|
| architecture/OVERVIEW.md | 시스템 아키텍처 개요 | ⚠️ 업데이트 필요 |
| _archive/DATABASE_SCHEMA.md | 데이터베이스 스키마 | 📦 아카이브 |
4. 개발 로그 (Development Logs)
일별/주제별 개발 진행 기록입니다.
📅 최근 로그 (2026년)
| 날짜 | 제목 | 주요 내용 |
|---|---|---|
| 01-28 | 설비 관리 시스템 | 설비 CRUD, 작업장 연동 |
| 01-27 | 시간 입력 UX 개선 | 터치 최적화 시간 선택 |
| 01-20 | UI 표준화 Phase 1 | 디자인 시스템, 템플릿 |
| 01-20 | 페이지 구조 재설계 | 폴더 구조 변경 |
| 01-19 | 작업자-계정 연동 | 계정 통합 기능 |
📅 이전 로그 (2025년)
| 날짜 | 제목 | 주요 내용 |
|---|---|---|
| 12-09 | 초기 개발 | 프로젝트 초기 설정 |
5. 아카이브 (Archive)
더 이상 사용하지 않거나 참고용 문서입니다.
| 문서 | 설명 | 비고 |
|---|---|---|
| _archive/README.md | 레거시 시작 가이드 | CODING_GUIDE.md로 대체 |
| _archive/TESTING_GUIDE.md | 테스트 작성 가이드 | Jest 테스트 참고용 |
| _archive/룰.md | 초기 개발 규칙 | CODING_GUIDE.md로 대체 |
| _archive/DELETED_PAGES.md | 삭제된 페이지 기록 | 히스토리 참고 |
| _archive/DELETED_TABLES.md | 삭제된 테이블 기록 | 히스토리 참고 |
📋 문서 중복 안내
일부 내용이 여러 문서에 중복되어 있습니다. Primary Source를 참고하세요.
| 주제 | Primary Source | Secondary (요약) |
|---|---|---|
| 개발 환경 설정 | guides/SETUP.md | CODING_GUIDE.md 실행 가이드 섹션 |
| 코딩 컨벤션 | guides/CODING_STYLE.md | CODING_GUIDE.md 코딩 컨벤션 섹션 |
| 페이지 구조 | CODING_GUIDE.md | - |
| DB 스키마 | CHECKLIST.md | _archive/DATABASE_SCHEMA.md |
🌐 웹 UI 페이지 구조
페이지 현황 (31개)
web-ui/pages/
├── dashboard.html # 메인 대시보드
│
├── work/ # 작업 관리 (4개)
│ ├── tbm.html # TBM 관리
│ ├── report-create.html # 작업보고서 작성
│ ├── report-view.html # 작업보고서 조회
│ └── analysis.html # 작업 분석
│
├── safety/ # 안전 관리 (7개)
│ ├── management.html # 안전 관리
│ ├── training-conduct.html # 안전교육 진행
│ ├── checklist-manage.html # 체크리스트 관리
│ ├── issue-report.html # 이슈 신고
│ ├── issue-list.html # 이슈 목록
│ ├── issue-detail.html # 이슈 상세
│ └── visit-request.html # 출입 신청
│
├── attendance/ # 근태 관리 (8개)
│ ├── daily.html # 일일 출퇴근
│ ├── monthly.html # 월간 근태
│ ├── vacation-request.html # 휴가 신청
│ ├── vacation-approval.html # 휴가 승인
│ ├── vacation-input.html # 휴가 직접 입력
│ ├── vacation-management.html # 휴가 관리
│ ├── vacation-allocation.html # 휴가 발생 입력
│ └── annual-overview.html # 연간 휴가 현황
│
├── admin/ # 시스템 관리 (9개)
│ ├── accounts.html # 계정 관리
│ ├── page-access.html # 권한 관리
│ ├── workers.html # 작업자 관리
│ ├── projects.html # 프로젝트 관리
│ ├── tasks.html # 작업 관리
│ ├── workplaces.html # 작업장 관리
│ ├── equipments.html # 설비 관리
│ ├── codes.html # 코드 관리
│ └── attendance-report.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 |
개발 로그 작성 규칙
# YYYY-MM-DD 개발 로그
## 개요
- 간단한 작업 요약
## 변경 사항
### 1. [기능명]
- 변경 내용 상세
- 관련 파일: `path/to/file.js`
## 테스트
- [ ] 테스트 항목
## 다음 작업
- 후속 작업 목록
📧 문의
문서 관련 질문이나 개선 제안은 프로젝트 관리자에게 문의하세요.