티스토리 뷰

'개발자의 글쓰기'는 2019년 10월 초판이 나왔습니다. 이공계를 위한 글쓰기 책은 꽤 많이 나와있고 대학에서도 기본 교양 과목으로 가르치고 있습니다. 하지만 개발자만을 위한 글쓰기 가이드는 없었습니다.

책 표지부터 변수 네이밍, 릴리스 노트, 장애 보고서 같은 실무적인 영역을 건드리고 있습니다. 그리고 저자인 김철수 님이 다양한 주제의 기업 강의를 진행하고 있는데 거기에 '개발자의 글쓰기'라는 강의 콘텐츠가 추가되는 형태라 단체로 책을 주문하고 강의를 진행하는 건도 꽤 있는 듯합니다.

 

 

'개발자를 위한 글쓰기 가이드'는 테크니컬 라이터가 쓴 글쓰기 가이드입니다. 2003년 'HTML HELP FILE 제작과 실무' 이후 18년 만에 나온 책입니다(중간에 '서비스 글쓰기의 모든 것'이 있지만 이건 공저자니깐). 그리고 간혹 대외적인 발표나 강의를 하고 있긴 하지만 NHN에 소속되어 있다 보니 자유로운 활동에는 제약이 있습니다.

 

'개발자의 글쓰기'를 펴낸 위키북스는 2010년부터 2013년까지 'NHN은 이렇게 한다' 시리즈를 펴내면서 유영경 저자와 계속 접촉을 했었을텐데 이번에 나온 글쓰기 책은 김철수 저자와 연결이 되어 진행을 했습니다. 어떻게 보면 출판사 입장에서는 좀 더 잘 팔릴 수 있는 선택을 했던 것이겠죠.

 

책의 구성을 보면 '개발자의 글쓰기'는 주제가 명확합니다.

프롤로그 - 개발자의 글쓰기는 달라야 한다.

1장. 개발자가 알아야 할 글쓰기 기본

2장. 개발 시간을 줄여주는 이름 짓기와 주석 쓰기

3장. 사용자와 소통하는 에러 메시지 쓰기

4장. 독자 관점에서 릴리스 문서와 장애 보고서 쓰기

5장. 설명, 묘사, 논증, 서사로 개발 가이드 쓰기

6장. 수주를 돕는 SI 제안서 쓰기

7장. 기술 블로그 쉽게 쓰고 운영하기

8장. 회사가 개발자 글쓰기 교육을 하자

 

그중에서 2, 4, 5, 7장이 각각 40페이지를 차지하고 나머지는 20페이지 정도로 구성하고 있습니다. 2장 네이밍은 워낙 사례나 참고 자료가 많으니 쓸 이야기가 많았을 것이고 4, 5, 7장 역시 많이 언급되고 있는 주제입니다.

3장은 UX Writing 관련 주제라 좀 민감할 수 있습니다. 6장은 뭐 딱히 가이드가 있다기보다는 제안서는 선수들의 영역이라 가볍게 다룰 수는 있지만 깊이 들어가기는 어려운 주제입니다.

 

어쩌면 이 책의 핵심은 8장입니다. 회사에서 이런 주제로 교육을 해보라는 가이드 같지만 실은 저자의 교육 과정을 예시로 올려놓은 것에 가깝습니다.

 

'개발자를 위한 글쓰기 가이드'는 개발자 '나길동'씨와 함께 시작합니다. 한참 유행하던 '주식 천재가 된 홍대리' 스타일인가 싶은데, 어느 순간 '나길동'씨는 사라지고 45가지 원칙이 등장합니다. 2013년 출간된 '테크니컬 라이팅의 7가지 원리'에서도 7가지만 이야기하는데 45가지라니요 ㅠㅠ

물론 45가지 원칙은 대부분 간단하고 쉽게 이해할 수 있도록 구성되어 있습니다. 하지만, 책을 읽은 독자 입장에서 '개발자의 글쓰기'는 관심 있는 주제부터 읽기 시작할 수 있는 반면 '개발자를 위한 글쓰기 가이드'는 어디부터 읽어야 할지 애매할 수 있습니다.

 

구성을 다시 살펴보면

1장. 테크니컬 라이팅

2장. 개발자와 테크니컬 라이팅

3장. 문서 작성 계획 세우기

4장. 초안 작성

5장. 시각화 요소로 가독성 높이기

6장. 검토와 재작성

7장. 메일 작성

8장. 회의록 작성

9장. 오류와 확인 메시지 작성

10장. 장애 발생 공지문 작성

11장. 사용자 가이드 작성

 

여기에서는 6장 '검토와 재작성'이 전체의 30%를 차지하고 있습니다. 45가지 원칙 중에서 22개를 다루고 있는 장이라 그렇기도 하지만 너무 깊이 들어간 것이 아닌가 싶긴 합니다.

 

가볍게 다이어트 좀 해볼까 하고 책을 읽는데, 근육의 동작 원리를 다루는 것 같은 느낌이랄까요~

 

7장 '메일 작성'이나 8장 '회의록 작성'은 개발자 글쓰기와는 딱히 연관성을 찾기 어렵습니다. 그냥 기본 사회 예절이나 부서 내에서 정해진 방식을 따르면 되지 않을까 싶습니다.

 

* 올해 초에 글을 쓰다가 좀 더 보완해야지 했는데, 지금까지 이러고 있는 걸 보면 더 이상 추가할 생각이 없는 듯 하여 그냥 공개처리합니다.

 

댓글
댓글쓰기 폼