개발 프롬프트
처음 온 사람을 위한 README
프로젝트를 처음 본 사람이 5분 안에 실행해 볼 수 있게 README를 써요.
이 프롬프트로 얻는 결과, 예시
실제 결과는 넣는 자료와 쓰는 AI에 따라 달라져요.
복사될 내용
<role> 당신은 오픈소스 문서를 많이 다듬어 본 기술 작가예요. 첫 화면에서 무엇이고 어떻게 시작하는지를 끝내요. </role> <task> 아래 프로젝트의 README를 써 주세요. </task> <material> [프로젝트가 하는 일] 하는 일 [설치와 실행 방법] 설치와 실행 [폴더 구조나 주요 파일] 폴더 구조 </material> <instructions> 1. 첫 두 줄에 무엇을 하는 프로젝트인지, 누구를 위한 것인지 쓴다. 2. 설치부터 첫 실행까지는 복사해서 붙여 넣으면 되는 명령으로 쓴다. 3. 내가 준 정보에 없는 명령이나 설정을 지어내지 않는다. 빈 곳은 [채워 주세요]로 둔다. 4. 자주 막히는 곳을 문제 해결 칸에 모은다. </instructions> <output_format> 마크다운 README 전체: 소개, 빠르게 시작하기, 사용 예, 설정, 폴더 구조, 문제 해결, 기여하는 법, 라이선스 자리. </output_format> 먼저 <material>을 끝까지 읽고, <instructions>를 지키며 <task>를 수행해 주세요. 정보가 모자라면 추측하지 말고 무엇이 더 필요한지 물어봐 주세요.
빈칸 3개 중 0개 채움. 비워 둔 칸은 {{ }} 모양 그대로 복사돼요.
문서화, 개발의 다른 프롬프트
diff를 붙여 넣으면 이번 변경이 새로 만든 문제만 골라 보고, 합쳐도 될지 판단해 줘요.
버그가 될 문제부터 취향 문제까지 무게를 나눠, 고칠 순서가 보이는 코드 리뷰를 받아요.
오류 메시지와 관련 코드를 주면, 가능한 원인을 가능성 순으로 세우고 하나씩 확인할 방법을 알려 줘요.
가끔만 생기는 버그를 잡기 위해 무엇을 기록하고 어떤 순서로 범위를 좁힐지 계획을 세워요.
찾는 프롬프트가 없나요? 요청하거나 직접 올려 주세요