‘타입스크립트만으로 문서를 대체할 수 있을까 ?’ 처음 글의 제목을 보고 ‘클린 코드’ 의 한 인용문이 생각났다. ‘문서’는 ‘주석’의 연장선에 있기 때문에 다음 글의 핵심을 메시지를 잘 요약하는

‘타입스크립트만으로 문서를 대체할 수 있을까 ?’ 처음 글의 제목을 보고 ‘클린 코드’ 의 한 인용문이 생각났다. ‘문서’는 ‘주석’의 연장선에 있기 때문에 다음 글의 핵심을 메시지를 잘 요약하는 인용문인 것 같다. > Don’t comment bad code - rewrite It > (나쁜 코드에 주석을 달지 마라. 새로 짜라.) > > Brian W. Kernighan and P.J Plaugher 문서는 중요하다. 하지만 코드만큼 중요하지는 않다. 코드만 잘 작성 하더라도 엔지니어의 의도를 충분히 전달할 수 있다. 문서는 의사를 전달하는 이 과정을 대체하는 역할이 아니라 돕는 역할을 해야 한다. 공유하는 글은 이 메시지의 좋은 사례라 생각한다. 글의 핵심 내용을 요약하면, 아마존에서 새로운 라이브러리를 공개했다. 하지만 공식 문서 없이 코드만 공개했다. 코드밖에 없었지만 라이브러리를 학습하는 데 문제는 없었다. 코드를 이용해서 라이브러리를 학습하는 과정에서 , , 그리고 을 경험했다. FYI. 현재는 라이브러리를 소개하는 간단한 문서가 Github 에 올라와 있다. 처음부터 코드만으로 문서를 대체할 생각은 아니었을 것 같다. 아마도 원래 의도는 ‘우리는 이거 만드느라 바쁘니까, 일단은 알아서 쓰세요’ 이지 않았을까 싶다.