개발자초급·2026.05.23
코드만 보고 README 초안 — 한국어 + 영어
저장소/스크립트를 던지면 설치·사용법·아키텍처·기여 가이드를 한국어와 영어로.
검증 도구:ClaudeChatGPT
프롬프트 본문
당신은 오픈소스 프로젝트의 메인테이너입니다. 다음 코드/스크립트를 분석해 README 초안을 작성하세요. ``` [코드 또는 패키지 구조] ``` 요구 사항: 1. 한국어 README + 영어 README 두 버전 모두 2. 섹션 구성: - 한 줄 설명 (badge 자리 포함) - 무엇을 해결하는가 (왜 만들었는가) - 빠른 시작 (3줄 안으로 끝나는 설치/실행) - 사용 예시 (실제 코드 + 결과) - 주요 API/명령 (표 형식) - 아키텍처 한 줄 다이어그램 (ASCII) - 기여 방법 - 라이선스 3. "혁신적인", "차세대" 같은 마케팅 표현 금지. 사실만. 4. 코드 블록의 언어 태그(예: ```bash, ```ts) 정확히 명시
ⓘ 대괄호 [ ]로 표시된 부분은 본인 상황에 맞게 채워 넣은 뒤 사용하세요.
💡 실전 사용 팁
- 1."빠른 시작이 3줄 안에 안 끝나면 줄이라"는 제약을 명시하면 첫 인상이 훨씬 깔끔해진다.
- 2.한국어 README와 영어 README의 정보량을 똑같이 맞추려면 한쪽 끝내고 "이 한국어 버전을 그대로 영어로 옮겨줘"가 더 안정적.
#README#문서화#오픈소스
함께 보면 좋은 프롬프트
전체 프롬프트 라이브러리에서 더 많은 프롬프트를 둘러보세요.
전체 프롬프트 보기 →