[개발자의 글쓰기] 7장. 기술 블로그 쉽게 쓰고 운영하기

이 글은 "개발자의 글쓰기"를 읽고 좋은 구절들을 기록하거나 느낀 점을 기록하는 글입니다.

개발자의 글쓰기

 

 

7장의 내용이 궁금해서 이 책을 읽었는데 정말 마지막에 있었다... 길고 길었지만 마지막 장을 정리한다.

 

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

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

소재 의식이란 특정상 대상이나 상황에 자기만의 관점이나 생각이나 해결 방안을 말하는 것이다.

 

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

보통 어려운 글을 쉽게 설명할 때 비유법을 많이 사용한다. 하지만 비유법은 한계가 있다.

그 원리에 대해 간접적으로 이해한 것으로는 실제로 사용할 수가 없다.

독자를 생각해서 어려운 용어를 해석해 풀어쓰거나 쉬운 용어로 바꿀 필요가 없다.

그대로 사용하되 필요하다면 용어를 정의한 자료를 링크로 걸어두는 것이 좋다.

핵심 내용만 쓰고 나머지는 독자가 공부할 수 있게 길을 터놓는 것이 현명한 방법이다.

 

셋째, 재미있게 글을 쓰자

좋은 기술 블로그는 개발자의 경험을 적절한 글쓰기 기교로 녹아낸 것이다.

재미없게 글을 작성하면 독자들이 글에 대해 아무 반응이 없으니 얼마 못 가서 블로그를 접는다.

나도 글을 재밌게 작성하려고 하지만 그 부분이 제일 힘들다. 언젠가는 반응이 오지 않을까..

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

기술 블로그에 쓰는 글의 종류는 크게 4가지로 분류한다.

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

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

개발을 할 때의 성공한 루트와 실패한 루트를 구별하는 것이다.

성공한 루트를 기준으로 목차를 작성하면 된다. 실패한 루트는 문제 해결이나 팁으로 덧붙이면 된다.

본문을 먼저 작성하고 머리말을 작성하자. 머리말은 생각나는 대로 간략히 적는다.

 

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

새로운 기술을 자세하게 또는 비유해 설명한 것이다.

비슷한 용어를 비교하거나 에러 해결 방법 등이 해당한다.

 

글을 작성할 때 원서나 원문의 내용을 바탕으로 자기 생각이나 분석, 해설을 덧붙이는 방식으로 쓰는 것이 좋다.

 

3. 글의 종류별로 목차 잡는 법 2 - 편집

1. 편: 순서를 요약하여 쓰자

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

시간 순서대로 나열해 내용을 쓴 다음, 단계로 묶어서 요약하면 된다. 

단계를 만들어서 묶은 뒤 하위 내용을 간략히 요약한다. 

 

처음부터 전체 내용을 구조화해서 목차를 작성하기 어려우니

일들을 쭉 나열하고 그 내용부터 쓰자.

 

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

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

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

글 전체가 길지 않고 내용이 각각 나열되어 있다.

 

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

개발에서 짝 프로그래밍이 있듯이 글쓰기에도 짝 글쓰기가 있다. 

두 명이서 글 하나를 같이 쓰는 방식이다. 여러 가지의 장점이 있다.

1. 글의 완성도가 높아진다.
   서로 독자 관점이 되어 질문과 답변을 하면 완성도가 높아진다.
2. 지식을 보편화할 수 있다.
   두 명의 공통된 지식 체계를 만들 수 있어 사내 다른 개발자에게 쉽게 전달할 수 있다.
3. 팀 회고를 할 수 있다.
   개발 과정이나 결과를 글로 쓰면 자연스럽게 회고가 가능하다.

짝 글쓰기를 하는 방법은 짝 프로그래밍에서 사용하는 방법으로 하면 된다.

• Driver & Navigator
  한 명은 글 쓰고 한 명은 검토한다.
• Coder & Adviser
  한 명은 글 쓰고 한명은 조언한다.
  조언자는 글쓰기 수준이 비교적 높은 사람이 한다. 
• Verbalizer & Listener
  글을 쓰고 난 뒤 한명은 글을 일고 다르 한명은 귀로 듣는다.
  글을 읽으면 부자연스러운 문장, 읽는 것을 들을 때는 어색한 문장이나 표현이 거슬린다.
• Ping-pong
  두 명이 번갈아 가면서 글을 쓴다.
  목차 단위로 나누거나, 한 명은 예제 코드를 쓰고 다른 한 명은 예제 코드를 설명하는 식 등