#review Documentation is freaking awesome - 좋은 코드에 걸맞는 관심을.

정말 깔끔하다. 코드와 설명을 저렇게 분리해 보여주니 눈에 더 잘 들어온다. 마음에 든다. clojure는 Marginalia를 사용하면 된다.

잘 만든 프로젝트 웹사이트. 중요한 정보를 눈에 띄게 배치했고 구성도 좋다. 거기다 예쁘기까지. 프로젝트 웹사이트를 만든다면 참고할 웹사이트.

README 파일. 만나게 되는 첫 문서. GitHub와 같은 소스 코드 호스팅 사이트에선 자동으로 보여준다.

다른 사람이 볼까 봐 소스코드 공개를 못한다고 한다. 부끄러운 퀄리티라서. 하지만 이건 착각. 좋은 오픈소스가 넘쳐난다. 그거 보기에도 시간이 부족한데, 이름없는 내 소스를 보는 사람이 있을까? 없다. 걱정 말고 공개해도 괜찮다. 괜한 걱정이다.

많은 오픈소스. 그래서 문서화가 더 중요하다. 좋은 코드에 걸맞는 관심을 끌기에 가장 좋은 도구이기 때문이다.

참고 - Documentation is freaking awesome by Kyle Neath


크리에이티브 커먼즈 라이선스 |