Files
sam-docs/INDEX.md
hskwon 08a8259313 docs: 5130 레거시 분석 문서 및 기존 문서 초기 커밋
- 5130 레거시 시스템 분석 (00_OVERVIEW ~ 08_SAM_COMPARISON)
- MES 프로젝트 문서
- API/프론트엔드 스펙 문서
- 가이드 및 레퍼런스 문서
2025-12-04 18:47:19 +09:00

5.5 KiB

SAM 프로젝트 문서 네비게이션

📌 Claude Code를 위한 문서 허브 - 작업별로 필요한 문서를 빠르게 찾아 컨텍스트에 추가하세요.


🚀 빠른 시작

문서 용도 크기
Quick Start Guide 프로젝트 핵심 규칙 요약 5KB
개발 환경 설정 Docker 환경 구축 7KB
개발 명령어 일상 개발 명령어 4KB

📖 개발 가이드

Reference (일상 참고 문서)

현재 작업에 필요한 참고 문서입니다.

Specs (환경/스펙 문서)

시스템 스펙과 환경 설정 문서입니다.

Features (기능별 문서)

특정 기능의 상세 문서입니다.

Guides (구현 가이드)

특정 기능 구현을 위한 매뉴얼입니다.

Frontend (프론트엔드 공유 문서)

프론트엔드 개발을 위한 API 연동 가이드입니다.


📁 프로젝트별 문서

MES 프로젝트

Legacy 5130


📚 히스토리

2025-11 문서

2025-09 문서

Roadmaps


🏗️ 서브프로젝트 문서

각 서브프로젝트는 독립적인 docs/ 디렉토리를 가지고 있습니다.

프로젝트 문서 경로 설명
API api/docs/INDEX.md REST API 프로젝트
Admin admin/docs/INDEX.md Filament 관리자 패널 (점차 deprecated)
MNG mng/docs/INDEX.md Plain Laravel 관리자 패널 (운영 주력)
React react/docs/[INDEX] DOCUMENTATION-MAP.md Next.js 프론트엔드

💡 사용 팁

Claude Code 작업 패턴

작업 참고 문서
API 개발 reference/api-rules.md + CLAUDE.md
DB 스키마 확인 specs/database-schema.md
품질 검증 reference/quality-checklist.md
과거 분석 검토 history/2025-11/item-master-gap-analysis.md
Swagger 작성 guides/swagger-guide.md + api/docs/swagger/
MES 개발 projects/mes/README.md

문서 네이밍 규칙

  • 소문자 + 하이픈 (kebab-case): api-rules.md
  • 날짜 포함 (히스토리): 2025-11-20-item-master-spec.md
  • 버전 표기: item-db-analysis-v3.md

📝 문서 작성 가이드

새 문서를 작성할 때:

  1. 크기 목표: 10KB 이하 (Claude Code 빠른 로딩)
  2. 명확한 제목: 내용을 정확히 반영
  3. 적절한 위치: reference/specs/history/guides/projects 중 선택
  4. INDEX 업데이트: 새 문서는 반드시 INDEX.md에 추가

🔄 문서 구조 변경 이력

  • 2025-11-20: 문서 구조 대규모 재정리
    • .cursor/docs 삭제
    • claudedocs → docs/ 체계화
    • Reference/Specs/History/Guides/Projects 분류
    • 각 서브프로젝트별 docs/ 디렉토리 생성