클로드(Claude) 대화창의 「+」 버튼에서 「Add from GitHub」로 저장소 파일을 고르고 아래 프롬프트를 보내면, 코드에 실제로 있는 내용만으로 README(저장소 첫 화면에 보이는 사용 설명서) 초안이 나와요. 코드를 복사해 붙이는 수고 없이, 저장소를 처음 보는 동료가 읽을 문서를 만드는 흐름이에요.
이런 분께
- 혼자 만든 사내 스크립트를 팀에 넘겨야 하는데 설명 문서가 비어 있는 분
- 클로드에 코드 파일을 하나씩 복사해 붙이다 지친 분
끝나면 이렇게 됩니다
폴더 안 엑셀 파일을 합치는 작은 파이썬 저장소(merge.py, requirements.txt)를 예시로 이 프롬프트를 실제로 돌린 답이에요(2026-11-03 실행, 일부 발췌).
# excel-merge
폴더 안의 .xlsx 파일을 한 파일로 합치는 파이썬 스크립트예요.
## 설치
pip install -r requirements.txt
## 사용법
python merge.py ./data merged.xlsx
## 라이선스
확인 필요 (저장소에 LICENSE 파일이 없어요)
[README와 어긋날 수 있는 점]
1. requirements.txt에 pandas 버전이 고정돼 있지 않아요.
2. 첫 번째 시트만 읽어요. 시트가 여러 개면 나머지는 빠져요.
파일에 없는 내용은 지어내지 않고 「확인 필요」로 남겨서, 고칠 곳이 바로 보여요.
준비물
- 클로드 계정. 요금제 페이지에 무료 요금제에도 커넥터(다른 서비스와 잇는 기능)가 포함돼 있어요(2026년 11월 기준).
- GitHub 계정과 README를 만들 저장소(저장소: 프로그램 파일을 모아 둔 폴더)
- 비공개 저장소라면 GitHub 쪽 관리자 승인이 필요할 수 있어요.
따라 하기
- claude.ai에서 새 대화를 열어요.
- 입력창 왼쪽 아래 「+」 버튼을 누르고 「Add from GitHub」를 골라요. 처음이면 GitHub 로그인과 권한 승인 화면이 열려요.
- 저장소를 고르고 파일 브라우저에서 README에 필요한 파일만 체크해요. 실행 파일, 설정 파일(
requirements.txt,package.json등)이면 충분해요. - 아래 프롬프트를 붙여 넣고 대괄호를 채워 보내요.
- 답 마지막의 「어긋날 수 있는 점」을 먼저 읽고, 맞는 내용으로 고쳐 달라고 한 번 더 말해요.
- 완성된 초안을 저장소의
README.md에 붙여 넣어 저장해요. - 코드가 바뀌면 같은 대화에서 다시 파일을 골라 "바뀐 부분만 README에 반영해 줘"라고 해요.
복사해서 쓰는 프롬프트
지금 첨부한 깃허브 파일만 보고 README.md 초안을 써 줘.
- 독자: [이 프로젝트를 처음 보는 사람]
- 순서: 한 줄 소개 / 할 수 있는 일 / 설치 / 사용법(명령어 예시) / 폴더 구조 / 자주 막히는 곳
- 파일에서 확인할 수 없는 내용(배포 주소, 라이선스 등)은 지어내지 말고 "확인 필요"라고 적어 줘
- 마지막에 코드와 README가 어긋날 수 있는 점을 3개 이내로 따로 알려 줘
- [이 프로젝트를 처음 보는 사람] 예: "파이썬은 깔려 있지만 이 코드는 처음 보는 영업팀 동료"
