개발자의 소통법
《개발자의 글쓰기》리뷰
개발자의 글쓰기
저자 김철수
출판사 위키북스
출간일 2019-10-04
페이지 276
흔히 개발자가 되면 문서 작업이 별로 없을 거라고 생각하기 십상인데 사실은 전혀 그렇지 않다. 체감상으로는 코딩 작업량과 문서 작업량이 거의 비례한다. 개발자가 사람의 언어로 된 요청을 이해하고 컴퓨터의 언어로 구현하는 포지션인 만큼, 구현물을 다시 인간의 언어로 풀어서 문서화하는 것 또한 개발자의 역할이다. 물론 나는 글쓰기에 익숙한 편이기 때문에 비즈니스 글쓰기 자체에 크게 어려움을 느끼는 편은 아니다. 하지만 개발자로서의 글쓰기는 익숙하지 않았기에, 《개발자의 글쓰기》에 관심이 생겼다.
책은 개발자가 맞닥뜨릴 수 있는 여러 종류의 글쓰기에 대해서 다루고 있다. 문서 작업이 많은 개발자라면 이 책을 꼭 권하고 싶을 정도다. 특히 개발자가 중요성을 간과하기 쉬운 네이밍 컨벤션, 변수명, 함수명, 주석을 왜 잘 써야 하는지부터 예를 들어 설명한 부분이 머리에 쏙쏙 들어왔다. 내가 짠 코드여도 몇 달 지나면 낯설고 이해할 수가 없는 경우가 허다하다. 함수명을 더 알기 쉽게 지어둘걸, 주석을 잘 달아놓을걸 하고 과거의 나를 돌아보기 일쑤다. 오죽하면 '주석은 미래의 나를 위한 것이다'라는 말이 있을 정도다. 개발할 때 이름 잘 짓는 법에 대해 가이드라인을 명쾌하게 제시하고 있어서, 내 나름의 네이밍 컨벤션을 만들어 보고 싶다는 생각이 들었다.
3장의 에러 메시지 쓰는 법도 공감하면서 읽었다. 예를 들어 웹의 회원 가입 과정에서 어떤 문제로 가입 진행을 할 수 없을 때 '회원 가입을 진행할 수 없습니다.'처럼 상황만을 전달하는 것보다는 '휴대폰 번호를 잘못 입력해서 회원 가입을 진행할 수 없습니다. 휴대폰 입력란에서는 숫자만 입력하십시오.'와 같이 해결 방법을 사용자에게 알려줘야 한다는 것이다. 실제 있을 법한 예를 들어 설명하고 있어서 이해하기가 쉬웠다.
전체적으로 각 장이 문제 인식 - 문제 해소를 위한 본질적인 관점 전환 제시 - 실제 예시를 들면서 설명 - 구체적인 가이드라인의 구성으로 이루어져 있다. 글쓰기 책은 본질적인 관점 전환 쪽이나 구체적인 가이드라인 쪽 둘 중 하나에 치우치는 경우가 많은데, 이 책은 고르게 다루고 있어서 만족도가 높았다. 게다가 '개발자의 글쓰기'라는 제목에 걸맞게 코드에서의 이름 짓기, 에러 메시지, 릴리스 문서, 개발 가이드, SI제안서, 기술 블로그까지 개발자가 맞닥뜨리는 다양한 글쓰기를 커버하는 점도 알찼다.
가끔 개발자는 번역가 같다고 생각하곤 한다. 앞에서도 언급했듯이 사람의 언어로 된 요청을 이해하고 컴퓨터의 언어로 구현하는 사람이라고 생각해서다. 심지어 컴퓨터 언어를 구사할 때도 사람마다 특색이 있어서 컴퓨터 언어를 구사하는 다른 사람(다른 협업 개발자)이 잘 이해할 수 있도록 구사해야 한다. 거기서 그치지 않는다. 구현물을 인간의 언어로 공유하고 알리는 것도 개발자의 역할이다. 마치 컴퓨터 언어-인간 언어 간의 번역가 같다. 그리고 보통 그 매개는 문서다. 결국 글쓰기와 연결된다. 어떻게 하면 더 잘 전할 수 있는지를 생각하는 개발자가 되고 싶다는 의지(!)가 샘솟았다. 모든 개발자에게 추천하고 싶은 책이다.
