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

PoC(Proof of Concept)에 참여하게 되면서 문서를 작성하게 될 일이 생겼는데,

시기 적절하게 'Docs for Developers (기술문서 작성 완벽 가이드)' 책을 만나게 되었습니다.

글을 작성하는 것에는 정말 재능이 없지만, 문서를 작성해야하는 업무가 생기다보니 이러한 가이드가 필요하던 시점이였는데..ㅎ

 

이 책의 진행은 '강아지 음성 번역 서비스' 를 만드는 Corg.ly라는 가상 개발팀의 스토리로 각 챕터들을 구성 및 진행하고 있습니다.

각 챕터들은 당연시 여기고 있던 것이지만 놓치고 있던 것들에 대한 설명과 예시들을 충분히 들어주어 이해하는데 어려움이 없었습니다.

 

아래 캡쳐와 같이 예시들은 이해하기 쉬운 레벨로 작성되어 있고, 마크다운으로 작성된 예시들이 더 친근하고 실무처럼 느껴졌습니다.

 

국내 유명 IT 대기업들(우아한형제들, 카카오, AWS, Line, 쿠팡 등)의 테크니컬 라이터들의 인터뷰가 수록되어 있습니다.

 

 

 

전자책 버전이라 사진과 멘트가 따로 따로 나오네요. 

 

작은 규모의 회사라면 문서는 개발자의 몫이기도 하기에 개발자가 읽기에도 충분히 좋은 책입니다.

 

개발자라면 당연히 각 언어나 프레임워크의 공식문서들을 많이 접하게 되는데,

해당 문서들이 이 책의 각 원칙들을 잘 지키면서 작성되었는지 알 수 있는 계기가 되기도 하였습니다.

 

기술 문서 뿐만 아니라 개발자나 IT회사의 개발팀이라면 기술 블로그를 운영할 수 있는데,

이 책은 기술 문서, 기술 블로그 등에 실용적으로 사용될 수 있을 것이다.

 

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