# Mintlify 기술 문서 작성 규칙
## 프로젝트 컨텍스트
- 이 프로젝트는 Mintlify 플랫폼의 문서 프로젝트입니다.
- YAML 프런트매터가 포함된 MDX 파일을 사용합니다.
- 내비게이션은 `docs.json`에서 구성됩니다.
- 기술 문서 작성의 베스트 프랙티스를 따릅니다.
## 작성 표준
- 지침에는 2인칭("여러분", "귀하")을 사용하세요.
- 능동태와 현재 시제로 작성하세요.
- 절차는 사전 요구 사항부터 시작하세요.
- 주요 단계에 대한 예상 결과를 포함하세요.
- 설명적이고 키워드가 풍부한 제목을 사용하세요.
- 문장은 간결하면서도 유익하게 유지하세요.
## 필수 페이지 구조
모든 페이지는 프런트매터로 시작해야 합니다:
```yaml
---
title: "명확하고 구체적인 제목"
description: "SEO 및 내비게이션을 위한 간결한 설명"
---
```
## Mintlify 컴포넌트
### 콜아웃(Callout)
- 유용한 보충 정보에는 `<Note>`를 사용합니다.
- 중요한 주의 사항 및 중대한 변경 사항에는 `<Warning>`을 사용합니다.
- 권장 사례 및 전문가의 조언에는 `<Tip>`을 사용합니다.
- 중립적인 문맥 정보에는 `<Info>`를 사용합니다.
- 성공 확인에는 `<Check>`를 사용합니다.
### 코드 예시
- 적절한 경우, 완전하고 실행 가능한 예시를 포함하세요.
- 여러 언어 예시에는 `<CodeGroup>`을 사용하세요.
- 모든 코드 블록에 언어 태그를 지정하세요.
- 플레이스홀더 대신 현실적인 데이터를 포함하세요.
- API 문서에는 `<RequestExample>` 및 `<ResponseExample>`을 사용하세요.
### 절차
- 순차적 지침에는 `<Steps>` 컴포넌트를 사용하세요.
- 관련이 있는 경우 `<Check>` 컴포넌트로 검증 단계를 포함하세요.
- 복잡한 절차는 더 작은 단계로 나눕니다.
### 콘텐츠 구성
- 플랫폼 전용 콘텐츠에는 `<Tabs>`를 사용하세요.
- 점진적 정보 공개에는 `<Accordion>`을 사용하세요.
- 콘텐츠 강조에는 `<Card>` 및 `<CardGroup>`을 사용하세요.
- 이미지는 설명적인 대체 텍스트와 함께 `<Frame>` 컴포넌트로 감쌉니다.
## API 문서 요구 사항
- 모든 매개변수를 `<ParamField>`로 문서화하세요.
- 응답 구조를 `<ResponseField>`로 보여주세요.
- 성공 및 오류 예시를 모두 포함하세요.
- 중첩된 객체 속성에는 `<Expandable>`을 사용하세요.
- 항상 인증 예시를 포함하세요.
## 품질 표준
- 게시 전 모든 코드 예시를 테스트하세요.
- 내부 링크에는 상대 경로를 사용하세요.
- 모든 이미지에 대체 텍스트를 포함하세요.
- 적절한 제목 계층 구조(h2부터 시작)를 보장하세요.
- 일관성을 위해 기존 패턴을 확인하세요.
