[개발일지] ReadMe의 중요성

과거의 나

사실 readme 파일은 프로젝트를 보는 누가 읽어도 완벽하게는 아니더라도 대략적으로 이해할 수 있게 도와주는 파일이라고 들었다.

하지만 나는 readme파일 작성을 게을리했다.

왜냐하면 어차피 팀프로젝트를 할 때 모든 인원이 오프라인으로 만나 어느정도의 이해를 쌓았기 때문이다.

그렇기에 굳이 정성들여 작성할 필요가 없다고 생각했다.

왜 중요하다고 생각했나?

사실 이건 내가 블로그를 하는 이유와 일맥상통하다. 배달의 민족에서 우아한테크코스(이하 우테코)지원하면서 느낀 점이다.

너는 미친듯이 뭔가에 열정을 다 해본적 있어?
너가 열심히 했던걸 증명해줄레?

내게 미친듯이 열정을 다 해본 것이 코딩이 답이라고 묻는다면,

코딩이 내가 미친듯이 하고 싶어하는 목표의 과정중에 하나라고 생각한다.

그래서 '내가 이렇게 코딩을 열심히 했어요.' 를 증명할 필요가 있었다.

또 다른 이유로는 내가 봤던 코드를 다시는 안 볼줄 알았다.

하지만 인간은 망각의 동물이기에 자신이 썼던 코드 사용법은 익숙하지 않으면 잊어버리는 법이다.

그렇기에 readme를 깔끔하게 정리해서 보기도 쉽고 파악하기 쉽게 만들어야 겠다 생각했다.

그래서 어떻게 할껀데?

우선 readme의 파일은 마크다운 형식이기에 잊어버렸던 마크다운 사용법을 간단하게 정리해볼까한다.

그리고 다른 분들이 작성한 훌륭한 readme 파일을 보고 벤치마킹해야 할 필요가 있다 생각했다.

결국은 포토샵을 잘 다뤄야할것 같지만 그건 나중의 일로 미루자.