개발자의 덕목 - Documetation, 문서화

흥미로운 깃허브 Topic - Documentation 깃허브 문서화 주제 오늘 깃허브를 둘러보다가 Documentation Topic이 있는 것을 보고 흥미롭다는 생각을 갖고 접근했다. 원래 Documentation은 개발자에게 매우 소중한 덕목 중 하나이다.

아무리 본인이 코드를 잘 짠다고 하더라도 이를 남들에게 알리지 않는 한 이는 개인 소장용일뿐이다. 작성한 코드를 공개한다고 하더라도 이에 대해서 잘 설명해 주지 않는 이상 남들이 내 코드가 어떤 기능을 하는지, 무슨 목적이 있는지 등을 알기란 어렵다.

이런 점에서 이 코드가 다른사람들에게 사용되기란 요원하다. 그리고 세상에 발을 내디디려는 개발자로서는 내가 만든 프로그램이 어떤 목적을 갖고 만들어졌는지, 어떤 기능들이 있는지, 어떻게 사용해야 하는지, 어떤 기술을 기반으로 작성되었는지 등을 상세히 작성해 줘야지만 다른 사람들이 이 코드를 보고 리뷰를 해주고 어떤 부분에서는 본인보다 뛰어난 실력자가 나타나 도움을 줄 수도 있다...