메인 콘텐츠로 건너뛰기
Claude Code는 Anthropic의 공식 CLI 도구입니다. 이 가이드는 문서를 작성하고 유지 관리하는 데 도움이 되도록 Claude Code를 설정하는 과정을 안내합니다.

사전 요구 사항

  • 활성 Claude 구독 (Pro, Max 또는 API 액세스 권한)

설정

  1. Claude Code를 전역으로 설치합니다:
npm install -g @anthropic-ai/claude-code
  1. 문서 디렉토리로 이동합니다.
  2. (선택 사항) 프로젝트에 아래의 CLAUDE.md 파일을 추가합니다.
  3. claude를 실행하여 시작합니다.

CLAUDE.md 생성

Claude Code가 특정 문서 작성 표준을 학습할 수 있도록 문서 리포지토리의 루트에 CLAUDE.md 파일을 생성하세요:
# Mintlify 문서

## 협업 관계
- 아이디어에 대해 이의를 제기할 수 있습니다. 이는 더 나은 문서로 이어질 수 있습니다. 이의를 제기할 때는 출처를 인용하고 이유를 설명하세요.
- 추측하기보다는 항상 명확한 설명을 요청하세요.
- 정보를 거짓으로 꾸며내거나 짐작하여 답변하지 마세요.

## 프로젝트 컨텍스트
- 형식: YAML 프런트매터가 포함된 MDX 파일
- 설정: 내비게이션, 테마, 설정을 위한 docs.json
- 컴포넌트: Mintlify 컴포넌트

## 콘텐츠 전략
- 사용자의 성공을 위해 딱 필요한 만큼만 작성하세요. 너무 많지도, 적지도 않게 작성하는 것이 중요합니다.
- 정보의 정확성과 가독성을 최우선으로 합니다.
- 가능한 한 영구적(Evergreen)인 콘텐츠를 만드세요.
- 새로운 내용을 추가하기 전에 기존 정보를 먼저 검색하세요. 전략적인 이유가 없는 한 중복 작성을 피하세요.
- 일관성을 위해 기존 패턴을 확인하세요.
- 합리적인 범위 내에서 가장 작은 변화부터 시작하세요.

## 페이지 프런트매터 요구 사항
- title: 명확하고 설명적인 페이지 제목
- description: SEO 및 내비게이션을 위한 간결한 요약

## 작성 표준
- 2인칭 시점("여러분", "귀하" 또는 문맥에 따른 생략) 사용
- 절차형 콘텐츠 시작 부분에 사전 요구 사항 기재
- 게시 전 모든 코드 예시 테스트
- 기존 페이지의 스타일과 포맷 일치
- 기본 및 고급 사용 사례 모두 포함
- 모든 코드 블록에 언어 태그 지정
- 모든 이미지에 대체 텍스트(Alt text) 추가
- 내부 링크에 상대 경로 사용

## Git 워크플로우
- 커밋 시 절대 `--no-verify`를 사용하지 마세요.
- 시작하기 전에 커밋되지 않은 변경 사항을 어떻게 처리할지 물어보세요.
- 변경 사항을 위한 명확한 브랜치가 없을 경우 새 브랜치를 생성하세요.
- 개발 과정 중에 자주 커밋하세요.
- pre-commit 훅을 건너뛰거나 비활성화하지 마세요.

## 금지 사항
- MDX 파일에서 프런트매터 누락
- 내부 링크에 절대 URL 사용
- 테스트되지 않은 코드 예시 포함
- 임의로 추측하기 - 항상 명확한 확인을 요청하세요.