ChatGPT문서화README초보환영

프로젝트 README를 작성하는 프롬프트

개발자김철수22시간 전조회 0추천 0

변수 입력4개

SUMMARY

STACK

RUN_COMMANDS

예시

변수를 채운 뒤 완성본을 복사하세요

언제 사용하나

새 사람이 프로젝트를 빠르게 이해하고 실행할 수 있는 README가 필요할 때.

요청 전 확인

실행에 필요한 실제 명령과 사전 요구사항을 확인한다.

복사해서 쓰는 프롬프트

이 프로젝트의 README를 작성해줘.

프로젝트 요약: {{SUMMARY}}
기술 스택: {{STACK}}
실행 방법(실제 명령): {{RUN_COMMANDS}}

원하는 구성:
1. 한 줄 소개와 핵심 기능
2. 사전 요구사항과 설치
3. 로컬 실행/테스트 명령(복사 가능하게)
4. 환경변수 표(이름·용도·예시, 실제 비밀값 금지)
5. 프로젝트 구조 요약과 기여 방법
placeholder는 {{예시}} 형태로 남겨줘.

placeholder 설명

{{SUMMARY}} / {{STACK}} / {{RUN_COMMANDS}} : 요약/스택/실행 명령

입력 예시

{{RUN_COMMANDS}} = "./gradlew bootRun"

기대 결과

설치·실행·환경변수·구조가 담긴 README 초안.

검증 방법

README만 보고 새 환경에서 실제로 실행해 본다.

주의사항

환경변수 예시에 실제 비밀값을 넣지 않는다.