GDSC/[READING] 개발자의 글쓰기

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

Hanee_ 2021. 10. 30. 14:10

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

 

1. 주제 의식을 버리고 소재 의식으로 쓰자

 

주제의식 소재의식
추상적가치 특정한 대상이나 상황에 대한 자기만의 관점이나 생각, 해결방안
많은 사람에게 보편적인 주제를 선택해서 더 많은 사람들에게 주제 의식을 퍼뜨리는 것 독자와 상관없이 대상이나 상황에 맞닥뜨렸을 떄 부터 그 대상이나 상황에서 벗어날 떄 까지 겪은 일을 담담하게 정리

기술 블로그-> 일상을 다룬 수필이나 에피소드처럼 작성하자

 

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

개발자가 기술 블로그를 쓸 때는 독자를 생각해서 어려운 용어를 일부러 해석해 풀어쓰거나 쉬운 용어로 바꿀 필요가 없다.

3. 재미있게 글을 쓰자

 

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

기술 블로그릐 4종료, 저, 술, 편, 집

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

 

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

저는 직접 경험한 글을 쓴 것이다.  2차원 양방향 경험을 1차원 단방향 목차로 바꾸는 핵심 방법은 성공한 루트와 실패한 루트를 구분하는 것이다. 

성공한 루트와 실패한 루트 구별할 것

갔던 길을 돌아오거나 둘러갔던 루트들은 최종 루트 다음에 문제해결이나 팁으로 정리해 덧붙인다.

 

  • 개발과정과 결과를 다룬 개발기를 쓸 때는 무엇보다 목차를 잘 구성해야한다. 
  • 개발자가 가장 잘 쓸 수 있는 내용은 본문이다. 목차를 정했으면 머리말 부터 쓰지 말고 본문부터 쓰자. 개발이 완료되면 아키텍쳐나 알고리즘 등의 산출물 이미지를 먼저 붙여넣고 글을 쓰면 더 수월하다. 

 

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

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

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

ex. get post 차이, mySQL Ascending index vs. Descending index

 

원전은 사물 하나하나를 설명할 뿐, 두 사물 사이의 공통점이나 다른점을 뚜렷이 밝히지는 않는다. 그래서 원전의 두 용어나 대상을 비교하면서 풀이하는 것이 바로 술의 역할이다. 

 

예문의 목차

1. HTTP

2. GET

3. POST

4. GET과 POST 차이

5. 참고

 

개발자의 기술 블로그는 어떤 경우에도 모두 통용되는 완ㅂㄱ한 답이나 공식을 낼 수 없다. 단지 특정한 상황에 적합한 방법을 찾아내고 추천하기 때문에 특정 상황에서 이렇게 하는 것이 낫다는 정도라만 쓴다고 생각하면 부담이 덜 할 것이다.

 

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

3. 편 : 순서를 요약하며 쓰자

편: 산만하고 복잡한 자료를 편집해 질서를 부여한 것. 보통 시간 순서로 일어난 일이나 해야 할 일을 쓴 것을 통칭한다.

ex. 사용하면서 알게 된 Reactor, 예제 코드로 살펴보기, ubuntu의 apt-get명령어 정리

 

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

 

 

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

집 : 여러사람의 견해나 흩어진 자료를 한데 모아 정리하는 것

집은 내용을 많이 쓰는 것이 아니라 핵심만 간결하게 정리한 것이다. 집이라고 해서 반드시 여러 사람의 견해나 자료를 모아야하만 하는 것은 아님

 

04. 기업의 가술 블로그 운영 팁

 

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

Reason 1. 채용 직무에 적합하면서 개발 능력이 우수한 개발자 채용에 도움을 준다. 
Reason 2. 개발 과정에서 생긴 노하우를 체계적으로 축적할 수 있다.
Reason 3. 개발자가 스스로 공부하게 만든다.  

 

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

기업의 기술블로그 = 광고 매체 로 생각해야 한다.

 

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

개발자의 글쓰기 원칙이나 수준을 정하기 전에 회사의 글쓰기 문화를 먼저 정의해야한다. 


협업해서 글쓰기, 짝 글쓰기를 해보자
짝 글쓰기는 두명이 글 하나를 같이 쓰는 방식이다. 짝 글쓰기를 하면 다음과 같은 이점이 있다.

  1. 글의 완성도가 높아진다.
  2. 지식을 보편화할 수 있다
  3. 팀 회고를 할 수 있다
  4. 심리적 안정감을 느낀다. 

구체적으로 짝 글쓰기를 하는 방법은 다음과 같다

  • Driver & Navigator : 한 명은 글을 쓰고, 다른 한 명은 글을 검토
  • Coder & Adviser : 한명은 글을 쓰고, 다른 한명은 조언
  • Verbalizer & Listener :  한 명은 글을 읽고, 다른 한 명은 귀로 들음
  • Ping-Pong : 번갈아 가면서 글 작성