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

강의를 듣게 된 이유

개발자로 취업한 이후, 다양한 기술과 오류를 접하며 많은 경험을 쌓았다. 이런 경험들을 체계적으로 기록하고 정리하는 것의 중요성을 알았지만, 실제로는 머릿속에만 남겨두는 경우가 많았다. 이로 인해, 누군가 나에게 질문을 할 때나 경험을 공유하는 데 어려움을 느꼈다. 이러한 고민을 해결하기 위해 기술 블로그를 시작했지만, 글쓰기에 익숙하지 않았고, 쉽게 설명하는 것에 대한 부담감에 글을 완성시키지 못하는 일이 잦아졌다.

우연히 기술블로그로 알아보는 테크니컬 라이팅 강의를 알게 되었다. 강의 소개를 보며 내 블로그 보고 쓰신건가 싶을 정도로 공감이 갔다. 그만큼 많은 사람들이 나와 같은 고민을 하고 있음에 안도하며^^ 해당 강의를 수강하게 되었다.

강의 소개 페이지

---

테크니컬 라이팅?

테크니컬 라이팅은 단어 그대로 기술 글쓰기를 의미한다. 특정 독자를 대상으로, 특정 기술 정보를 명확하고, 쉽게 전달하는 정보전달을 위한 글쓰기를 의미한다. 대표적으로 기술 글쓰기, API 문서 작성, 기사 등도 테크니컬 라이팅에 포함된다.

기술 문서를 작성할 때에는 크게 세가지 단계로 구분할 수 있다.

1. 문서 작성 계획 세우기
    주제 및 소재를 선정한 후, 일정을 산정하는 단계이다. 해당 단계에서 독자를 선정하는 것이 매우 중요하다. 대상 독자들에 따라 이해도가 다르기 때문에, 기술의 깊이나 개념에 대한 설명 정도가 달라지게 되기 때문이다. 대상 독자에 따라 전문용어 풀이 방식 등을 조절해서 작성할 수 있게 된다. 주제를 선정할 때에는 독자도 관심이 있는 주제인지, 자료는 다양하게 수집할 수 있는지, 기한 내에 작성할 수 있는지 등에 대해 고려해야한다.
2. 초안 작성
    문서를 작성하고, 자료를 수집하여 배치하는 단계이다. 해당 단계에서는 글쓰기의 3C 원칙을 고려해야한다. 3C원칙은 명확(Clear), 간결(Concise), 일관(Consistent)를 의미한다. 오해를 불러일으키지 않는 명확한 글을 작성하기 위해서는 기본적으로 정확한 내용을 전달해야하며, 객관적인 데이터를 제공해야한다. 간단하고 쉬운 간결한 글을 작성하기 위해서는 괜히 어려운 표현을 사용하지 않고, 말하는 듯한 어투로 작성하는 것이 좋다. 일관된 글을 작성하기 위해서는 동일한 단어로 표현하고, 동일한 내용을 작성하는 것이 중요하다.
   
3. 고치기
    최종 문서로 만들기 전, 가장 중요하고 많은 시간이 소요되는 작업이다. 뒷받침되는 내용이 부족하지는 않은가, 자연스러운 문장으로 구성되어있는가 등을 검토하며 하나의 글을 완성시키는 단계이다.

---

수강 후기

강의를 들으면서 글또를 시작하기 전에 들을걸하는 후회가 들기도 했다. 테크니컬 라이팅을 학습한 후, 작성했던 게시글들을 대상 독자를 정하지 않았던 탓에 너무 기본적인 내용들이 많이 포함되어있다는 것을 알게 되었다.강의 내용이 어렵지 않고, 다양한 예시들을 제시해주셔서 이해하기 쉬웠다. 글쓰기가 어렵다면, 한번 쯤 꼭 들어봤으면 좋겠다.

 

해당 글은 유데미로부터 강의 쿠폰을 제공받아 작성되었습니다.