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

개발자의 글쓰기, 김철수 지음

GDSC 독서 스터디를 통해 <개발자의 글쓰기>라는 책을 읽게 되었다. 이 책은 말 그대로 개발자가 작성해야 하는 여러 글, 즉 변수 네이밍부터 주석, 에러 메시지, 릴리스 문서, 장애 보고서 등을 작성하는 방법을 자세히 설명하고 있다. 그 중에서도 기술 블로그에 관한 내용이 크게 도움이 되어 기술 블로그 작성법을 다룬 7장: 기술 블로그 쉽게 쓰고 운영하기의 내용을 간략히 정리해보고자 한다. 

 

---

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

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

• 기존의 주제 우선 글쓰기, 독자 중심 글쓰기에서 벗어나기
• 기술 블로그를 쓰는 새로운 방법 3가지

1) 주제 의식을 버리고 소재 의식으로 쓰기

소재 의식: 특정한 대상이나 상황에 대한 자기만의 관점이나 생각이나 해결 방안

→ 독자와 상관없이 대상이나 상황에 맞닥뜨렸을 때부터 그 대상이나 상황에서 벗어날 때까지 겪은 일을 담담하게 정리해서 얘기하기

 

2) 독자 수준이 아니라 자기 수준으로 쓰기

굳이 비유법으로 설명하거나 독자가 이해하기 어려울 듯한 용어를 모두 다 설명할 필요는 없음. 원래 사용하는 용어로 표기하되 필요하다면 용어를 정의한 위키피디아 페이지나 세부 내용을 볼 수 있는 사이트나 문건을 링크로 걸어둘 것

→ 독자가 자력으로 공부하는 능력을 키울 수 있고 개발자도 자신이 쓰려는 글의 본질에 집중할 수 있음

 

3) 재미있게 쓰기

독자가 글을 재미있게 읽을 수 있도록 적절한 글쓰기 기교를 활용하기

→ 글이 재미있으면 독자가 활발히 반응하고 반응이 활발하면 블로거가 글을 계속 쓸 동력을 얻음

---

7.2, 7.3 글의 종류별로 목차 잡는 법 - 저술편집

• 저, 술, 편, 집 4가지 종류별로 글의 목차를 잡아 구조화하기

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

1) 저(著): 개발기는 목차를 잘 잡아서 본문부터 쓰기

2차원 양방향 경험을 1차원 단방향 목차로 바꾸기

→ 최종적으로 성공한 루트와 중간에 실패한 루트를 구분하여 최종 루트를 기준으로 목차를 잡고 남은 루트는 문제 해결이나 팁으로 정리해 덧붙이기

글을 쓸 때는 개발자가 가장 잘 쓸 수 있는 본문부터 쓰기

→ 본문 - 맺음말 - 머리말 순으로 작성하면 편함

 

2) 술(述): 원전을 비교하고 실험해 풀이해서 쓰기

원서나 원문, 프로토콜이나 레퍼런스와 같은 원전을 바탕으로 자기 생각이나 분석, 해설을 덧붙이는 방식으로 쓰기

혹은 원전의 내용을 직접 실험해 비교한 뒤 그 내용을 정리해 풀이하기

→ 옳고 그름의 관점에서 접근하기 보다는 특정 상황에서 이렇게 하는 것이 낫다는 정도로 쓴다는 생각으로 작성하기

 

3) 편(編): 순서를 요약하여 쓰기

시간 순서로 하나씩 나열해 내용을 쓴 다음 단계로 묶어서 하위 내용을 간략히 요약하기

→ 처음부터 글을 구조화하는 것은 쉽지 않으므로 우선 본인이 한 일을 쭉 나열하고 그 내용을 쓴 뒤 내용을 단계로 묶고 각 단계에 속한 내용을 요약하는 식으로 작성하기

 

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

자료나 견해에서 요점이 되는 것을 모아 핵심만 간결하게 정리하기

→ 반드시 여러 사람의 견해나 자료를 모아야만 하는 것은 아님. 본인이 경험에서 터득한 것을 핵심만 정리해서 나열해도 좋음 

 

---

http://www.yes24.com/Product/Goods/79378905

개발자의 글쓰기 - YES24