Docs for developers - 자레드 바티 et al.

최근 리비전까지 마무리지은 논문은 꽤나 범용적으로 사용 가능한 메소드인데, 깃헙에 사용할 수 있도록 코드도 올려놓았다. 처음 논문을 arxiv에 올린 것은 이번 겨울이었기도 하고, 나름 이 논문이 넓게 알려진 것인지 그래도 사용자가 좀 있다. 뭐, 백명 이런 수준은 아닐 것이긴 한데, 프로그램을 써보면서 깃헙 이슈도 만들거나 우리에게 이메일을 보낸 사람들이 꽤 된다. 약간 생명 분야다 보니, 깃헙 이슈보다는 이메일을 주로 사용하는 것 같고, 대체로 깃헙 스타도 안 눌러주는 것 같다 ㅠㅠ. 대부분 깃헙 프사도 없고 레포지토리도 하나 없다보니, 정말 깃헙에 가입만 하셨구나 라는 것을 느낄 수 있었다. 

사실, 작년에 개발할 당시에는 이 깃헙 레포를 엄청난 레포로 만들어야겠다는 좀 원대한 꿈도 가지고 있었는데, 리비전 때나 지금이나 코드 하나하나에 신경쓸 여유가 없어서 손을 놓고 있긴 하다. 사실, 또 내가 연구를 하는 사람이지 개발을 중점적으로 훈련한 사람도 아니기도 해서 코드도 아마 그리 전문적이지는 않을 것이다. GUI 같은 경우도 사실 정말 너무나 맛보기 수준으로 만들었는데 가끔 사람들이 GUI만 써보고 왜 안되냐고 물어보는 경우도 많은 것을 보면, 좀 더 신경을 쓰긴 해야할 것 같은데 못하고 있다. 

그러던 와중 이 책을 받았는데, 개발자들을 위한 책인 것 같다. 쌩 개발자들 사이에서는 저 문서화라는 것이 매우 중요하다고 하는데, 나도 어느 정도 관심만 가지고 들어보기만 했을 뿐 자세히는 잘 모른다.

저자 목록을 보니까, 구글, 리눅스, 마이크로스프트 등 여러 거대한 소프트웨어 회사에서 개발자로 일하신 분들이 함께 쓴 책인 것 같다. 보니까, 테크니컬 라이터라는 직책이 있는 것 같다. 생각해보면, 대학원에서 만드는 하나의 레포지토리도 가끔 너무 복잡해서 서로 이해를 못하는 경우가 있는데, 거대한 회사에서 만드는 큰 서비스 이런 것은 엄청나게 복잡할 것 같긴 하다. 사실, 코드를 좀 짜본 사람이면 알겠지만, 남의 코드 이해하는 게 세상에서 제일 어려운 것이라는 데에 많이 동의할 것이다. 때문에 저런 회사에서 코드를 짜는 것에 언어의 문법마냥 어느 정도 규정을 정하고 서로 이해할 수 있도록 설명서를 만드는 것이 굉장히 중요할 것 같다. 특히, 개발자 한 명이 혼자 코드를 짜는 것이 아니라 여러 명이 짜는 것이기도 하고, 사실 저런 회사에서는 개발자들이 쉽게 갈아끼워지기 때문일수도.. 있겠다는 생각을 해본다. 

 

책의 추천사에도 여러 유명한 회사들의 테크니컬 라이터들이 글을 남겨놓았다. 당연하지만, 매우 권한다는 것이 주를 이루었다.

 

 

모든 발표나, 글들이 그렇듯이, 청자를 이해하는 것이 참 중요하다. 이 책에서도 그것부터 시작한다. 

사실 코딩을 하기는 하지만, 개발이라는 것을 잘 모르는 사람으로 이 책을 읽어보는 것이긴 한데, 전체적인 목차를 봤을 때 좋은 목차로 자세하게 내용을 다루는 것 같다는 느낌을 받았다. 아마 개발 직군으로 면접 보거나 일하게 되면 이 책을 읽어보면 좋을 것 같긴 하다.

 

그리고 보니까 corgly라는 이 분야에서 쓰는 툴이 있는 것 같은데, 코기라는 강아지마냥 귀여운 캐릭터를 만들어놔서 한 섹션의 시작마다 귀여운 그림을 넣어놨는데 은근 보는 맛이 있다. 보면 컴공쪽 애들이 은근히 저런 캐릭터나 귀여운 것을 좋아하는 것 같다. 물론 다 이상한 컴공쪽 애를 가져와서 캐릭터화 시켜야 한다.

---

전반적으로 읽어봤을 때, 대충 어떤 식으로 라이팅을 해야하는 것인지 감을 잡을 수 있었다. 나에게 바로 도움은 안되더라도 좀 더 사용자 친화적으로 내 코드들을 설명할 수 있는 글을 쓸 수 있을 것 같다.

"한빛미디어 <나는 리뷰어다> 활동을 위해서 책을 제공받아 작성된 서평입니다."