코드 문서화를 위한 효과적인 프롬프트 패턴을 알아봅니다.
문서화 프롬프트 구조
README
프로젝트 README
이 프로젝트의 README.md를 작성해줘.
프로젝트: 전자상거래 관리 대시보드
기술 스택: Next.js, TypeScript, Prisma, PostgreSQL
포함 섹션:
- 프로젝트 소개
- 주요 기능
- 기술 스택
- 시작하기 (설치, 환경설정, 실행)
- 프로젝트 구조
- 환경 변수
- 스크립트 설명
- 기여 가이드
- 라이선스
라이브러리 README
npm 패키지 README.md를 작성해줘.
패키지: @myorg/date-utils
기능: 날짜 포맷팅 유틸리티
포함 섹션:
- 배지 (npm, 빌드, 커버리지)
- 설치 방법
- 빠른 시작
- API 레퍼런스
- 사용 예시
- 브라우저 지원
- 번들 크기
- 마이그레이션 가이드
- 기여 방법
API 문서
OpenAPI/Swagger
REST API를 OpenAPI 3.0 스펙으로 문서화해줘.
엔드포인트:
POST /api/users - 사용자 생성
GET /api/users/:id - 사용자 조회
PUT /api/users/:id - 사용자 수정
DELETE /api/users/:id - 사용자 삭제
포함:
- 경로 파라미터
- 쿼리 파라미터
- 요청/응답 스키마
- 예시
- 에러 응답
- 인증 방식
JSDoc API
이 모듈에 JSDoc 문서를 추가해줘.
[코드]
포함:
- 함수 설명
- @param (파라미터 타입, 설명)
- @returns (반환 타입, 설명)
- @throws (예외 조건)
- @example (사용 예시)
- @see (관련 항목)
코드 주석
복잡한 로직 설명
이 복잡한 함수에 적절한 주석을 추가해줘.
[복잡한 코드]
가이드:
- 전체 목적 설명 (함수 상단)
- 복잡한 조건문 설명
- 알고리즘 단계 설명
- 엣지 케이스 명시
- TODO/FIXME 표시
과도한 주석은 피하고 필요한 부분만
타입 문서화
TypeScript 타입에 문서를 추가해줘.
[타입 정의]
포함:
- 각 타입의 목적
- 필드 설명
- 사용 예시
- 관련 타입 참조
가이드 문서
시작 가이드
새 개발자를 위한 시작 가이드를 작성해줘.
프로젝트: [프로젝트 설명]
포함 내용:
1. 개발 환경 설정
- 필수 도구 (Node.js, Docker 등)
- IDE 설정 (VSCode extensions)
- 환경 변수
2. 프로젝트 구조 이해
- 폴더 구조 설명
- 핵심 파일 설명
3. 개발 워크플로우
- 브랜치 전략
- 커밋 규칙
- PR 프로세스
4. 일반적인 작업
- 새 기능 추가
- 버그 수정
- 테스트 작성
기여 가이드
CONTRIBUTING.md를 작성해줘.
포함:
- 기여 방법
- 개발 환경 설정
- 코드 스타일
- 커밋 메시지 규칙
- PR 프로세스
- 이슈 보고 방법
- 행동 강령
아키텍처 문서
시스템 개요
시스템 아키텍처 문서를 작성해줘.
시스템: [시스템 설명]
포함 섹션:
1. 시스템 개요
- 목적
- 주요 기능
- 사용자
2. 아키텍처 다이어그램
- 컴포넌트 다이어그램
- 데이터 흐름도
- 배포 다이어그램
3. 기술 결정
- 기술 선택 이유
- 대안 검토
4. 데이터 모델
5. API 개요
6. 보안 고려사항
기술 결정 문서
기술 결정 기록(ADR)을 작성해줘.
결정: 상태 관리 라이브러리 선택
형식:
- 제목
- 상태 (제안/승인/폐기)
- 컨텍스트 (왜 결정이 필요한가)
- 고려한 옵션들
- 결정과 이유
- 영향
- 관련 문서
변경 로그
CHANGELOG
CHANGELOG.md를 작성해줘.
형식: Keep a Changelog
버전 히스토리:
- 1.2.0: 다크모드 추가, 성능 개선
- 1.1.0: 알림 기능 추가
- 1.0.1: 로그인 버그 수정
- 1.0.0: 최초 릴리스
카테고리:
- Added
- Changed
- Deprecated
- Removed
- Fixed
- Security
실전 프롬프트
완전한 문서화
이 프로젝트의 전체 문서를 작성해줘.
프로젝트: [코드/설명]
생성할 문서:
1. README.md (프로젝트 소개)
2. docs/getting-started.md (시작 가이드)
3. docs/architecture.md (아키텍처)
4. docs/api.md (API 레퍼런스)
5. CONTRIBUTING.md (기여 가이드)
6. CHANGELOG.md (변경 로그)
각 문서의 핵심 내용 포함
코드에서 문서 생성
이 코드를 분석해서 문서를 생성해줘.
[코드]
생성할 문서:
- 함수/클래스 API 문서
- 사용 예시
- 타입 정의
- 의존성 설명
- 주의사항
Markdown 형식으로 출력
팁
| 팁 | 설명 |
|---|---|
| 대상 독자 | 누가 읽을지 고려 |
| 형식 지정 | Markdown, JSDoc 등 |
| 예시 포함 | 코드 예시 요청 |
| 구조 명시 | 원하는 섹션 나열 |
| 간결함 | 필요한 정보만 |
좋은 문서는 코드만큼 중요합니다.