[한빛미디어] Docs for Developers(기술문서 작성 완벽 가이드)

원문: https://www.amazon.com/Docs-Developers-Engineers-Technical-Writing/dp/1484272161

Amazon.com

 

리뷰도서 : https://www.hanbit.co.kr/media/books/book_view.html?p_code=B8810771470 

Docs for Developers 기술 문서 작성 완벽 가이드

 

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

 

독서 후기

우리는 기획하고, 디자인하고, 개발을 할 때 사용자 중심으로 생각하는 연습을 계속하게 된다. 즉 프로덕트의 최종 사용자를 생각하며 프로덕트를 생산하는 것. 그게 우리가 해야 하는 일이다.

마찬가지로 개발 과정 중 협업을 위해 다른 도메인의 직무들과 소통할 때 흔히 문서를 주고받게 되는데, 이 때 소통 문제가 발생하지 않도록 신중한 문서 작성이 필요하다.

 

이 책에서 가장 먼저 소개하는 것은 '지식의 저주(Curse of Knowledge)'이다. 거창해보이지만, 사실 내가 아는 걸 상대방도 알거라는 착각을 벗어던지라는 의미이다. 잘 알기에 전문용어를 남발하는 것을 포함하는 내용이다.

팀 프로젝트를 하다보면 흔히 겪을 수 있는 커뮤니케이션 오류 중 하나로, 내가 작성한 코드, 내가 조사한 자료에 대해 상대방도 어느 정도 이해하고 있을 거라는 착각에서 벗어나 상대방을 먼저 이해하고, 문서화를 계획하고, 초안 작성, 편집 등등 개발자 문서 전반에 대한 소개를 하고 있다. 책에서 예시는 강아지 언어 번역 서비스 API 개발팀의 스토리를 기반으로 진행되며, 개발 문서를 작성하는 과정을 단계별로 배우도록 소개한다. 번역된 책이다보니 다소의 번역투가 남아있어 신경쓰일 수는 있지만, 책의 전반적인 내용과 흐름을 이해하기에는 부족하지 않으니 개발문서 작성에 관심있는 사람이라면 읽어보면 좋을 것 같다.