후기] 내돈내산 독서 2 - Docs for Developers

이 책은 원서를 바탕으로 개발자를 위한 문서 작성법 특히 이미 대중화된 MSA 개발에서 API 문서 작성의 중요성과 방법, 그 절차를 설명하고 있다. 그리고 추가로 부록에서 국내 테크니컬 라이터 11인의 인터뷰를 더 하여 그 가치를 더했다.

 

개인적으로 개발 문서를 작성하는 입장이 아닌 읽는 경우일지라도 이 책의 챕터 2까지는 읽으면 문서 작성자가 어떤 의도를 가지고 작성했다는 것을 알 수 있기 때문에 시간이 없다면 도서를 빌려 챕터 2까지만이라도 읽는 것도 도움이 될 것 같다는 생각이 들었다.

 

필자는 부끄럽지만 업무를 하며 최근에 처음으로 릴리스 노트를 작성해 봤다. 아쉽게도 이 책을 읽기 전에 업무를 진행했었는데 다시 같은 업무를 진행하게 된다면 무조건 전보다 나은 문서를 작성할 수 있을 거라는 확신이 들었다. 이에 관한 책 내용의 일부 문장은 다음과 같다.

릴리스 노트는 새로운 기능, 버그 수정, 알려진 버그 또는 제약 사항, 단절적 변경 등 마이그레이션 관련 사항을 사용자에게 이야기 하는 형태로 작성한다. 왜 어떤 변경이 일어났는지 이해하기 위한 맥락을 사용자에게 제공하기 위함이다.

이런 경험 때문인지 몰라도 이 책은 기술 서적이지만 감명깊게 읽을 수 있었다.

 

후기를 요약하면, 이 책은 기술 문서를 체계적으로 작성하고 싶은 사람과 기술 문서가 필요한 개발자 모두에게 도움되는 책이며 주변 주니어 개발자들에게 함께 읽자고 이야기하고 싶은 책 중 하나가 되었다.