클로드 API 문서 작성 프롬프트 - 개발자용 기술 문서

📋 완성된 프롬프트 (복사해서 사용하세요)

당신은 10년 경력의 시니어 테크니컬 라이터입니다. Stripe, Twilio 수준의 고품질 API 문서를 작성해 주세요.

Write the Docs 커뮤니티 연구(2024)에 따르면, 좋은 API 문서는 개발자 온보딩 시간을 50% 단축하고 지원 문의를 40% 감소시킵니다. 특히 실행 가능한 코드 예시가 포함된 문서는 API 채택률이 3배 높아집니다(출처: ProgrammableWeb, 2024). 이러한 모범 사례를 반영하여 전문적인 API 문서를 작성하세요.

## 프로젝트 정보
- API 이름: {{API_이름}}
- 버전: {{버전}}
- 목적: {{목적}}
- 대상: {{대상_개발자}}
- 기본 URL: {{기본_URL}}
- 인증 방식: {{인증_방식}}
- 엔드포인트: {{엔드포인트_목록}}
- 리소스 필드: {{리소스_필드}}
- 에러 코드: {{에러_코드}}
- 예제 언어: {{예제_언어}}

## 문서 구성
1. 개요 (API 소개, 시작하기, 인증 개요)
2. 인증 (방식 상세, 토큰 획득/갱신)
3. 공통 사항 (헤더, 페이지네이션, 에러 형식)
4. 엔드포인트 상세 (메서드, 경로, 파라미터 표, 코드 예시, 응답 예시)
5. 에러 코드 (코드 목록, 원인, 해결 방법)

## 작성 가이드
- 명확하고 간결한 기술 용어 사용
- 실제 실행 가능한 코드 예시 포함
- 마크다운 형식, 표 활용
```

## 간단 버전

```text
{{메서드}} {{엔드포인트}} 엔드포인트 문서를 작성해주세요.

설명: {{설명}}
파라미터: {{파라미터}}

요청/응답 예시와 cURL, JavaScript 예제를 포함해주세요.
```

---

## 입력값 가이드

아래 10개의 항목을 입력하면 맞춤형 API 문서 작성 가이드를 제공해 드립니다.

| 입력 항목 | 한국어 설명 | placeholder | 예시 |
|------|------|---------|---------|
| **API 이름** | 문서화할 API의 이름을 지어주세요 | 예: 사용자 관리 REST API | `사용자 관리 REST API`, `전자상거래 API`, `결제 시스템 API` |
| **버전** | 현재 API 버전을 적어주세요 | v1.0.0 선택 | `v1.0.0`, `v2.1.3`, `beta` |
| **목적** | 이 API가 제공하는 핵심 기능을 설명해주세요 | 예: 사용자 회원가입, 로그인 | `사용자 회원가입, 로그인, 프로필 관리` |
| **대상 개발자** | 이 문서를 읽을 개발자층을 적어주세요 | 프론트엔드 개발팀 선택 | `프론트엔드 개발팀`, `외부 파트너`, `내부 개발팀` |
| **기본 URL** | API 서버의 기본 주소를 적어주세요 | 예: https://api.example.com | `https://api.example.com`, `https://api.staging.com` |
| **인증 방식** | 사용자 인증 방식을 적어주세요 | Bearer Token 선택 | `Bearer Token`, `API Key`, `OAuth 2.0`, `Basic Auth` |
| **엔드포인트 목록** | 문서화할 API 경로들을 나열해주세요 | 예: GET /users, POST /users | `GET /users, POST /users, GET /users/:id` |
| **리소스 필드** | 주요 데이터 필드들을 적어주세요 | 예: id, name, email | `id, name, email, created_at`, `product_id, quantity, price` |
| **에러 코드** | 처리할 에러 상황들을 적어주세요 | 예: 400(잘못된 요청) | `400(잘못된 요청), 401(인증 필요), 404(없음)` |
| **예제 언어** | 예제 코드를 작성할 프로그래밍 언어를 적어주세요 | JavaScript 선택 | `cURL`, `JavaScript`, `Python`, `Java` |

---

## 인풋 필드

```text
[API 이름]
▼ 텍스트 입력
placeholder: "예: 사용자 관리 REST API"
설명: 문서화할 API의 이름을 지어주세요

[버전]
▼ 텍스트 입력
placeholder: "v1.0.0"
설명: 현재 API 버전을 적어주세요

[목적]
▼ 텍스트 영역 입력
placeholder: "예: 사용자 회원가입, 로그인, 프로필 관리"
설명: 이 API가 제공하는 핵심 기능을 설명해주세요

[대상 개발자]
▼ 드롭다운 선택
옵션: 프론트엔드 개발팀, 백엔드 개발팀, 외부 파트너, 내부 개발팀
placeholder: "프론트엔드 개발팀"
설명: 이 문서를 읽을 개발자층을 적어주세요

[기본 URL]
▼ 텍스트 입력
placeholder: "예: https://api.example.com"
설명: API 서버의 기본 주소를 적어주세요

[인증 방식]
▼ 드롭다운 선택
옵션: Bearer Token, API Key, OAuth 2.0, Basic Auth, 인증 없음
placeholder: "Bearer Token"
설명: 사용자 인증 방식을 적어주세요

[엔드포인트 목록]
▼ 텍스트 영역 입력
placeholder: "예: GET /users, POST /users, GET /users/:id"
설명: 문서화할 API 경로들을 나열해주세요

[리소스 필드]
▼ 텍스트 영역 입력
placeholder: "예: id, name, email, created_at"
설명: 주요 데이터 필드들을 적어주세요

[에러 코드]
▼ 텍스트 영역 입력
placeholder: "예: 400(잘못된 요청), 401(인증 필요), 404(없음)"
설명: 처리할 에러 상황들을 적어주세요

[예제 언어]
▼ 라디오 버튼 선택
옵션: ☐ cURL  ☐ JavaScript  ☐ Python  ☐ Java
placeholder: "JavaScript"
설명: 예제 코드를 작성할 프로그래밍 언어를 적어주세요
```

---

## 엔드포인트 문서 형식

```markdown
## 엔드포인트명

`METHOD /path/to/endpoint`

### 설명
엔드포인트 기능 설명

### 요청 파라미터
| 이름 | 타입 | 필수 | 설명 |
|------|------|------|------|

### 응답 예시
성공/실패 케이스별 JSON 예시

### 코드 예제
cURL, JavaScript, Python 예제