SO EASY정의
프로젝트를 처음 열었을 때 가장 먼저 읽어야 하는 안내 파일.
자세한 설명
저장소를 처음 열었을 때 가장 먼저 눈에 띄는 자리에 두는, 이 프로젝트가 무엇이고 어떻게 설치하고 실행하는지 설명하는 안내 파일입니다. 처음 보는 사람이나 새로 투입된 AI 에이전트가 이 파일만 읽어도 이게 뭐고 어떻게 시작하면 되는지 감을 잡을 수 있도록 쓰는 것이 목적입니다. 내용이 부실하거나 오래돼 실제와 다르면 오히려 헷갈리게 만듭니다.
예를 들면
새 프로젝트 저장소를 열자마자 README 파일을 읽고, 실행하는 방법과 필요한 준비물을 바로 파악했습니다.
체크포인트
README 가 최신 상태인지 가끔 확인해야 합니다. 설치 방법이 바뀌었는데 문서가 그대로면 새로 온 사람이 헤매게 됩니다.
관련 용어
용어 설명은 이해를 돕기 위한 안내입니다. 법령·세무·지원 제도의 정확한 기준은 관계 법령과 소관 기관의 최신 안내를 확인하세요.