[독서 리뷰] 개발자의 글쓰기 - 김철수

【 책을 읽게 된 계기 】

블로그를 운영하면서 또는 업무를 하면서 글을 자주 쓰는데 글을 잘 쓰고 싶었다. 글을 잘 쓴다는 것은 목적에 따라 누가 읽느냐에 따라 글쓴이가 전달하고자 하는 메시지를 이해하기 쉽게 전달하는 것으로 생각한다. 글 잘 쓰는 개발자는 어떻게 글을 쓰는지 궁금해서 읽게 되었다.

【 책 & 저자 소개 】

저자 김철수

 

한양대 국문과를 졸업하시고 개발자, 기획자, 컨설턴트, 강사 등으로 벤처에서 대기업까지 다양한 회사와 직종에서 20년을 일하셨다.

 

 

【 감명깊은 글귀 】

 

변수 이름을 잘 짓는 법 SMART

easy to Search       검색하기 쉽고
easy to Mix             조합하기 쉽고
easy to Agree         수긍하기 쉽고
easy to Remember 기억하기 쉽고
easy to Type           입력하기 쉽고

[출처] 개발자의 글쓰기

여러명의 개발자가 한 프로젝트를 진행한다고 했을 때 필요한 변수를 찾기위해서는 검색은 필수이다. 검색만 잘해도 많은 시간을 절약할 수 있다.

 

변수명을 정하다 보면 단어를 조합하게 되는데 공통된 카테고리의 단어는 태그를 만들어 접두어로 사용하자. 복잡성은 줄이고 규칙적으로 변수명을 지을 수가 있다.

 

코드의 유효범위가 좁고 직관적으로 알 수 있다면 굳이 명칭을 전체 적을 필요가 없다. 예를 들어 for문에 index를 i로 이름을 지을 수 있다.

 

개발자는 변수명을 짓고 모든 변수명을 기억 못할 확률이 높다. 따라서 보편적으로 쓰는 이름은 그대로 사용하면 기억하는 데 큰 도움이 된다.

 

오타를 낼 가능성이 큰 단어는 피하는 것이 좋다. 예를 들어 연속된 철자 successes, 묵음 lambda 등이 있다. 

 

 

기술 블로그를 쉽게 쓰는 방법 3가지

첫째, 주제 의식을 버리고 소재 의식을 쓰자
둘째, 독자 수준이 아니라 자기 수준으로 쓰자
셋째, 재미있게 글을 쓰자

[출처] 개발자의 글쓰기

주제 의식이 권선징악이나 계몽주의 같은 추상적인 가치를 기반으로 쓴 글이라면 소재 의식은 저자가 특정한 상황과 대상에 대한 본인만의 관점이나 견해 또는 해결 방안을 쓴 글이라고 한다. 구체적으로 일상을 다룬 수필이나 경험담과 비슷하다. 결국 단순 지식 전달보다는 살아있는 경험담을 통해 배운 점을 전달할 수 있는 글을 적어야 하겠다는 생각이 들었다.

 

통상 글쓰기 전문가들은 어려운 내용을 비유법을 통해 쉽게 풀어 설명하고는 한다. 하지만 기술 블로그의 경우는 어려운 용어를 굳이 풀어서 설명하기보다는 용어를 정의한 위키피디아 페이지 같은 문건을 링크를 걸어두는 두라고 한다. 다양한 독자의 지식수준을 고려하다가는 글의 핵심 내용을 전달하기가 어려워질 수 있다. 

 

블로그는 논문이나 기술 메뉴얼처럼 딱딱한 글을 쓰는 곳이 아니다. 마음껏 자신의 경험을 녹여내거나 글의 기교를 부려 글을 읽는 사람들에게 재미를 선사하도록 하자. 

 

 

기술 블로그의 4종류, 저, 술, 편, 집

구분	내용	종류
저 著	직접 경험하고 실험한 과정이나 결과	개발기, 도입기, 적용기
술 述	어떤 것을 분석하여 의미를 풀이하고 해석한 것	기술 소개, 용어 분석, 에러 해결 방법 등
편 編	산만하고 복잡한 자료를 편집해 질서를 부여한 것	프로그램 설치/설정 방법, 튜툐리얼, 세미나 후기, 책 리뷰
집 輯	여러 사람의 견해나 흩어진 자료를 한대모아 정리한 것	명령어 모음, 팁, 00가지 규칙

[출처] 개발자의 글쓰기

 

개발자가 가장 쓰기어려운 부분은 머리말이다. 숲을 보기 전에 나무부터 써보자. 예를 들어 직접 경험한 글을 본문에 먼저 쓰고 맨 마지막에 머리말을 쓰는 것도 방법이다.

 

글을 읽는 이는 어떤 사물을 그 자체로 인식하기보다는 다른 사물과 비교했을 때 이해가 잘되는 편이다. 예를 들어 HTTP 프로토콜에 나온 GET과 POST의 차이를 비교하면서 설명하면 독자의 이해력을 높일 수 있다.

 

산만하고 복잡한 자료는 읽고 싶은 글이 아니다. 따라서 이와 같은 자료를 편집해 질서를 부여하여 읽고 싶은 글로 탈바꿈하자. 글에는 '기승전결'이 있다. 

 

우리는 전집을 여러 작가의 견해와 비슷한 내용의 책을 요약하여 하나의 책으로 엮은 것이고 한다. 다양한 시각과 나의 시각을 합하고 요약하여 힘 있는 글을 작성하자. 

 

【 총평 】

개발자로서 작성해야 할 글의 종류가 다양하다는 것을 새삼 깨달았다. 내가 아는 개발자들은 글 쓰는 것을 좋아하지 않아 하는 것 같다. 하지만 피할 수 없다면 이 책을 보는 것이 큰 도움이 되리라 믿는다. 나의 경우는 한번 읽어서는 모든 내용을 이해하기 어렵겠다는 생각이 들었다. 만약 관련 문서를 작성하게 된다면 이 책을 다시 찾을 것 이다.

 

글을 쓰는데 두려움이 큰 개발자에게 추천하는 책이다.