[책] 개발자의 글쓰기 (중간 감상평)
Note
책의 다른 부분들도 유용하고 읽어볼만한 부분이 많지만, 일단 나에게 당장 필요한 부분을 적어놓겠다.
기술 블로그를 쉽게 쓰는 방법 3가지
개발자가 기술 블로그를 잘 못쓰는 이유는, 어릴 때부터 배워온 글쓰기와 쓰는 방식이 다르기 때문이라고 한다. 학생일 때는 논설문, 설명문을 주로 쓰는데, 논설문이나 설명문은 목적이 분명해야 해서 글쓰기가 문제해결 과정이 되고, 해결 방안을 전략적으로 선택해야 하는 문제가 된다고 한다.
그러면 주제 의식이 분명해야 하고 독자를 분석해서 글의 수준이나 방향을 정해야 한다.
이런 식의 주제 우선 글쓰기, 독자 중심 글쓰기, 주장하는 글쓰기가 개발자의 글쓰기를 방해한다.
개발기 같은 건 딱히 주제라고 할만한 것도 없고, 기술 블로그를 읽는 독자 수준도 일정하지 않으며, 딱히 주장도 없다.
저자는 개발자에게 적합한 방법 3가지를 제시한다.
- 소재 우선 글쓰기
- 자기 수준 글쓰기
- 재미있는 글쓰기
주제 의식 아닌 소재 우선 글쓰기
주제 의식이 아니라 소재 의식을 갖고 쓰기. 소재 의식은 특정한 대상이나 상황에 대한 자기만의 관점이나 생각이나 해결 방안을 뜻한다.
ex. 우아한형제들 기술 블로그에 “데이터베이스의 자동증가 값을 기본키로 사용할수 없을 떄는?” 같은 글.
독자 수준 아닌 자기 수준 글쓰기
직장에서 하는 일을 초등학생이 이해할 수 있게 풀어서 글을 쓸 수 있는 사람은 없다고 단정하는 단호박 저자.
아무튼 초등학생도 이해할수 있게 설명하는건 구글 면접 문제로 나올정도로 어려운 문제라고 주장한다.
뭐 어려운 용어 같은거 있으면 링크라도 걸어주던가, 굳이 일일이 설명할 필요는 없다고 한다.
재미있게 글을 쓰자
위키피디아처럼 쓰지말고 나무위키처럼 쓰라고 한다. 무슨 의도인지는 알겠는데 하필 비유를..
글의 종류별로 목차 잡는법
여기도 유용한 부분. 제목부터 요약이 아주 잘되어있어 제목은 그대로 옮기겠다.
기술 블로그의 4종류, 저, 술, 편, 집
개발자의 글들은 매우 다양하지만 모두 위에 4가지에 해당한다는듯. 4가지 종류별로 글의 목차를 잡아 구조화하는 방법을 설명해주겠다고 한다.
저: 개발기는 목차를 잘 잡아서 본문부터 쓰자
저는 직접 경험한 것을 쓰는 것. 개발 과정과 결과를 쓴 개발기
ex.
- Tensorflow를 활용한 네이버쇼핑의 상품 카테고리 자동 분류
- Dagger 적용기
- 분산 웹 캐시의 개선 과정
개발자의 경험은 삽질을 겪으며 2차원 양방향이 되기 때문에 1차원으로 바꿔주는 작업이 필요한데, 핵심 방법은 성공한 루트와 실패한 루트를 구별하는 것!
목차를 먼저 쓰자. 목차를 써놓고 본문을 먼저 쓰자. 머리말은 기획자들이나 잘 쓰지 개발자는 잘 못쓴다.
ex. “Tensorflow를 활용한 네이버쇼핑의 상품 카테고리 자동 분류“
저자가 여기서 갑자기 네이버 기술 블로그 칭찬을하는데, 뭐.. 인정할건 인정한다만, 대기업 테크니컬 라이터들이 실력이 좋긴 좋지~
술: 원전을 비교하고 실험해 풀이해서 쓰자
우리가 서점에서 사서 읽는 논어 같은 인문학 도서는 거의 술이다
개발에서 술은 새로운 기술을 자세하게 또는 비유해 설명한 것, 비슷한 용어를 비교해 풀이한 것, 에러 해결 방법 등.
ex.
- GET과 POST의 차이
- MySQL 1175 에러 해결 방안
원서나 원문, 프로토콜이나 레퍼런스를 바탕으로 자기 생각을 일부 덧붙이는 방식으로 쓰자.
편: 순서를 요약하여 쓰자
편은 산만하고 복잡한 자료를 편집해 질서를 부여한 것… 보통 편은 시간 순서로 일어난 일이나 해야 할 일을 쓴 것을 통칭.
프로그램 설치, 설정 순서, 개발 방법, 튜토리얼, 개발자 컨퍼런스 후기같은것
ex.
- ES2015 단위 테스트 환경 구축하기
- 간단하게 구축해보는 JavaScript 개발 환경
- Ubuntu의 apt-get 명령어 정리
편을 쓰는건 저술보다 쉽다고 한다. 시간 순서로 하나씩 나열해 내용을 쓴 다음, 단계로 묶어서 요약하기만 하면 글이 완성되기 때문. ‘저‘ 랑 조금 헷갈리긴 하는데.. 비교하자면 ‘저‘는 개발자의 경험이 주가 되는거고, ‘편’은 보편적인 튜토리얼같은 느낌인듯
‘서울 강남에서 벗어난적 없는 사람에게 기차 타고 부산 해운대에 가는 방법을 알려주는‘ 느낌이라고 한다. 편은 거기에 단계를 더함으로써 좀 더 질서있게 보여주는 방식인데, 할일을 순서대로 하나씩 얘기하는게 아니라 적정한 단계로 나눠서 설명하는 것.
쉽게말하면 목차에 depth가 생기는 느낌. 국사 교과서 만들듯이 하란다.
집: 글쓰기가 두렵다면 자료를 모아 핵심을 엮어서 쓰자
비슷한 책을 한데 모아 출간한 것을 전집 이라고 한다. 마찬가지로 여러 자료를 모아 엮으면 된다. 명령어 모음, 팁, OO 가지 규칙 등
ex.
- 자바스크립트 정규표현식 코딩팁
- 좋은 코딩을 위한 13가지 간단한 규칙
- 데이터 사이언스 인터뷰 질문 모음집
그냥 본인 경험에서 터득한걸 핵심만 정리해서 나열해도 좋은 집이 될수 있다. 미디엄에 흔히 올라오는 “13 Simple Rules for Good Coding…” 같은것들.
이런게 쓰기도 쉽고 조회수도 높다고 한다. 어쩐지 제목에 이끌려서 들어가면 사실 알맹이가 별로 없는 글이 많다 싶었다..
책의 나머지 부분은 기회가 되면 추가로 정리해서 올려놔야겠다. 일단 이것들을 잘 숙지해서 블로그에 양질의 글을 마구 올리고 싶다.