개발자의 글쓰기 (위키북스, 김철수)

개발자의 글쓰기

---

개발자라면 누구나 글쓰기에 대한 고민을 한 번쯤 해보았을 것이다. 변수명이나 함수명을 어떻게 써야 다른 사람이 이해하기 쉬울지, 주석으로 어떤 설명을 적어야 할지, 개발 참조 문서는 어떤 식으로 작성해야 하는 지를 늘 고민하고 있다. 

어쩌면 코드를 작성하는 것만큼 중요하고 시간을 많이 소요하는 것이 바로 글쓰기이다.

 

변수 네이밍부터 릴리스 노트, 장애 보고서, 기술 블로그까지, 프로그래머의 글쓰기 고민 끝!

위의 문구는 책 겉표지에 적혀 있는 문구이다. 이처럼 이 책은 개발자로써 작성할 모든 글에 대한 설명이 담겨 있다. 입사 후 늘 고민하고 작성했던 변수 및 함수 명부터 회사 생활에서 빼놓을 수 없는 제안서, 고객이 직접 보게 될 문서 작성까지. 개발자가 코딩 밖에서 고민해야 했던 부분에 대한 길을 제시하고 있다.

 

이 포스팅에서는 책의 모든 내용을 설명할 수는 없기에 코드 안과 코드 밖으로 구분하여 간략하게 책에서 다루고 있는 내용을 설명하고자 한다.

 

코드 안에서

• 코드 규칙 (변수 및 함수 네이밍, 주석 작성)
• 에러 메시지 및 로그

이 책에서는 코딩 자체를 글쓰기 관점에서 해석한다. 변수와 함수를 어떻게 작성하는 지, 그에 따라 어떤 부분을 어떻게 주석으로 설명해야 하는 지를 말하고 있다. 또한 효율적인 에러 메시지나 로그 작성에 대한 설명도 추가적으로 하고 있다.

 

이는 결국 다른 사람에게 코드를 통해서 전하고자 하는 내용을 효율적으로 전달할 수 있는가를 의미한다. 코드도 개발자 혼자만의 작품, 혼자만의 구역이 아니라 다른 개발자와 유연하게 협업할 수 있고 이해할 수 있고 사용자가 프로그램을 사용하면서 불편함을 최소한으로 느끼도록 가이드하고 있다.

코드 밖에서

• 릴리스 노트
• 장애 보고서
• 제안서
• 고객 요구사항 및 만족도
• 기술 블로그

개발이 끝나고 나면, 그 코드는 개발자 손을 떠나게 된다. 하지만 사용자에게 프로그램으로써 전달되기까지 코드가 아닌 여러 문서들이 개발자의 다음 업무로 남게 된다. 대부분의 개발자들은 프로그래밍 언어를 통해 컴퓨터와의 대화를 주로 다루기 때문에 사람과의 소통을 어려워하는 것 같다. (이 책이 출판된 배경이랄까?) 

 

책에서는 개발 이후 접하게 되는 여러 문서에 대한 작업 가이드를 해주고 있다. 가이드를 따라하다 보면 전문적인 테크니컬 라이터까지는 아니더라도 적어도 내가 한 일에 대한 정보는 잘 전달할 수 있지 않을까?

 

끝으로

5년간 개발자로 일하면서 느낀 부분이 있다. 개발에 대한 메커니즘을 정확하게 알고 있다면 시간이 지나 경험이 쌓이면 개발 실력은 상향 평준화된다는 것이다. 개발 관련된 경험은 우리는 쉽게 노출되어 있고 모든 관심이 개발에 꽂혀 있기 때문에 실력은 분명히 향상된다.

 

그러나 그 외의 것들은 노력없이는 되지 않는다. 서점만 가봐도 컴퓨터 섹션에는 프로그래밍 언어나 프레임워크에 대한 책이 대부분이고 그 외의 것들을 다루는 서적은 비교적 적다. 이러한 배경에 참 알맞은 도서가 아닐까 싶다. 회사에서는 글쓰기를 아무도 안 알려주고 알려주더라도 그게 옳은 지는 모르겠다. (다들 개발자라..) 그럼 더욱더 이 책을 읽어봐야 하는 이유가 아닐까?