Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 3.27 KB

File metadata and controls

59 lines (44 loc) · 3.27 KB

StackUp 문서 인덱스

이 디렉토리는 레이어 비종속(cross-cutting) 문서를 보관한다. 각 레이어 내부 규약은 해당 레이어의 CLAUDE.md를 참고한다.


1. 횡단 관심사 문서

제품·아키텍처

데이터·계약

디자인·프론트엔드

  • design-system.md — 토큰, 컬러, 타이포그래피, 컴포넌트 인벤토리
  • ui-patterns.md — 반복되는 UX 패턴, 상태 처리 (loading/empty/error)
  • frontend-types.md — TypeScript 타입 네이밍·레이어별 흐름·정의 위치

보안·운영

협업


2. 레이어별 진입점 (CLAUDE.md)

레이어 진입 문서 역할
루트 /CLAUDE.md 전체 오버뷰 + 인덱스
프론트 /frontend/CLAUDE.md React/FSD 구조
백엔드 /backend/CLAUDE.md Spring Boot Core 서버
AI /ai/CLAUDE.md FastAPI/LangChain 서버
인프라 /infra/CLAUDE.md Docker Compose, PG/RabbitMQ/MinIO

각 레이어 하위 디렉토리에도 슬라이스/도메인별 CLAUDE.md가 존재할 수 있다. 작업할 디렉토리에서 가장 가까운 CLAUDE.md를 우선 참고한다.


3. 문서 작성 원칙

  1. 단일 출처 원칙(Single Source of Truth): 같은 정보를 두 곳에 쓰지 않는다. 다른 문서를 링크로 참조한다.
  2. 레이어 종속성 방향: 횡단 관심사 → 레이어 → 슬라이스. 상위 문서는 하위를 모르고, 하위는 상위를 참조한다.
  3. 변경 시 함께 갱신: 코드 변경이 컨벤션·아키텍처·DB 스키마에 영향을 주면 해당 문서도 같은 PR에 포함한다.
  4. 예시 우선: 추상적 설명보다 실제 코드 스니펫·DDL·요청 예시로 보여준다.
  5. 한국어 우선: 도메인 용어는 한국어로, 기술 용어·식별자(클래스명·테이블명·ENUM)는 영문 그대로 둔다.