기술블로그로 알아보는 테크니컬 라이팅 | 유데미 수강후기

글또 9기에서 Udemy 강의를 들을 수 있는 기회가 주어졌다. 여러 강의들 중에 '기술블로그로 알아보는 테크니컬 라이팅'을 선택했다. 기술 블로그를 작성하려고 할 때마다 항상 막막한 기분이 들었는데, 이번 기회에 글쓰기 실력을 더 개선하고 싶었다. 또한, 강사님이 '우아한형제들'의 테크니컬 라이팅 코치분이신데, 우아한형제들의 기술블로그를 많이 접하면서 정말 글이 훌륭하다는 생각을 많이 했다. 이러한 이유들로 해당 강의를 신청해 약 일주일간 강의를 들었다.

강의 소개

해당 강의는 크게 두 파트로 나눌 수 있다. 초반부에는 '테크니컬 라이팅'의 정의 등 전반적인 글쓰기에 대한 설명을 다룬다. 후반부에는 실제 기술문서를 작성하기 위해 '독자나 주제를 선정하는 방법', '초안 작성', 그리고 '문서 퇴고 방법' 등 실질적인 프로세스를 다루고 있다. 총 강의는 2시간 정도의 분량이고, 각 영상은 5~10분 정도 길이로 구성되어 있어 부담 없이 들을 수 있다.

인상 깊은 부분 및 느낀점

초안 작성 시 개요부터 작성하지 않고 일단 자신 있는 부분부터 작성한다.

그동안 나는 항상 개요부터 글을 작성하려고 했다. 대개 본문 내용을 어떻게 작성할지는 기틀을 잡고 시작하는데, 이를 잘 대변하는 매력적인 개요를 생각해 내기가 어려웠다. 그러다 보니 시작부터 막히는 경험을 많이 했다. 해당 강의에서 강사님은 일단 어디서 부터 들 자신 있는 부분부터 작성하는 것을 권장한다. 어디서 부터든 일단 쓰기 시작하면, 해당 문서를 완성할 확률이 높아지기 때문이다. 반대로, 개요부터 작성하면 진도가 나가지 않아 중도에 포기할 확률이 높아진다.

주제, 형식, 용어나 표현을 일관되게 작성한다.

문학 글쓰기에서는 같은 말을 다르게 표현하는 경우에 익숙한 경우가 많다. 하지만, 기술 문서에서는 같은 것을 다르게 표현한다면 독자에게 혼란을 준다. 예를 들어, '프런트엔드'를 표현하기 위해 '프런트', '클라이언트', '화면', 'UI' 등 다양한 용어를 사용한다면, 독자들이 해당 용어들이 같은 것을 지칭하는지를 파악하기 위해 보다 많은 노력을 기울여야 한다. 심지어 같은 것을 지칭한다는 사실을 모를 수도 있다.

표현의 일관성은 기술 문서를 작성할때뿐만이 아니라, 동료들과 커뮤니케이션을 하는 측면에서도 도움이 되었다. 다양한 용어나 표현을 사용해 동료들에게 혼란을 주기보다 일관성 있는 용어로 커뮤니케이션 질을 높일 수 있다. (이는 코드에서도 마찬가지다. 같은 것을 나타내는데 다른 변수를 사용하면 동료 개발자들이 혼란을 느낀다. 😬)

아쉬운 점

초반부에는 일반적인 글쓰기 내용이 주로 나온다. 그래서 당연하게 느껴지는 내용이 많았다. 물론 내가 문과 출신이며 그동안 여러 글쓰기 서적들을 읽었기 때문일 수도 있다. 그래도 다양한 내용들을 다시 복습하는 차원에서 놓치지 않고 들었다. 글쓰기에 대해서 따로 공부해 본 적이 없다면 해당 부분이 정말 도움이 될 거라고 생각한다.

추천 대상

해당 강의는 아래와 같은 분들에게 도움이 될 거라고 생각한다.

• 글쓰기를 한 번도 제대로 공부해 본 적이 없으신 분
• 다른 글쓰기는 괜찮지만, 기술 문서(블로그)를 작성하는 데 어려움을 겪으시는 분
• 문서를 통한 커뮤니케이션에 어려움을 겪고 있으신 분

총평

전반적으로 해당 강의를 통해 기술 문서 작성에 관한 많은 팁들을 얻을 수 있었고, 놓치고 있는 부분들을 많이 점검할 수 있었다. 또한 사내 동료들과의 커뮤니케이션에서도 많은 도움을 받았다. 앞으로 배운 내용들을 잘 적용하면서 글쓰기 및 커뮤니케이션 능력을 향상시킬 수 있기를 기대한다.

강의 내용 중 일부 내용 캡처

---

해당 포스트는 글또 9기를 통해 Udemy 강의 쿠폰을 제공받아 작성하였습니다.