# SAM 프로젝트 문서

SAM ERP 시스템의 기술 문서, 비즈니스 규칙, 기능 명세를 관리하는 저장소입니다.

---

## 대상별 안내

### 전 팀 공유
누구나 참고할 수 있는 공통 문서입니다.

| 폴더 | 설명 | 예시 |
|------|------|------|
| **features/** | 기능별 상세 명세 | 견적, CRM, 문서관리, 인사, 재무 등 |
| **rules/** | 비즈니스 규칙·정책 | 품목 정책, 단가 정책, 채번 규칙, 청구 정책 |
| **projects/** | 프로젝트별 자료 | MES, 5130 마이그레이션, 전자서명 등 |
| **system/** | 시스템 현황 | 아키텍처, DB 스키마, Docker, 인프라 |
| **resources.md** | 외부 자료 링크 | BI, 제품 소개서 등 대용량 자료 (노션 링크) |

### 개발팀 전용 (`dev/`)
개발 표준, 가이드, 변경 이력 등 개발자 대상 문서입니다.

| 폴더 | 설명 | 예시 |
|------|------|------|
| **dev/standards/** | 개발 표준 | API 규칙, Git 컨벤션, 품질 체크리스트 |
| **dev/guides/** | 구현 가이드 | Swagger 작성법, 파일 저장, Jenkins 설정 |
| **dev/quickstart/** | 빠른 시작 | 개발 명령어, 퀵스타트 가이드 |
| **dev/changes/** | 변경 이력 | 날짜별 변경 내용 기록 |
| **dev/deploys/** | 배포·운영 | 운영 매뉴얼, 배포 SQL |
| **dev/data/** | 데이터 분석 | BOM 매핑 분석, 견적 데이터 |
| **dev/history/** | 과거 이력 | 월별 히스토리, 로드맵 |
| **dev/dev_plans/** | 개발 계획 | 작업별 계획 문서 (개인 작업용, 정리 후 폐기 가능) |

### 프론트엔드 전용 (`frontend/`)
프론트엔드 개발자 대상 문서입니다.

| 폴더 | 설명 | 예시 |
|------|------|------|
| **frontend/api-specs/** | API 연동 명세 | 문서 API 연동 가이드 |
| **frontend/integration/** | 프론트-백엔드 연동 | 연동 패턴, 주의사항 |

### 기획팀 (`requests/`)
기획 요청 및 확인 문서입니다.

| 폴더 | 설명 | 예시 |
|------|------|------|
| **requests/** | 기획 확인 요청 | 기획서 검토 요청, 워크플로우 공유 |

---

## 폴더 구조

```
docs/
├── features/          # [공유] 기능별 상세 명세
│   ├── quotes/        #   견적 시스템
│   ├── sales/         #   영업/수주
│   ├── documents/     #   문서관리
│   ├── finance/       #   재무/회계
│   ├── hr/            #   인사관리
│   ├── crm/           #   고객관리
│   ├── esign/         #   전자서명
│   ├── equipment/     #   설비관리
│   ├── boards/        #   게시판
│   ├── ai/            #   AI 기능
│   └── ...
│
├── rules/             # [공유] 비즈니스 규칙
│   ├── item-policy.md
│   ├── pricing-policy.md
│   ├── numbering-rules.md
│   └── ...
│
├── projects/          # [공유] 프로젝트별 자료
│   ├── mes/
│   ├── 5130-migration/
│   ├── e-sign/
│   └── ...
│
├── system/            # [공유] 시스템 현황
│   ├── overview.md
│   ├── database/
│   ├── docker-setup.md
│   └── ...
│
├── resources.md       # [공유] 외부 자료 링크 (노션)
│
├── dev/               # [개발팀] 개발 전용
│   ├── standards/     #   개발 표준
│   ├── guides/        #   구현 가이드
│   ├── quickstart/    #   빠른 시작
│   ├── changes/       #   변경 이력
│   ├── deploys/       #   배포/운영
│   ├── data/          #   데이터 분석
│   ├── history/       #   과거 이력
│   └── dev_plans/     #   개발 계획 (개인 작업용)
│
├── frontend/          # [프론트엔드] 프론트 전용
│   ├── api-specs/     #   API 연동 명세
│   └── integration/   #   연동 가이드
│
├── requests/          # [기획팀] 기획 요청
│
├── README.md          # 이 문서 (사람용 안내)
├── INDEX.md           # Claude Code용 문서 인덱스
└── TODO.md
```

---

## 문서 작성 규칙

### 파일 이름
- 영문 소문자, 하이픈(`-`) 구분: `item-policy.md`
- 변경 이력: `YYYYMMDD_설명.md` (예: `20260305_login_fix.md`)
- 한글 파일명 허용 (가이드 등 내부 문서)

### 문서 구조
- 모든 MD 파일은 `# 제목`으로 시작
- 폴더에 파일이 3개 이상이면 `README.md`로 목차 제공
- 이미지/대용량 파일은 노션에 업로드하고 `resources.md`에 링크 추가

### 폴더 관리
- **공유 폴더**: 전 팀이 수정 가능, 변경 시 관련 팀에 공유
- **dev/**: 개발팀만 수정
- **frontend/**: 프론트엔드 팀만 수정 (API 명세는 개발팀이 제공)
- **requests/**: 기획팀이 작성, 개발팀이 확인
- **dev/dev_plans/**: 개인 작업용, 완료 후 archive/ 이동 또는 삭제