CLAUDE.md의 올바른 사용법
CLAUDE.md의 올바른 사용법
CLAUDE.md는 프로젝트 루트 디렉토리에 위치하는 특수한 파일로, AI 도우미(예: Claude)에게 프로젝트에 대한 핵심 정보를 알려주는 데 사용됩니다. 이 파일을 잘 작성하면 AI가 프로젝트를 더 잘 이해하고 도와줄 수 있습니다.
CLAUDE.md가 왜 필요할까요?
새로운 동료가 왔을 때, 그가 당신의 프로젝트를 이해하는 데 얼마나 많은 시간이 걸릴지 상상해 보세요. CLAUDE.md는 바로 그 "프로젝트 설명서"와 같아서 AI가 빠르게 시작할 수 있도록 돕습니다.
CLAUDE.md의 5가지 핵심 내용
1. 프로젝트 개요
이 프로젝트가 무엇을 하는지, 어떤 문제를 해결하는지, 어떤 사용자를 대상으로 하는지 간단하게 설명합니다.
# 프로젝트 개요 이것은 상품, 주문 및 사용자를 관리하기 위한 전자 상거래 백엔드 관리 시스템입니다.
2. 기술 스택
프로젝트에서 사용되는 주요 기술과 프레임워크를 나열합니다.
`# 기술 스택
- 프론트엔드: React + TypeScript
- 백엔드: Node.js + Express
- 데이터베이스: PostgreSQL
- 배포: Docker + Kubernetes`
3. 파일 구조
주요 디렉토리의 역할을 설명합니다.
# 파일 구조 /src /components - UI 컴포넌트 /pages - 페이지 /utils - 유틸리티 함수 /api - API 호출
4. 자주 사용하는 명령어
개발 중에 자주 사용하는 명령어를 나열합니다.
# 자주 사용하는 명령어 npm run dev - 개발 서버 시작 npm run build - 프로덕션 버전 빌드 npm run test - 테스트 실행
5. 규칙
AI가 코드를 작성할 때 준수해야 할 규칙을 정의합니다.
`# 코딩 규칙
- 함수형 컴포넌트 사용
- ESLint 설정 준수
- 컴포넌트 이름은 PascalCase 사용
- 변수 이름은 camelCase 사용`
완전한 예시
`# 프로젝트 이름: Task Manager
프로젝트 개요
간단한 작업 관리 애플리케이션으로, 작업 생성, 편집, 삭제 및 분류를 지원합니다.
기술 스택
- React 18
- TypeScript
- Tailwind CSS
- Vite
파일 구조
/src /components - UI 컴포넌트 /hooks - 사용자 정의 Hooks /types - TypeScript 타입 정의 /utils - 유틸리티 함수
자주 사용하는 명령어
- npm run dev: 개발 서버 시작
- npm run build: 프로덕션 버전 빌드
- npm run lint: 코드 검사
코딩 규칙
- 컴포넌트는 함수형으로 작성
- Tailwind CSS를 사용하여 스타일 지정
- 각 컴포넌트는 별도의 폴더에 배치`
팁
- 간결하게 유지: 너무 길게 쓰지 마세요. AI도 "지쳐요".
- 정기적으로 업데이트: 프로젝트가 변경되면 CLAUDE.md를 업데이트하는 것을 잊지 마세요.
- 예시 우선: 추상적인 설명보다 구체적인 코드 예시가 더 효과적입니다.
- 문제점에 집중: 오류가 발생하기 쉬운 부분을 중점적으로 설명합니다.
CLAUDE.md를 잘 작성하여 AI를 든든한 조력자로 만드세요!
