Guide
README 잘 쓰는 법
README는 프로젝트를 처음 설명하는 문서입니다. 코드를 열기 전에 프로젝트 목적, 주요 기능, 실행 방법을 빠르게 파악할 수 있어야 읽기 좋습니다.
핵심만 보기
- 첫 문단에서 프로젝트의 목적과 문제를 먼저 보여 주세요.
- 주요 기능은 길게 풀기보다 빠르게 훑을 수 있게 정리하는 편이 좋습니다.
- 기술 스택은 이름보다 선택 이유까지 적어 둘 때 더 설득력 있습니다.
첫 문단에서 목적을 분명히 쓰세요
프로젝트가 무엇인지보다 왜 존재하는지를 먼저 설명하면 맥락이 더 빨리 잡힙니다. 해결하려는 문제나 사용 장면을 앞에 두는 편이 읽는 사람에게 훨씬 친절합니다.
주요 기능은 훑어보기 쉽게 정리하세요
모든 구현 세부사항을 README에 길게 적을 필요는 없습니다. 대표 기능을 짧은 문장이나 목록으로 정리해 두면 문서 전체가 훨씬 깔끔해집니다.
기술 스택은 선택 이유와 함께 적어 보세요
어떤 기술을 썼는지보다 왜 그렇게 구성했는지가 더 큰 차이를 만듭니다. 기술 이름만 나열하기보다 선택 이유를 짧게 덧붙이면 프로젝트 이해도가 높아집니다.
실행 방법과 현재 상태도 중요합니다
설치 방법, 실행 명령어, 필요한 환경 변수, 현재 개발 상태를 함께 적어 두면 다른 사람이 따라오기 쉬워집니다. README는 포장 문서보다 안내서에 가깝다는 점이 중요합니다.