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

JueunPark·2021년 12월 6일
0

테크니컬라이팅

목록 보기
1/2
post-thumbnail

개발자의 글쓰기

책의 내용 요약

소재의식으로 쓰자

일반적인 글쓰기(우리가 학교에서 배우는)기술문서
글의 종류논설문수필, 설명문
글을 쓰는 목적주제의식(주장을 펼친다.)소재의식(소재에 대해 설명한다.)
글의 성격추상적구체적
  • 기술블로그에 글을 쓰는 것은 보통 우리가 알고 있는 글쓰기와 다르다.
    • 글을 쓴다는 것은 주제의식에서부터 시작한다고 배웠다.
    • 그러나 기술문서는 주제대신 소재를 가지고 있다.
  • 글을 쓰는 이유/목적
    • 일반적인 글쓰기(논설문 등)
      • 주장을 펼치기 위해
    • 개발자의 글쓰기(설명문 등)
      • '상황을 맞닥뜨린 순간 ~ 상황에서 벗어날 때'까지 겪은 일을 정리하는 것이 목표이다.

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

  • 독자수준의 글쓰기
    • 글을 쉽게 쓰려고 할 때 나타나는 글쓰기 방법
      1. 비유법을 사용한다.
        • 비유법은 얕은 이해에 적합함
          • 어떤 것의 원리를 간접적으로 이해하는 데에는 도움이 됨
          • 깊은 이해에 적합하지 않음
      2. 모든 것을 설명하려한다.
        • 예시: 반응형 웹에 대해 설명하기 위해 CSS를 설명함
          • 글이 늘어짐
          • 어려운 용어를 풀어쓰려고 함
  • 자기수준의 글쓰기
    • 글을 쉽게 쓸 필요가 없는 이유
      1. 기술블로그란 결국 실력이 비슷한 독자를 위한 것
      2. 개발자가 사용하는 용어는 이미 표준이거나 관습인 경우가 대부분임
        1. 어려운 용어는 직접 설명할 필요없이 링크를 달아주는 방법도 있음

재미있게 쓰자

  • 재미있는 글쓰기의 효과
    • 경험이 적절히 가미된 글쓰기는 글을 생기있게 만든다.
    • 글이 재미있다. → 독자의 반응이 활발히 일어난다. → 글쓴이는 글을 쓸 동력을 얻는다.

느낀점

  • 다큐멘터리에 비유
    • 감독은 주제의식을 가지고 다큐멘터리를 만든다. 단순한 정보를 전달하는 영상을 다큐멘터리라고 부를 것인가에 대한 논란의 여지가 있다.
    • 개발자의 글쓰기는 정보의 전달을 목적으로 한다는 점에서 비슷하다. '이번에 새로 등장한 기술이 이런저런 이유를 들어 좋다.'는 의견이 들어갈 수도 있지만, 반드시 주제를 가질 필요는 없다는 점에서 다큐멘터리와 다르다.
profile
노트정리

0개의 댓글