[Udemy] 기술블로그로 알아보는 테크니컬 라이팅 후기

이 글은 유데미로 부터 강의 쿠폰을 받아 작성하였습니다.

작년 12월 좋은 기회로 글또 9기를 참여하게 되었다.

글또에서 스스로 활동을 통해 큰 성장을 이루고자 하는 것이 내 목표였는데,

마침 Udemy강의를 제공해준다는 소식을 들어 신청했다.

그렇게 해서 신청한 Udemy 강의는 2개지만, 이번 글에는 테크니컬 라이팅 강의에 대한 후기를 남겨볼까한다.

강의 배운 점

강의에는 강의 소개 제외 5장 정도 있다.

1. 테크니컬 라이팅의 개념과 문서 작성 프로세스
2. 독자를 선정하고 주제를 잡는 방법
3. 초안 작성하기
4. 문서 고치기
5. 동료 검토와 문서 배포하기

여기서 각 장마다 개인적으로 인상 깊었던 부분들을 살펴볼 생각이다.

1. 테크니컬 라이팅의 개념과 문서 작성 프로세스

• 테크니컬 라이팅은 기술 글쓰기라는 뜻으로, 특정 독자에게 특정 정보를 전달하는 글을 작성하는 것이다.
• 테크니컬 라이팅의 특징을 살펴보면 다음과 같다.
  • 사실을 전달한다.
  • 특정인을 대상으로 한다.
  • 직설적이다.
  • 순차적이다.
• 테크니컬 라이팅의 순서는 다음과 같다.

  1. 작성 계획

     주제, 소제를 잡고 일정을 계획한다.

  2. 초안 작성

     글을 작성 하며 자료를 수집한다.

  3. 고치기

     글을 검토하고, 글을 수정한다.

2. 독자를 선정하고 주제를 잡는 방법

• 어느 대상을 설명할 때, 내가 쓴 글을 보는 사람이 누구냐에 따라 설명하는 방법이 달라진다.
• 글을 쓰기위한 주제 혹은 글감은 찾아보면 되게 많다.(필요한 자료들을 계획적으로 집중해서 모아놓는 것이 중요하다.)
• 평소 한 곳에 꾸준히 메모하는 습관이 중요하다.
• 주제를 잡았다면, 그 주제에서 주제의 범위를 조금 더 좁히고 그 좁힌 주제를 구체적으로 다루는 것이 중요하다.
• 어떤 정보에 대해 찾으면 그 정보에 대한 스스로의 질문을 통해 그 근거와 사례를 찾는다.

3. 초안 작성하기

• 개요부터 꼼꼼히 작성하자는 생각은 쓰다가 포기하기 쉬우므로 일단 쓰고 싶은 부분부터 작성한다.
• 기술 문서는 A4용지로 7~10장 정도 작성하는 것이 적당하다.
• 초안을 작성하기 위한 3가지 원칙 3C가 있다.
  • Clear(명확)
    • 무언가 두 상대를 비교하기 위해 두 상대의 값을 명시하여 몇 배 혹은 몇 퍼센트 등으로 표현한다.
    • 분명한 글꼬리를 사용한다.(이 방법이 확실한 방법이라고 말하기 어렵지 않을까 싶다. → 이 방법이 확실한 방법은 아닐 것이다.)
    • 대명사는 되도록 쓰지 않는다.(링크 이름도 포함된다.)
  • Concise(간결)
    • 단문으로 작성한다.
    • 쉬운 표현을 쓴다.
    • 말하듯 쓴다.
  • Consistent(일관)
    • 문서 주제, 형식, 용어나 표현의 일관성을 유지해야 한다.

4. 문서 고치기

• 글쓰기의 본질은 ‘고치기’이다.
• 전체적으로 검토가 필요하다.
• 역 피라미드 구조를 활용해 작성한다.
  1. 핵심 내용 요약
  2. 배경, 근거 등 구체적인 설명
  3. 일반적인 내용, 참고 사항
• MECE(Mutually Exclusive Collectively Exhaustive)기법을 통해 빠진 내용을 찾는다.
  • 여러 아이디어가 중복되는 내용을 가지지 않는지 확인한다.
  • 어떤 문제에 대한 방법을 모두 소개해야 한다.(완전한 정보를 소개해야 한다.)
• 구성 요소가 호응되어야 한다.
• 가독성을 높이기 위한 방법은 다음과 같다.
  • 단락 하나에 중심 생각 하나만 담는다.
  • 순서의 유무에 따라 목록을 점 혹은 숫자로 바꾼다.
  • 시각 자료를 통해 독자들에게 어떤 개념에 대해 쉽게 인지하게끔 유도한다.
  • 표를 통해 대상에 대한 상세한 비교를 할 수 있다.
• 마지막에 맞춤법 검사기를 돌리자.

5. 도입부 작성하기

• 다른 사람들에게 피드백을 받아보자
• 최종적으로 한번 잘못된 부분이 없는지 확인해 보자.

강의 후기

테크니컬 라이팅 강의를 통해 나 자신의 글쓰기 습관을 살펴보게 되었다.

자세한 내용은 글쓰기 세미나 과제를 통해 이야기하겠지만, 간략하게 작성해보자면 다음과 같다.

1. 글또에서 2주마다 글을 작성하지만 계획이라는 것이 크게 없었다.

2. 특정인을 대상으로 특정정보를 전달하는 역할을 글쓰기로 진행해야 하지만,
   막상 사람들의 이목을 집중시킨다는 명분에 사로잡혔다.(자기 자신의 만족감을 위해 작성했다)

3. 누구에게 설명하듯 작성한다곤 하지만,
   결국 보는 독자가 누구인지 특정한 범위를 정하지 않았다. 암묵적으로 개발에 입문하는 사람들 정도?

4. 무조건 문장을 짧게 쓴다는 것을 지양하고 있었다.
   (괜히 ‘어린애가 쓴 것처럼 보일까 봐’라는 생각이 들어서 그랬다)

5. 평소 모호한 표현이나 대명사를 사용하여 말하는 일이 많아서 그런지
   글에서도 모호한 표현이나 대명사를 많이 작성했다.

6. 남에게 보여주기에 부끄럽다고 피드백을 받으려 하지 않는다.
   (크리스마스이브에 네트워킹 행사에서 받은 포춘쿠키도 타인에게 피드백을 받아보라고 했다)

이제 나의 글쓰기 습관을 돌아봤고, 2가지 계획이 생겼다.

1. 나의 글쓰기 습관을 고치기 위해 고민하고 실제로 대책을 세운다.
2. 2주에 한 번보다 더 꾸준히 글을 작성한다.

2가지 계획을 통해 나의 글을 누군가 많이 봐주고, 나 또한 이에 따라 동기부여가 생기는 선순환이 되었으면 좋겠다.

마무리

이제 글쓰기에 대한 내 자신의 원칙이 점점 만들어지고 있다.

특히 모호한 표현이나 대명사를 사용하는 등 ‘이 정도는 알지?’라고 하듯이 표현하는 방식이 글을 쓰거나 말할 때도 많이 있었다.

그래서 이제라도 모호한 표현이나 대명사 같은 표현을 자제해야겠다.

혹시라도 특정 인물에게 특정 정보를 제공하는 글쓰기에 대해 무지한 사람이나 본인의 글이 뭔가 아쉽다고 생각하는 사람들이 있다면 테크니컬 라이팅 강의를 추천한다.