언제 쓰나
코드는 다 짰는데 문서 작성이 미루어지고 있을 때.
팀원이나 외부 파트너에게 API를 공유해야 하는데 "어떻게 쓰는지 설명"이 없을 때.
오래전에 짠 코드를 다시 봐야 할 때 빠르게 문서화해 두고 싶을 때.
코드 → 문서 변환 흐름
flowchart LR
A["💻 코드\n함수·API 엔드포인트"] --> B["파싱 & 분석"]
B --> C["파라미터\n타입·필수여부·기본값"]
B --> D["반환값\n구조·타입"]
B --> E["예외·에러\n케이스"]
C & D & E --> F["문서 초안"]
F --> G["📖 인라인 주석\nJSDoc / docstring"]
F --> H["📄 Markdown\nREADME 형식"]
F --> I["🌐 OpenAPI\nSwagger 형식"]
프롬프트 (복사)
당신은 테크니컬 라이터입니다. 아래 코드를 바탕으로 개발자가 바로 쓸 수 있는 문서를 작성해 주세요.
**컨텍스트**
- 언어: [예: Python / TypeScript / Go]
- 문서 용도: [예: 팀 내부용 / 외부 API 문서 / 오픈소스 README]
- 출력 형식: [예: Markdown / JSDoc 주석 / OpenAPI YAML]
**코드**
[함수, 클래스, 또는 API 엔드포인트 코드 붙여 넣기]
---
다음 항목을 포함한 문서를 작성해 주세요.
**개요**
- 이 함수/API가 하는 일 (1~2문장, 기술 용어 최소화)
- 언제 쓰는지 (사용 시나리오 1가지)
**파라미터**
| 이름 | 타입 | 필수 | 기본값 | 설명 |
|------|------|------|--------|------|
**반환값**
- 타입 및 구조
- 성공 시 예시 (실제로 그럴듯한 값으로)
**사용 예시** (최소 2가지)
1. 기본 사용법
2. 엣지 케이스 또는 옵션 파라미터 활용
**에러 / 예외**
| 에러 코드·타입 | 발생 조건 | 해결 방법 |
|-------------|---------|---------|
**주의사항** (있으면)
- 성능, 부작용, 제한 사항
코드에서 유추할 수 없는 내용은 [TODO: 작성자 확인] 으로 표시해 주세요.
잘 쓰는 팁
- "문서 용도" 에 따라 수준이 크게 달라집니다. 외부 공개용이라면 "비개발자도 이해할 수 있도록 쉽게"라고 덧붙이세요.
- 문서 초안이 나오면 "이 코드에서 문서와 실제 동작이 다른 부분이 있는지 확인해 줘"라고 교차 검증을 요청할 수 있습니다.
- 마이크로서비스 여러 개를 운영한다면 이 프롬프트를 엔드포인트별로 반복 실행해 모아두면 내부 API 위키가 됩니다.