책 리뷰 'Docs for Developers 기술 문서 작성 완벽 가이드'

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

개발 처음 배울 때는 코딩만 잘하면 되는 줄 알았다 (그 조차도 못함)

 

개발자는 은둔하고 소심한 체크남방 남자의 삶일 줄 알았으나

의외로 정말 많은 발표, 문서화를 경험하게 됐다.

 

개발자끼리는 API 명세서를 포함한 각종 문서를 만들어야했다.

최근엔 소마를 하게 되면서 기획서를 만들고, 발표 준비를 했다.

내 생각을 전달하는 방법이 몹시 중요하다.

 

무슨 문서든 똑같다.

기획서를 작성하라고 시킴 당하고(?) API 명세서를 만들라고 강요당하면 벙찐다.

 

피드백을 받을 때 꽤나 많이 들어봤고, 나도 많이 고민하는 것은

 

우리는 오랫동안 고민하면서 익숙해졌지만

듣는 사람들은 이 내용이 뭘 말하는 지 모른다는 사실이다.

이 책에서는 “지식의 저주”라는 표현을 쓴다. 정말 적합한 말이 아닐까?

 

독자가 고급 개발자라면? 초급 개발자라면? 일반인이라면? 이런 고민을 하고

고민을 넘어서 감정을 이입해야한다.

디자인씽킹도 그렇고, 기획에 대해서도 고민하는 것도 그렇고 이런 문서화를 할 때에도

결국에는 감정이입이 중요하다.

 

후반에는 국내 테크니컬 라이팅을 하는 분들의 인터뷰가 나온다.

굉장히 딱 와닿는 표현을 봤다.

문서도 ‘제품’이다.

개발이든 제품이든 만들면서 파생되는 부수적인 작성물이 아니구나 라고 느꼈다.

 

의외로 많은 생각을 하게 된 짧은 책이었다고 생각한다. 좋았다.