개발자의 글쓰기 정리

http://www.kyobobook.co.kr/product/detailViewKor.laf?mallGb=KOR&ejkGb=KOR&linkClass=3302&barcode=9791158391744

개발자의 글쓰기

이 책에서 필요한 부분은 [7장 - 기술 블로그 쉽게 쓰고 운영하기] 이기 때문에 이 부분만 정리를 해놓으려고 한다.

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

 

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

학생이었을 때 배운 글쓰기 방법인 논설문, 설명문을 쓰는 방법과 다르기 때문이다.

개발기는 논설문이 아니라 딱히 주제가 없다. 독자의 수준도 일정하지 않다.

개발에 적합한 세가지 방법을 제시한다.

 

1. 소재 우선 글쓰기

소재 의식은 특정한 대상이나 상황에 대한 자기만의 관점이나 생각이나 해결 방안을 뜻한다. 이런점에서 일상을 다룬 수필이나 에피소드와 비슷하다.

 

2. 자기수준 글쓰기

독자를 생각해서 어려운 용어를 일부러 해석해 풀어 쓰거나 쉬운 용어로 바꿀 필요가 없다. 필요하다면 링크를 걸어두자.

독자에게 다 설명하려 하지 말고 핵심 내용만 쓰자.

 

3. 재미있게 글을 쓰자

글쓰기 기교는 글을 아름답게 만들고 쉽게 읽히게 한다. 글에 재미가 있으면 독자가 활발히 반응하고 독자의 반응이 활발하면 블로거는 글을 계속 쓸 동력이 생긴다.

 

글의 종류별로 목차 잡는 법

기술 블로그는 크게 저, 술, 편, 집으로 나뉜다.

4가지 종류별로 글의 목차를 잡아 구조화하는 방법이 다르다.

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

 

저: 목차를 잘 잡아서 본문부터 쓰기

직접 경험한 것을 쓰는 것. 개발기라고 한다.

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

목차는 1차원 단방향이고 개발자의 경험은 2차원 양방향이라 글쓰기에 어려움을 겪는다.

핵심 방법은 최종적으로 성공한 루트와 중간에 실패한 루트를 구별하는 것이다. (예: TensorFlow를 활용한 네이버쇼핑의 상품 카테고리 자동 분류)

개발기를 쓰려는 사람이라면 처음부터 모범이 되는 글의 목차를 먼저 보면 좋다. (예: 네이버 기술 블로그)

목차를 정했으면 본문부터 쓰자.

 

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

어떤 것을 분석해 의미를 풀이하고 해석한 것이다. 성경, 불경, 성인의 말씀을 풀이한 책 등을 말한다.

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

본래 내용을 바탕으로 자기 생각이나 분석, 해설을 덧붙이는 방식을 쓰는 게 좋다.

 

편: 순서를 요약하여 쓰자

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

프로그램 설치나 설정 순서, 개발 방법, 튜토리얼, 개발자 컨퍼런스 후기 같은 것이 여기에 해당한다.

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

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

 

집: 자료를 모아 핵심을 엮어서 쓰자

내용을 많이 쓰는 것이 아니라 핵심만 간결하게 정리한 것. 글 전체가 길지 않고 내용이 각각 나열되어 있다.

명령어 모음, 팁, 00가지 규칙 등이 집에 해당된다.