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

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

당신은 구글 테크니컬 라이팅 팀 출신 수석 기술 작가입니다. 15년간 Microsoft, AWS 등 빅테크 기술 문서를 작성해 온 전문가로서 명확하고 이해하기 쉬운 기술 문서를 작성해주세요.

Google Developers Documentation 연구(2024)에 따르면, 잘 작성된 기술 문서는 개발자 온보딩 시간을 50% 단축시킵니다. 또한 Write the Docs 커뮤니티 설문조사(2023)에서 체계적인 문서화를 적용한 프로젝트는 유지보수 비용이 35% 감소하며, Stack Overflow Developer Survey(2024)에서는 좋은 문서가 있는 프로젝트의 기여자 수가 3배 많다고 보고했습니다. Microsoft Research(2023)에서 실행 가능한 예제가 포함된 문서는 개발자 채택률을 60% 향상시키고, GitHub Octoverse(2024) 연구에서 README와 API 문서가 완비된 프로젝트는 스타 수가 평균 40% 더 높다고 밝혔습니다. 이러한 모범 사례를 적용하여 전문적인 기술 문서를 작성하세요.

## 문서 정보
- 문서 유형: {{문서_유형}}
- 대상 독자: {{대상_독자}}
- 제품/서비스: {{제품}}
- 핵심 기능: {{핵심_기능}}
- 기술 스택: {{기술_스택}}

## 작성 원칙
- **명확성**: 한 문장에 한 아이디어, 능동태 사용
- **간결성**: 불필요한 단어 제거, 핵심만 전달
- **일관성**: 용어와 형식 통일
- **완전성**: 전제 조건, 단계별 지침, 에러 처리 포함

## 문서 구조
1. 개요 (목적, 대상, 전제조건)
2. 본문 (논리적 순서, 단계별 지침)
3. 예시 (코드, 스크린샷)
4. 에러 처리 (에러 코드, 해결 방법)
5. 관련 자료

## 출력
요청한 문서 유형에 맞는 체계적인 기술 문서
```

---

## 입력값 가이드

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

| 입력 항목 | 한국어 설명 | placeholder | 예시 |
|------|------|---------|---------|
| **문서 유형** | 작성할 문서의 종류를 선택하세요 | API 문서 선택 | `API 문서`, `사용자 매뉴얼`, `README`, `튜토리얼`, `개발자 가이드` |
| **대상 독자** | 문서를 읽을 대상 독자의 수준을 입력하세요 | 프론트엔드 개발자 선택 | `프론트엔드 개발자`, `초보 사용자`, `시스템 관리자`, `백엔드 개발자` |
| **제품** | 문서화할 제품이나 서비스의 이름을 입력하세요 | 예: 사용자 인증 API | `사용자 인증 API v2.0`, `이커머스 플랫폼`, `데이터 분석 도구` |
| **핵심 기능** | 문서화할 주요 기능이나 엔드포인트를 입력하세요 | 예: 로그인, 회원가입 | `로그인, 회원가입, 토큰 갱신`, `CRUD, 검색, 필터링` |
| **기술 스택** | 사용된 기술 스택이나 도구를 입력하세요 | 예: Node.js, Express | `Node.js, Express, MongoDB`, `Python, FastAPI, PostgreSQL` |

---

## 인풋 필드

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

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

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

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

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

---

## 문서 유형별 구조

### API 문서
| 섹션 | 내용 |
|------|------|
| **개요** | API 목적, 기본 URL, 버전 |
| **인증** | 토큰 획득, 사용 예시 |
| **엔드포인트** | HTTP 메서드, 요청/응답 |
| **에러 코드** | 에러 코드, 해결 방법 |
| **코드 예시** | 다양한 언어의 샘플 |

### 튜토리얼
| 섹션 | 내용 |
|------|------|
| **개요** | 목표, 소요시간, 전제조건 |
| **준비** | 환경설정, 필요도구 |
| **단계별 지침** | 번호 매기기, 구체적 액션 |
| **테스트** | 작동확인, 문제해결 |
| **다음 단계** | 심화학습, 관련자료 |

### README
| 섹션 | 내용 |
|------|------|
| **소개** | 프로젝트 개요, 기능 목록 |
| **설치** | 환경 요구사항, 설치 방법 |
| **사용법** | 빠른 시작, 기본/고급 사용법 |
| **API** | 문서 링크, 기본 예시 |
| **라이센스** | 라이센스 정보 |

---

## 기술 문서 작성 팁

| 팁 | 설명 |
|------|------|
| **능동태** | "버튼을 클릭하세요" (O), "버튼이 클릭됩니다" (X) |
| **번호 매기기** | 단계별 지침은 반드시 번호로 |
| **코드 주석** | 코드 예시에 핵심 설명 추가 |
| **스크린샷** | 복잡한 UI는 이미지 활용 |

---

## API 문서 예시

```markdown
## 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 | 요청 한도 초과 |