개발자의 글쓰기

Jun 3rd 2021 by jyoon

블로그를 쓰면서 주제 의식 방법으로 많이 썼다. 이 방법은 공식문서와 다를 바가 없다고 생각한다. 지금까지의 블로그를 쓸 때 지식습득을 위해서 이 방법을 많이 선택했다. 이 방법으로 언어에 대해서 개발에 대해서 개발자로 성장했던 건 분명하다. 요즘, 이 것 보다 다음에는 어떤 종류의 글을 쓰면 고민이 많았는데 개발하면서 발생했던 것들에 관해서 이야기를 쓰고 싶었는데 바로 그 방법이 책에서 소개하는 소재 의식이였다.

주제 의식 보다는 소재 의식으로 글을 쓰자

소재의식 글쓰기란 개발하면서 야크쉐이빙, 에피소드, workaround 같은 주제를 선정해서 작성하는거라고 생각하면 되겠다.

구체적으로 기술 블로그를 쓰는 방법이 4가지가 있는데 아래에서 살펴보도록 하자.

기술 블로그의 4종류

  • 저, 술, 편, 집 이렇게 네가지고 구분 할 수 있겠다.
  • TL; TD

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

  • 개발기, 도입기, 적용기 등을 쓰는 것으로 글을 좀 써본 개발자라면 도전해볼 만한 주제 방식이다.

  • 원서, 원문, 공식문서를 바탕으로 분석,해설
  • 사람은 어떤 사물을 그 자체로 인식하기보다는 다른 사물과 비교하면서 인식 할 때 더 잘 이해한다.

    • 공식문서(레퍼런스)는 사물 하나하나를 설명할 뿐 두사물 사이의 공통점이나 다른 점을 뚜렷이 밝히지 않는다.
    • 그래서 원전의 두 용어나 대상을 비교하면서 풀이하는 것이 바로 술의 역할이다.
  • 예를 들어 시스템 성능을 높이기 위해 여러가지 실험을 많이 하므로 그 결과를 잘 정리하기만 해도 좋은 글이 된다.
  • 기술 블로그를 쓰는 개발자는 공식문서(레퍼런스)을 쓰는 사람이 아니라 공식문를 자기 방식으로 풀이하는 것이다.

    • 옳고 그름의 문제가 아니라 특정 상황에서 이렇게 하는게 아니라 낫다는 정도로만 쓴다고 생각하면 부담이 덜한다

  • 처음에는 구조를 생각하지 말고 본인이 한 일을 쭉 나열하고 그 내용부터 쓰자.
  • 그 다음에 내용을 단계로 묶은 뒤 각 단계에 속한 내용을 요약하자. 이렇게 써야 글쓰기가 진행된다.

  • 핵심만 간결하게 정리(내용을 많이 쓰지 않는다)

    • JS 정규표현식 코딩팁
    • 스크롤과 관련된 CSS 속성 3가지
    • 좋은 코딩을위한 13가지 간단한 규칙
    • 데이터 사이언스 인터뷰 질문 모임집

정리

    • 가장 쉬운 글쓰기 방법
    • 이미 알고 있거나 쉽게 찾을 수 있는 자료를 모아서 나열, 일정한 순서와 단계로 엮기만하면 된다.
    • 글을 좀 써본 개발자라면 도전 하자

참고 블로그