READMEREADME

집을 빌릴 때 집주인이 남겨두는 '가전제품 사용법·긴급 연락처' 안내문처럼, README 는 코드 폴더 안에 두는 첫 번째 안내 문서예요. 누가 봐도 '이 프로젝트가 왜 존재하고, 어떻게 돌리는지'를 바로 알 수 있도록 정리해 두는 텍스트 파일입니다.

1인 비즈니스(1인 사이트 운영)를 운영하다 보면 몇 달 뒤 자신이 만든 코드를 다시 열었을 때 '이게 뭐였지?' 하는 순간이 반드시 옵니다. 블로그 자동화 스크립트, 뉴스레터 발송 도구, SaaS 백엔드, 쇼핑몰 재고 관리 코드 등 어떤 프로젝트든 README 가 있으면 재개하는 데 걸리는 시간이 크게 줄어요. AI 와 협업할 때도 README 를 프롬프트에 붙여넣으면 AI 가 프로젝트 맥락을 훨씬 빠르게 파악합니다.

처음에는 '프로젝트 한 줄 설명 / 실행 방법 / 주요 기능 세 가지'만 적어도 충분해요. 완벽하게 쓰려다 미루는 것보다, 짧게라도 바로 만들어 두는 게 훨씬 낫습니다.