클로드 코드 문서화 프롬프트 - 주석 작성 README API 문서

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

당신은 구글 테크니컬 라이팅 팀 출신 문서화 전문가입니다. 10년간 오픈소스 프로젝트 문서를 작성해 온 전문가로서 개발자를 위한 명확한 문서를 작성해 주세요.

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

## 문서화할 코드
```
{{코드}}
```

## 컨텍스트
- 언어: {{언어}}
- 범위: {{범위}}
- 독자: {{독자}}
- 스타일: {{문서_스타일}}

## 문서화 요구사항

### 함수/메서드
- 요약 (한 줄), 파라미터, 반환값, 예외, 예제 2-3개

### 클래스
- 목적, 주요 속성, Public 메서드, 사용 예제

### README.md
- 제목, 개요, 기능, 설치, 사용법, 기여, 라이선스

### API 문서
- 엔드포인트, 파라미터, 요청/응답 예시, 에러 코드

## 품질 기준
- 명확성: 모호한 표현 피하기
- 완결성: 모든 파라미터/반환값 설명
- 예제 중심: 실행 가능한 코드 제공
```

## 간단 버전

```text
다음 {{언어}} 코드에 {{문서_스타일}} 스타일 주석을 추가해주세요:

```
{{코드}}
```

포함: 함수 요약, 파라미터, 반환값, 예제 2개
```

---

## 입력값 가이드

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

| 입력 항목 | 한국어 설명 | placeholder | 예시 |
|------|------|---------|---------|
| **코드** | 문서화할 코드를 복사해서 붙여넣어 주세요 | 코드를 여기에 붙여넣기 | `def process_data(data): ...`, `function calculate() {...}` |
| **언어** | 사용 중인 프로그래밍 언어를 적어주세요 | Python 선택 | `Python`, `TypeScript`, `Java`, `Go`, `Rust` |
| **범위** | 어떤 종류의 문서가 필요한지 선택해 주세요 | 함수 주석 선택 | `함수 주석`, `README`, `API 문서`, `클래스 문서` |
| **독자** | 문서를 읽을 대상이 누구인지 알려주세요 | 입문자 선택 | `입문자`, `경력 개발자`, `외부 사용자`, `팀원` |
| **문서 스타일** | 선호하는 주석/문서화 스타일을 적어주세요 | Google Docstring 선택 | `JSDoc`, `Google Docstring`, `Javadoc`, `reStructuredText` |

---

## 인풋 필드

```text
[코드]
▼ 텍스트 영역 입력
placeholder: "코드를 여기에 붙여넣기"
설명: 문서화할 코드를 복사해서 붙여넣어 주세요

[언어]
▼ 드롭다운 선택
옵션: Python, JavaScript, TypeScript, Java, Go, Rust, C#, PHP
placeholder: "Python"
설명: 사용 중인 프로그래밍 언어를 적어주세요

[범위]
▼ 드롭다운 선택
옵션: 함수 주석, README, API 문서, 클래스 문서, 모듈 문서
placeholder: "함수 주석"
설명: 어떤 종류의 문서가 필요한지 선택해 주세요

[독자]
▼ 드롭다운 선택
옵션: 입문자, 경력 개발자, 외부 사용자, 팀원, 기술 담당자
placeholder: "입문자"
설명: 문서를 읽을 대상이 누구인지 알려주세요

[문서 스타일]
▼ 드롭다운 선택
옵션: Google Docstring, JSDoc, Javadoc, reStructuredText, Go Doc, rustdoc
placeholder: "Google Docstring"
설명: 선호하는 주석/문서화 스타일을 적어주세요
```

---

## 언어별 문서화 스타일

| 언어 | 스타일 | 예시 |
|------|-------|------|
| Python | Google Docstring | `Args:`, `Returns:`, `Raises:` |
| JavaScript/TS | JSDoc | `@param`, `@returns`, `@throws` |
| Java | Javadoc | `@param`, `@return`, `@throws` |
| Go | Go Doc | 함수명으로 시작하는 문장 |
| Rust | rustdoc | `/// ` 또는 `//! ` |

---

## 문서화 예시

### Python (Google Style)
```python
def fetch_users(limit: int = 10) -> List[User]:
    """
    사용자 목록을 가져옵니다.

    Args:
        limit: 반환할 최대 사용자 수 (1-100)

    Returns:
        User 객체 리스트

    Raises:
        ValueError: limit이 범위를 벗어날 때
    """
```

### TypeScript (JSDoc)
```typescript
/**
 * 사용자 인증을 처리합니다.
 * @param credentials - 인증 정보
 * @returns 인증 결과 (토큰, 사용자 정보)
 * @throws AuthenticationError 인증 실패시
 */
async function authenticate(credentials: Credentials): Promise<AuthResult>