- Published on
기술블로그로 알아보는 테크니컬 라이팅 수강 후기
- Authors
- Name
- 윤종원
개요
글또 9기로 활동하면서 무료로 유데미 강의를 지원받을 기회가 있었다. 최대 2개의 강의를 지원받을 수 있었고 강의를 듣고 그에 대한 후기만 작성하는 조건이었다. 이 글은 유데미의 기술 블로그로 알아보는 테크니컬 라이팅 강의를 듣고 쓴 후기 글이다. 강의 내용 정리보다는 어떤 부분을 인상 깊게 들었는지, 나는 어떻게 하고 있었는지 위주로 다뤄보려 한다.
이 강의를 선택한 이유
글을 주기적으로 쓰고 싶어서, 글을 더 쉽게 잘 쓰고 싶어서 글또 활동을 시작했었다. 여러 분야에서 글을 잘 쓰는 사람들을 알게 되고, 그들의 글을 읽으면서 글쓰기에 대한 욕심이 생겼고 지금까지 내가 써온 글은 어땠는지, 어떻게 하면 더 잘 쓸 수 있는지 알고 싶어져 글쓰기 강의를 신청했다. 글쓰기에 대한 책은 종종 읽어왔다. 내가 읽었던 책은 주로 '글'에 집중하는 편이었다. 어떻게 쓰면 더 잘 읽히는 글을 쓸 수 있는지, 글에 매력을 가미할 수 있는지, 어떤 소재가 사람들을 사로잡는지를 다루었다. 이 강의도 글쓰기의 전반적인 내용을 다루지만 '테크니컬 라이팅'에 더 집중하는 듯했다. 강의를 만드신 '유영경' 님의 커리어가 여러 테크 회사의 테크니컬 라이터, UX 라이터인 것처럼 이 강의는 기술 블로그는 물론이고 기술 문서, 에러 메시지 등 기술과 엮인 모든 글쓰기에 집중했다.
테크니컬 라이팅이란?
그렇다면 '테크니컬 라이팅'은 무엇일까? 테크니컬 라이팅은 기술 글쓰기라고도 하는데, 특정 독자를 대상으로 특정 목적을 갖고 특정 정보를 전달하는 글쓰기를 말한다. 더 쉽게 말하면 기술 정보를 명확하고 이해하기 쉽게 전달하는 글쓰기라고도 할 수 있다. 테크니컬 라이팅의 특징 위주로 보면 독자가 정해져 있고, 정보를 전달하는 글쓰기라고 볼 수 있고 목적 위주로 보면 기술 정보를 명확하고, 이해하기 쉽게 전달하는 글이라고 볼 수 있다. 그렇다면 테크니컬 라이팅은 글에만 국한될까?
테크니컬 라이팅은 글쓰기만을 의미하지는 않는다. 수많은 사람의 코딩 입문 유튜브로 불렸던 생활 코딩이나 짧은 기술 주제를 다루는 fireship, 기술과 관련된 라이브 방송을 진행하는 개발바닥 채널 모두 테크니컬 라이팅과 연관되어 있다. 매체의 형태만 달라질 뿐 모두 기술 정보를 명확하고 이해하기 쉽게 전달하는 걸 목표로 하기 때문이다. 그래서 테크니컬 라이팅이라는 말 대신 테크니컬 커뮤니케이션이라고 부르기도 한다.
독자 선정
테크니컬 라이팅이 다른 글쓰기와 차이를 갖는 부분 중 하나가 '특정 독자'다. 불특정 다수를 상대하는 다른 글과는 달리 독자층이 정해져 있다는 건 우리가 누릴 수 있는 혜택이다. 모두를 고려할 필요가 없고 독자층을 선정하고 그에 맞는 수준의 글을 써 내려가면 되기 때문이다. 그렇다고 테크니컬 라이팅의 모든 독자가 동일한 것은 아니다. 글마다 가정한 독자의 관심도, 이해 수준이 다르기 때문이다.
예를 들어 Naver의 Kafka에서 파티션 증가 없이 동시 처리량을 늘리는 방법 - Parallel Consumer 라는 글은 Kafka를 어느 정도 알고 있는 독자를 가정하고 있다. Kafka의 동시 처리량을 다루는 글에 관심을 가진 사람이라면 Kafka에 대해 알고 있는 건 물론이고 처리량에 대해 고민해 봤을 것이다. 그래서 Kafka에 대한 설명을 하지 않고, 파티션을 늘리는 것에 대한 문제점 정도만 언급하고 글의 주제인 Parallel Consumer로 넘어가고 있다.
반면에 채널톡의 AWS SQS를 도입하면서 했던 고민을 소개합니다.의 경우 더 넓은 범위의 독자를 산정하고 있다. 왜 메시지 큐를 고려했는지부터 시작해서 SQS가 가지는 특징은 무엇인지까지 소개하며 SQS에 대한 내용을 이어가고 있다. SQS를 잘 알고 있는 독자는 물론이고 다른 메시지 큐는 써봤지만 SQS를 잘 모르거나, 메시지 큐도 잘 모르는 독자까지 상정하는 글이라 할 수 있다. 덕분에 많은 사람들이 쉽게 읽을 수 있는 글이 되었되었지만 그로인해 분량도 길어지고, SQS에 대한 고민만 얻고 싶은 사람에게는 다소 부담스러운 글이 되기도 했다.
두 글 모두 메시지 큐를 다루고 있지만 한 글은 기술을 이해는 물론 경험을 가진 독자를 상정하고 있고 다른 글은 메시지 큐를 잘 알지 못하는 독자를 상정하고 있다. 독자를 어떻게 선정하냐에 따라 글의 주제나 내용이 달라지므로 일관된 글을 쓰기 위해서는 내가 어떤 독자들을 대상으로 글을 쓰려 하는지부터 정해야만 한다. 글에 대한 인상 혹은 주제를 가지고 독자를 선정하는 것도 좋은 방법이다.
주제 잡기
테크니컬 라이팅은 주제 선정 폭이 넓은 편이다. 학술적인 이야기를 쓸 수도 있지만 입사기, 이직기와 같은 다소 가벼운 이야기를 쓸 수도 있고 새로운 기술에 대한 개선 사례를 적는 것 또한 가능하다. 혹은 세미나나 컨퍼런스, 책에 대한 후기를 적어도 된다. 기술과 맞닿아있다면 그 어떤 주제도 테크니컬 라이팅이 될 수 있다.
어떤 내용이든 테크니컬 라이팅의 주제가 될 수 있다고 해도 글을 쓰려고 하면 막막함이 먼저 떠오른다. 막상 주제를 잡아도 주제에 대해 잘 알지 못해 가벼운 글을 쓰게 되거나 근거를 찾는데 시간을 다 써버리기도 한다. 그래서 글을 쓰지 않더라도 미리 자료를 모아두면 글을 쓸 때 도움이 된다.
나는 간단한 내용이더라도 메모해 두려 한다. 각각의 메모는 내용이 적고 글감까지 발전하지는 못하더라도 나중에 글을 쓸 때 근거 자료로 활용할 수 있다. 빠르게 활용할 수 있는 나만의 지식 창고가 생기는 거다. 나중에 필요할 때 깊은 내용도 찾아볼 수 있도록 출처까지 함께 남겨두면 더 좋다. 이에 대한 내용은 LonBlack의 문화심리학자 김정운 : 나만의 메타 언어를 편집하라, 창조의 길이 열린다 나 글쓰기를 위한 '두 번째 뇌' 만들기 (feat. 제텔카스텐) 과 같은 글을 참고해 보면 좋다.
주제에 대한 간략한 메모까지 정리하지 않더라도 여러 아티클을 모아두는 것도 글쓰기를 시작하는 데 도움이 될 수 있다. Liner 나 Notion Web Clipper 등의 도구를 활용하면 손쉽게 아티클을 주제에 따라 모아둘 수 있다. 나는 Cubox라는 서비스를 사용하고 있다. 손쉽게 아티클을 저장해두고, 주기적으로 글에 적절한 태그를 달아주고 분류해 놓고 있다. 덕분에 글을 쓸 때는 물론이고 다른 사람에게도 원하는 글을 빠르게 찾아서 공유할 수 있게 되었다.
문서 고치기
글을 일단 다 썼다면 바로 올리지 않고 퇴고의 과정을 거치는 게 좋다. 대부분 맞춤법이나 띄어쓰기 수정에 집중할 것이다. 그러나 글의 세세한 부분에 집중하기 보다 전체적으로 검토하는 게 중요하다. 매력적인 글이라면 사소한 아쉬움이 있어도 독자가 노력해 가며 읽을 가능성이 높다. 그러나 글이 일관되지 않거나 다루는 내용에 무게가 없다면 문장이 완벽하더라도 중간에 이탈할 가능성이 높다. 글의 사소한 부분은 마지막에 챙겨도 늦지 않다.
그래서 글을 객관적으로 검토할 필요가 있다. 이때 글을 쓰고 바로 검토하는 게 아니라 적당한 시간 간격을 두고 검토하는 게 중요하다. 작성자는 글의 내용은 물론이고 글에서 다루지 않은 내용까지 이미 알고 있기에 객관적으로 글을 읽어내기가 어렵다. 독자가 글을 따라가면서 어느 부분에서 막히고, 빈틈을 발견하고 글에 대한 기대감을 저버릴지 예상하기 어렵다. 따라서 스스로 글을 검토할 때는 시간 간격을 두고 검토하는 것이 좋다.
그렇다면 글을 검토할 때는 어떤 걸 확인해 보면 좋을까? 우선 문서 구조부터 살펴보면 좋다. 내용이 빠짐없이 구성되어 있는지, 완전하지 않은 논리 전개는 없는지, 주제와 맞지 않는 내용은 없는지부터 확인하고 이를 수정하면 나중에 글을 갈아엎는 일을 피할 수 있다. 또한 독자가 빠르고 매끄럽게 글을 읽도록 유도할 수 있다.
문서 구조를 확인했다면 단락이나 문장을 검토해 봐야 한다. 다소 길어 집중력을 잃게 되는 단락은 없는지, 어색한 문장은 없는지 확인해 봐야 한다. 이는 테크니컬 라이팅뿐만 아니라 다른 글쓰기에도 해당하므로 여러 글쓰기나 교정을 다룬 책들을 살펴보는 것도 좋다. 글을 직접 말해보면서 내 문장이 어색한지, 부자연스럽지는 않은지 확인해 보는 것도 좋다.
그 외에도 적절한 사진이나 그래프, 표 등을 활용하는 것도 좋은 방법이다. 사람들이 많이 활용하는 ExcaliDraw나 외국 사람들이 많이 쓰는 Xnapper 등을 활용하면 손쉽게 좋은 자료를 만들 수 있다.
마무리
유데미의 기술 블로그로 알아보는 테크니컬 라이팅 강의를 듣고 가볍게 내용을 정리하고, 나의 의견을 덧붙여보았다. 결국 글은 많이 써봐야 잘 쓸 수 있다. 그래도 테크니컬 라이팅은 일반 글쓰기와는 다르게 객관적으로 챙길 수 있는 게 많은 글쓰기라 생각한다. 위에서 다룬 내용에 대한 실제 사례를 보고 싶거나 테크니컬 라이팅을 더 잘하고 싶은 사람이라면 이 강의를 추천한다.