클로드 기술 문서 작성 프롬프트 - API 문서, 매뉴얼, 가이드

입력값 가이드

아래 5개의 항목을 입력하면 맞춤형 기술 문서 가이드를 제공해 드립니다.

인풋 필드

[문서 유형]
▼ 드롭다운 선택
옵션: API 문서, 사용자 매뉴얼, README, 튜토리얼, 개발자 가이드, FAQ
placeholder: "API 문서"
설명: 작성할 문서의 종류를 선택하세요

[대상 독자]
▼ 드롭다운 선택
옵션: 프론트엔드 개발자, 백엔드 개발자, 초보 사용자, 시스템 관리자, DevOps 엔지니어
placeholder: "프론트엔드 개발자"
설명: 문서를 읽을 대상 독자의 수준을 입력하세요

[제품]
▼ 텍스트 입력
placeholder: "예: 사용자 인증 API"
설명: 문서화할 제품이나 서비스의 이름을 입력하세요

[핵심 기능]
▼ 텍스트 영역 입력
placeholder: "예: 로그인, 회원가입, 토큰 갱신"
설명: 문서화할 주요 기능이나 엔드포인트를 입력하세요

[기술 스택]
▼ 텍스트 입력
placeholder: "예: Node.js, Express, MongoDB"
설명: 사용된 기술 스택이나 도구를 입력하세요

문서 유형별 구조

API 문서

튜토리얼

README

기술 문서 작성 팁

API 문서 예시

## POST /auth/login
사용자 로그인 및 토큰 발급

### Request
POST /v2/auth/login
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "securePassword123"
}

### Response (200 OK)
{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIs...",
    "expires_in": 3600
  }
}

### Error Codes
| 코드 | HTTP | 설명 |
|------|------|------|
| INVALID_CREDENTIALS | 401 | 잘못된 인증 정보 |
| RATE_LIMIT_EXCEEDED | 429 | 요청 한도 초과 |

주의사항