[유데미] 기술블로그로 알아보는 테크니컬 라이팅 강의 후기
서론
개발 블로그를 운영하고 있지만 기술 글을 작성하는 건 늘 부담스럽고 어려운 일이다. 무작정 기술 글을 쓰려다보니 소재 선정은 무엇으로 할지부터 어느 정도 깊이로 설명해야 할지, 어떤 톤으로 할지 등 모든 것이 안갯속에서 걷는 기분이었다. 어떻게 하면 좀 더 읽기 좋고, 읽고 싶게 만드는 글을 작성할 수 있을까 고민하던 중 유데미의 지원을 받아 좋은 기회로 테크니컬 라이팅 강의를 듣게 되었다.
강의에서 좋았던 점
강의가 2시간으로 부담스럽지 않은 길이라 마음 편히 도전(?!)할 수 있었다. 하지만 시간은 짧아도 내용은 절대 작지 않았다.
해당 강의에는 바로 적용할 만한 실질적인 방법과 예시가 가득하다. 강의를 보며 나의 지난 포스팅을 보며 내가 자주 실수하는 점들을 되돌아봤다.
몇 가지만 함께 살펴보자.
주어 구와 서술어 구의 호응, 불필요한 표현 제거
내 프로젝트에 맞는 사용자 인증 방식은 뭘까? 포스팅에서 로그인이 필요한 이유에 대해 설명하는 문장이다.
즉, 로그인은 사이트의 회원과 비회원인 사용자 사이에 제공하는 정보가 다를 경우 어떤 사용자가 회원인지를 확인하고, 해당 사용자가 가진 권한에 맞는 정보를 제공하기 위함이다.
해당 문장은 로그인이 어떤 상황에서 필요한 기능인지 설명하기 위한 문장이었으나 주어와 술어 사이에 설명이 너무 장황하다. 그리고 ‘로그인은 ~ 위함이다.’라는 구성도 어색하게 느껴진다.
따라서 문장의 필요한 표현만 남기고 다음과 같이 수정해 보았다.
즉, 로그인은 회원 여부에 따라 제공하는 정보가 다를 때 사용자의 권한에 맞는 정보를 제공하기 위해 필요한 기능이다.
일관되지 않은 표현
프로젝트에 적합한 패키지 모듈화 포스팅에서 레이어에 따른 패키지 구조라는 표현을 여러 가지 단어로 사용하고 있다.
한 문서 내에서 레이어에 따른 패키지 구조, 레이어별 패키지 구조, layer based 등 각자 다르게 표현되고 있다. 이를 하나로 통일하여 사용하는 게 낫다.
외국어 남용
위와 동일한 프로젝트에 적합한 패키지 모듈화 포스팅의 기능에 따른 패키지 구조의 장점에 대한 설명에 다음과 같이 영어 단어가 그대로 표기되어 있다.
외국어를 우리말로 적절하게 바꾸는 방법은 다음과 같다.
- 먼저 이를 대체할 우리말이 있는지 찾아본다. 대체할 만한 적당한 우리말이 없으면 들리는 그대로 음차 해서 사용한다.
- 특정 분야의 전문 용어라면 원문을 함께 표기하고, 타사 서비스나 제품 이름과 같은 고유명사는 원문 그대로 표기한다.
따라서 위의 영단어는 각자 모놀리식과 마이크로 서비스로 음차 해서 표기하는 게 낫다.
느낀점
강의를 들으면서 ‘아하!’ 하는 순간들이 많았다. 가장 어려운 서문부터 작성하느라 그렇게 글을 쓰는 시간이 오래 걸렸구나, 퇴고가 가장 중요한데 나는 퇴고를 가장 대충 하고 있었구나, 그래서 다시 보면 어색한 문장이 많았구나. 사실 귀찮아서 퇴고를 안 한 것도 있지만 퇴고를 하지 않은 더 큰 이유는 “어떤 기준을 가지고 봐야 하는지” 알지 못해서 대충 오탈 자만 보고 넘어간 게 크다. 이 강의를 통해 배운 기준은 내 글뿐만 아니라 다른 사람들의 글에 피드백을 줄 때에도 좋은 기준이 될 것이다.
그리고 글을 쓰면서 자료 수집하다가 출처가 없어지거나 메모를 이곳저곳에 흩뿌려놔서 다시 자료를 찾느라 시간을 허비한 적이 많았는데 이에 대한 팁들도 알려주셔서 아주 좋았다. 전반적으로 꿀팁이 가득한 실용적인 글쓰기 가이드였다.
마지막으로 강의에서 가장 마음에 와닿았던 문장을 다시 되씹어보고 마치려 한다.
짧게라도 한 문단을 이루도록 꾸준히 쓰자
보너스
강의를 들으며 마인드맵으로 정리해보았다. (혹시 문제가 된다면 말씀해주세요!)
댓글남기기