📝 김철수님의 '개발자의 글쓰기'를 읽고 정리한 글입니다. 문제가 될 경우 삭제 조치하도록 하겠습니다.

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

1.1 개발자가 기술 블로그를 잘 못 쓰는 이유

개발자가 기술 블로그를 잘 못쓰는 이유는 학생 때 배운 글쓰기 방법이 논설문이나 설명문을 쓰는 방법이었기에 목적이 분명해야 했다.

논리에 부족함이 있으면 근거가 완벽해질 때까지 글을 쓰지 못한다. 또한 독자가 전문가인지 비전문가인지 확인하는데 시간이 많이 소요되기에 개발자는 기술 블로그를 잘 못쓴다.

1.2 첫째, 주제 의식을 버리고 소재 의식으로 쓰자

주제 의식이 아닌 수재 의식으로 작성하자. 주제 의식이란 자존감, 자본주의 같은 추상적 가치를 기반이라면 소재 의식은 특정한 상황에 대한 자기만의 관점이나 생각, 해결 방안을 뜻한다.

즉 소재 의식은 독자와 상관없이 특정 상황에 맞닥뜨렸을 때부터 해결할 때까지의 일을 정리해서 작성하면 된다. (문제 해결)

~로 인해 ~상황이 발생했고 그 상황을 ~방식으로 해결한 내용

1.3 둘째, 독자 수준이 아니라 자기 수준으로 쓰자

구글 면접 중에 이런 질문이 있었다. “8살 조카에게 데이터베이스를 3문장으로 설명하기” 이러한 질문에 대한 답변은 공통점이 있는데 바로 비유법이다.

구글이 이런 질문을 한 것만 봐도 기술 용어를 초등학생이 이해할 수 있도록 기술 블로그를 작성하는 건 엄청 어려울 것이다. 무엇보다 쉽게 작성한다고 해서 독자가 얼마나 활용할 수 있을지는 알 수 없다.

나는 일단냥 앱에 디자이너가 합류해서 개발 과정을 공유하고 있는 중인데 블로그 글을 작성할 때 수준을 어떻게 맞춰야 하는지 항상 고민이었다. 여기서 설명한 팁처럼 내 수준대로 글을 작성하고 따로 설명을 해주는 게 좋을 것 같다.

여기서 알 수 있듯이 기술 블로그를 작성할 때 어려운 기술 용어를 풀어서 설명할 필요는 없다. 관련된 링크를 걸어두면 필요한 독자만 보고 가독성도 올라갈 것이다.

기술 블로그란 결국 실력이 비슷한 독자를 위한 것임을 잊지 말자.

1.4 셋째, 재미있게 글을 쓰자

글쓰기 기교는 글을 아름답게 만들고 쉽게 읽히게 한다. 좋은 기술 블로그는 개발자의 경험에서 우러나오는 내용을 적절한 글쓰기 기교로 녹아낸 것이다. 독자가 저자의 경험을 온몸으로 공감하고 끄덕이게 만들어야 한다.

2. 글의 종류별로 목차 잡는법 - 저술

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

개발자가 기술 블로그의 쓰는 글의 종류는 매우 다양한데 이는 크게 저, 술, 편, 집 4가지로 나뉜다.

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

2.2 저 : 개발기는 목차를 잘 잡아서 본문부터 쓰자

개발 과정과 결과를 쓴 개발기가 저에 해당한다.

ex)

• TensorFlow를 활용한 네이버 쇼핑의 상품 카테고리 자동 분류
• Dagger 적용기
• …

개발기는 목차만 제대로 잡으면 다른 종류의 글보다 쓰기 쉽다.

문제 해결 과정인 2차원 양방향 경험을 목차인 1차원 단반향으로 바꾸는 핵심 방법은 성공한 루트와 실패한 루트를 구별하는 것이다.

1. 개발 모델(최종 루트)
2. 개발 과정에서 발견한 문제와 해결 방법(경험 루트)

그리고 머리말을 먼저 쓰는 것보다 개발자가 제일 잘 쓸 수 있는 본문을 먼저 쓰자. 머리말은 마지막에 블로그에 올릴 때 생각나는 대로 간략히 적는 게 좋다.

2.3 술 : 원전을 비교하고 실험해 풀이해서 쓰자

어떤 것을 분석해 의미를 풀이하고 해석한 게 술 이다.

새로운 기술을 자세하게 또는 비유해 설명한 것, 비슷한 용어를 풀이한 것, 에러 해결법이 해당한다.

ex)

• GET과 POST의 차이
• …

인문학 경전이 있는 것처럼 개발에도 원서, 원문, 레퍼런스가 있다. 그렇기에 술에 해당하는 글을 쓸 때는 자기 생각이나 분석, 해설을 덧붙이는 게 좋다.

예시로 GET과 POST의 차이에 대한 목차를 보자

1. HTTP
2. GET
3. POST
4. GET과 POST의 차이
5. 참고

여기서 개발자가 실제로 쓴 글은 4장뿐이며 나머지는 참조한 HTTP 프로토콜 문서의 내용을 정리한 것뿐이다. 이렇게 원전의 내용을 먼저 쓰고 비교한 내용을 추가하는 것으로 기술 블로그를 쉽게 쓸 수 있다.

결국 기술 블로그는 경전을 쓰는게 아닌 경전을 자기 방식으로 풀이하는 것이다.

2.4 편 : 순서를 요약하여 쓰자

산만하고 복잡한 자료를 편집해 질서를 부여한 것이 편 이다.

ex)

• ES2015 단위 테스트 환경 구축하기
• apt-get 명령어 정리

편은 시간 순서로 하나씩 나열해 내용을 쓴 다음 단계로 묶어 요약하기만 하면 글이 완성된다.

1. 일단 먼저 시간 순으로 내용을 나열한다.
2. 나열한 목록을 단계로 나눠서 목차로 만든다.

2.5 집 : 글쓰기가 두렵다면 자료를 모아 핵심을 엮어서 쓰자

여러 사람의 견해나 흩어진 자료를 모아 정리하는 것이 집 이다.

집은 내용을 많이 쓰는 게 아니라 핵심만 간결하게 정리해야 한다.

ex)

• 자바스크립트 정규표현식 코딩팁
• 좋은 코딩을 위한 13가지 간단한 규칙

기술 블로그를 처음 쓰는 개발자가 가장 쉽게 도전할 수 있고 조회수가 높다. 초보 개발자가 많고 이들이 검색도 더 많이 하기 때문이다.

반대로 개발 경험을 다룬 저술을 쓰기가 어렵다. 자세히 쓰면 지루하고 간단히 쓰면 이해하기 어렵기 때문이다. 그렇기에 개발자의 수준을 보여주며 유명 IT기업에는 개발기가 많이 올라와 기업의 기술 수준이 높다는 것을 보여주는 것이다.

3. 기업의 기술 블로그 운영 팁

3.1 기술 블로그는 회사의 가치를 높인다

기업의 기술 블로그는 공공기관이 보도자료를 언론사에 배포하는 것과 비슷하게 괜히 잘못 써서 욕먹지 않을까 하는 두려움이 앞선다. 그래서 IT 기업은 많은데 제대로 된 기술 블로그를 운영하는 기업은 적다.

반면 기술 블로그를 운영하는 기업은 아래의 3가지 이유 때문에 늘고 있다.

첫째, 개발 능력이 우수한 개발자 채용에 도움을 준다.

기술 블로그를 운영할 정도라면 그 회사의 개발자 수준이 높다는 뜻이며 이는 사람들을 모이게 한다. 또한 구체적으로 어떤 개발을 하고 어떤 문화를 가졌는지 알 수 있어 구직자가 자신에게 적합한지 판단할 수 있다.

둘째, 개발 과정에서 생긴 노하우를 체계적으로 축적할 수 있다.

스타트업은 사내 문서 관리 체계가 미흡할 수밖에 없다. 노하우를 정리할 곳이 마땅찮고, 동료나 선후임에게 전달할 방법도 딱히 없다. 하지만 기술 블로그를 작성하면 개발 과정과 결과, 노하우를 축적할 수 있다.

셋째, 개발자 스스로 공부하게 만든다.

기술 블로그에 글을 쓰려면 지식을 체계화하는 과정이 필요한데, 이 과정에서 개발자는 사용 기술을 재확인하면서 실력이 는다.

3.2 기술 블로그도 투자를 해야 살아난다

투자를 하지 않으면 기술 블로그가 활성화되지 않는다. 기술 블로그를 광고 매체로 생각해 독자에게 홍보하며 방문자를 늘리고 기술 블로그에 활력을 넣어줘야 한다.

3.3 개발자의 글쓰기는 회사의 문화를 반영한다

기업의 기술 블로그는 개인 블로그와 달리 기본 체계를 갖춰야 하고 일정한 수준이 보장돼야 한다.

우하한형제, 네이버, 카카오 기술 블로그를 보면 딱딱하게 쓰거나 가볍게 쓰거나 기업마다 성격이 다르다. 이는 기업 문화의 차이에서 기인한다.

따라서 회사의 글쓰기 문화가 없다면 그것부터 정해야 개발자들이 글을 어떻게 쓸지 알 수 있다.

3.4 협업해서 글쓰기, 짝 글쓰기를 해보자

프로그램을 동료와 협업해서 작성하는 것처럼 기술 블로그도 동료와 작성해 보자.

글의 완성도, 지식의 보편화, 팀 회고, 심리적 안정감, 팀워크 향상에 도움이 된다.

4. 7장을 읽으며 느낀 점

• 기술 블로그는 주제 의식이 아닌 소재 의식으로 작성하자
• 독자의 수준을 생각하지 말고 자기 수준으로 작성하자
• 내 경험을 녹여 재미있게 작성하자
• 개발기는 본문, 꼬리말부터 작성하고 머리말은 마지막에 작성해 보자
• 기업에서 기술 블로그를 잘 작성하면 큰 홍보가 된다.