내배캠 6주 4일차

오늘은 Todo 과제 리드미 작성을 위해서 좋은 리드미는 어떻게 작성해야 하는지와 API명세서는 어떻게 써야하는지에 대해서 찾아봤다.

 

리드미를 왜 작성할까? 

리드미는 프로젝트에 대한 기본적인 설명이다. 이 설명이 없으면 사람들은 프로젝트의 흐름과 내용및 사용법을 직접 모든 것을 찾아가며 파악해야 할 것이다. 또한 나중에 나와 타인이 프로젝트를 수정할 때 흐름을 다시 파악해야한다. 이는 매우 불편하고 사람들의 흥미가 떨어지기 때문에 내가 아무리 좋은 취지에 프로젝트를 만들었다고 해도 관심을 받기는 어렵다. 

 

코드에 주석도 선택이 아닌 필수인 것처럼  리드미 작성은 선택이 아닌 필수다. 단 리드미를 잘 작성하게 된다면 코드에 주석이 사라지기 때문에 코드가 깔끔해진다.

 

그럼 리드미에는 뭘 작성해야 좋을까?

이 부분은 사람마다 조금씩 차이가 있어서 뭐가 정답이다라고는 좀 어려운거 같다. 그러나 확실한 몇 몇 개는 다음과 같다.

 

- 프로젝트 소개

- 프로젝트 사용법

- 개발 환경(필요한 의존성)

- 구현 기능

 

아직 리드미를 작성하는 나만의 주관적인 방법을 찾지 못했고 또한 어떻게 작성해야 하는지 아직 감을 못잡았다.

따라서 리드미를 작성하는 이유와 작성할 때 필요한 부분은 나중에 따로 정리를 할 예정이다.

 

이번에 리드미 작성법을 찾아보면서 느낀점은 아무리 코드를 잘 작성한다 해도 문서화를 잘 못한다고 하면 안된다고 느꼈다. 이유는 문서라는 것은 나 뿐만이 아니라 타인에게 정확하게 정보를 전달하는 수단이라고 생각한다. 따라서 문서 만들기를 못 한다면 나의 능력을 알리기에 어려움이 생길 거 같다. --> 근데 문서화하는게 너무 어렵다... 그럼에도 연습하다 보면 될 거라고 믿는다.