[ 협업 ] 좋은 README 작성법이란 ?

⭐ 좋은 README 작성법?

우테코 프로젝트를 하면서, 좋은 REAME 작성법은 무엇일까? 라는 고민을 하게 되었다. 개발자 분들이 README 파일을 통해 내 프로젝트를 리뷰하고, 어떤 기능을 가지고 있는지 한번에 확인할 수 있다. README 파일에 설명이 부족하게 되면 협업 시에 내가 작성한 코드 또는 프로젝트에 대한 이해에 어려움을 겪게 될 것이라 생각한다.이번 기회로 README 파일의 중요성을 다시 알게 되었고, 프로젝트 가이드 문서로서 프로젝트를 쉽게 살펴 볼 수 있게 하고 싶다. 우테코 1주차에서 아쉬운README 파일을 작성했기에, 같은 실수를 하지 않기 위해 이 포스트를 쓰게 되었다.

• 좋은 REAMDE 작성을 위해 새로운 지식을 얻게 되면, 계속적으로 수정할 예정이다.

 

❗README 작성 전 지향하는 목표

1. 프로젝트 시작 전 가장 먼저 보이는 문서이기 때문에, 간단하면서 직관적이어야 한다.
2. 프로젝트가 무엇을 전달하고 싶은지 알 수 있게 한다.( = 프로젝트 설명)
3. 프로젝트가 어떻게 작동되는지 설명이 필요하다.( = test )
4. 코드 이해를 위한 가이드 설명이 필요하다.

 

❗ REAMDE에 들어가야 하는 내용

⭐ 프로젝트 마다 들어가야 하는 내용이 달라 질 수 있다. 선택해서 넣자

1. 프로젝트 명
2. 프로젝트 설명
   • 기능, 추가 하고싶은 기능 등 설명
3. 프로젝트 설치 및 실행 방법
   • 추가적인 의존성, 프로젝트 설치 방법 설명이 필요하다면 추가
4. 프로젝트 사용 방법(=test)
   • 어떤식으로 프로젝트가 작동하는지 설명
5. test 설명
   • test 예시코드 상세 설명 필요시에 설명
6. 클래스 기능 설명 
   • 클래스가 가지고 있는 기능 설명
7. 예외 목록
   • 예외 처리한 목록들 설명