프로젝트 README 초안 만들기

소제목 8줄이 먼저 나왔고, "진행" 뒤 본문에서 제가 맨 끝에 적어 둔 docker 명령이 실행 순서 맨 앞으로 옮겨졌다.

1. docker compose up -d — 로컬 PostgreSQL을 띄웁니다
2. npm install — 의존성을 내려받습니다
3. cp .env.example .env — DATABASE_URL을 채웁니다
4. npm run dev — 3000 포트에서 열립니다

Node 버전과 폴더 구조는 "(채워 주세요: …)"로 남았고 배지·라이선스는 붙지 않았다.

readme 작성 프롬프트가 필요한 이유는 만든 사람이 자기 컴퓨터를 기준으로 쓰기 때문입니다. 이미 깔려 있는 도구, 이미 있는 환경 변수 파일, 이미 켜 둔 데이터베이스는 눈에 보이지 않습니다. 그래서 남이 받아 실행하면 두 번째 명령에서 멈춥니다.

맥락 문단이 그 눈높이를 강제로 옮깁니다. "오늘 처음 받아 자기 컴퓨터에서 실행해 보려는 개발자"이고 "사내 시스템은 모른다"고 못 박으면, AI는 생략된 단계를 되묻거나 빈칸으로 남깁니다.

형식의 소제목 순서는 실제로 사람이 저장소를 여는 순서입니다. 무엇인지 보고, 화면을 보고, 필요한 것을 갖추고, 설치하고, 실행합니다. 환경 변수와 자주 겪는 문제를 뒤에 둔 것은 처음 한 번보다 두 번째부터 필요한 정보라서입니다. 명령마다 설명을 붙이라고 한 것은 복사해 붙이다 무엇을 하는지도 모른 채 실행하는 일을 줄입니다.

마지막 문단은 목차부터 받고 본문으로 넘어가게 합니다. 한 번에 완성본을 받으면 그럴듯한 배지와 없는 기능 설명이 섞인 긴 문서가 나오고, 고치기보다 지우는 편이 빨라집니다. 목차 단계에서 절을 덜어 낸 뒤 이어서 다듬으면 실제 저장소에 맞는 문서가 됩니다. 깃허브 리드미 ai 결과를 그대로 올리지 않고 한 번 걸러 내는 장치이기도 합니다.

"알 수 없는 자리는 (채워 주세요)로 남겨 주세요"도 짝이 되는 장치입니다. 빈칸을 허용하지 않으면 AI는 그 자리를 그럴듯한 문장으로 메웁니다. 빈칸이 보이면 저는 무엇을 더 적어야 하는지 알고, 문서는 거짓말을 하지 않은 상태로 남습니다.

그럴듯한 문서가 한 번에 나오지만 절반이 지어낸 내용입니다. 있지도 않은 npm 스크립트, 쓰지 않는 환경 변수, 아무 데도 연결되지 않은 배지와 라이선스가 붙습니다. 정작 필요한 로컬 데이터베이스 준비 같은 실제 단계는 제가 알려 주지 않았으니 빠져 있습니다. 지우고 고치는 데 처음부터 쓰는 것보다 오래 걸립니다.