테크니컬 라이팅에 대해 들어본 적 있으신가요?
테크니컬 라이팅(technical writing)은 말 그대로 기술 문서를 쓰는 모든 글쓰기 활동을 가리킵니다. 실제로 회사에서 업무를 하다 보면 기술 블로그, API 레퍼런스 등 기술 정보가 담긴 글뿐만 아니라 기획서, 보고서, 메일, 회의록도 자주 접하게 되는데 넓게 보면 모두 기술 문서에 속합니다.
특히 개발자라면 회사나 개인이 운영하는 기술 블로그의 글을 자주 접하실 텐데요. 글을 읽을 때 비슷한 내용이더라도 술술 잘 읽히는 글이 있는가 하면, 도입부부터 이해하기 어렵고 머릿속에 잘 들어오지 않는 글도 있습니다.
막상 글을 쓰려고 하면 쉽게 이해할 수 있는 간결한 글을 쓰는 것이 참 쉽지 않습니다. 어떻게 하면 제 의도를 명확히 전달하고 잘 읽히는 글을 쓸 수 있을지를 고민하면서 글쓰기를 망설이다 보니 매번 도입부만 작성하다가 완성을 미뤘던 적이 많았습니다. 올해에는 꼭 꾸준히 블로그에 글을 올리고 싶어서 글을 잘 쓰는 방법에 대해 찾아보고 있었는데요.
테크니컬 라이팅 코치이자 DevRel로 활동하시는 유영경 님의 '유데미(Udemy) 기술블로그로 알아보는 테크니컬 라이팅' 강의에서 글의 소재 찾기, 주제 잡기, 대상 독자 선정하기, 3C 원칙, 바른 문장 쓰기, 도입부 작성하기, 시각 자료 활용하기, 자주 틀리는 맞춤법 등을 배울 수 있습니다. 강의 시간은 약 2시간이고 부담 없이 시작할 수 있을 것 같아서 수강하게 되었습니다.
기술 문서를 작성하는 과정은 크게 3단계로 나눠집니다.
1단계 작성 계획 세우기
2단계 초안 작성하기
3단계 고치기
특히 3단계 고치기 단계에서는 초안을 최종 문서로 만들기 위해 여러 번 다듬는 가장 중요한 단계인데요. 그만큼 강의에서도 가장 오래 시간을 들여 구체적으로 어떻게 글을 고쳐 완성해 나가는지를 설명하고 있습니다.
1단계 작성 계획을 세우는 단계에서는 우선 글의 대상 독자를 정하고 주제와 소재를 선택합니다.
독자를 선정하는 것이 정말 중요합니다. 결국 독자가 쉽게 이해할 수 있는 간결한 글을 쓰는 것이 핵심인데, 대상 독자가 누구인지에 따라 독자가 관심 가질 만한 주제와 설명 수준부터 사용할 용어와 표현이 달라지기 때문입니다.
예상 독자를 고려했다면 글을 완성할 수 있을 만큼의 자료가 충분한지와 일정 내 쓸 수 있는지를 함께 고려하여 주제를 선정합니다. 자료를 찾을 때에는 어떻게 작성할지 구상하며 필요한 자료 위주로 수집합니다. 독자가 '왜?'라고 물으면 뭐라고 대답할지를 스스로 계속 질문하며 내가 주장하고 경험한 것에 대한 구체적인 근거와 데이터를 찾아둬야 합니다.
2단계 초안을 작성하는 단계에서는 일단 처음부터 완벽하게 쓰려고 하지 말고 자신 있는 부분부터 작성해 나가는 게 중요합니다.
강의에서는 내용을 구성할 때 3C 원칙을 지켜 명확하고(Clear), 간결하고(Concise), 일관되게(Consistent) 작성하는 게 좋다고 설명하고 있는데요. 정확한 사실을 명확한 데이터를 사용하여 전달해야 합니다. 짧고 쉽게 문장을 작성하며 내용, 표현, 형식을 일관되게 써야 이해하기 쉽습니다. 강사님이 각 원칙별로 구체적인 사례를 들어 설명해 주셔서 좀 더 와닿았습니다.
3단계 고치기 단계에서는 문서 구조부터 문장, 맞춤법, 제목 등 전반적인 요소 하나하나를 살펴보며 글을 다시 작성합니다. 글을 작성하는 시간이 100이라면 고치는 데에 40을 투자해야 한다고 하는데요. 특히 시간 간격을 두고 좀 더 객관화하여 글을 검토하는 게 좋습니다.
우선 핵심 내용을 가장 앞에 배치하여 문서나 단락에서 말하고자 하는 것이 무엇인지를 빠르게 파악할 수 있게 합니다. 그리고 MECE 기법대로 각 단락의 주장, 근거, 사례 등이 겹치지 않으면서(Multually Exclusive) 전체적으로는 빠짐없이 완전한 정보를 제공하고 있는지(Collectively Exhaustive)를 검토합니다.
각 문장의 구성 요소가 잘 호응되는지, 문장 오류는 없는지 등을 확인하고 예상 독자에 따라 용어의 정의와 약어 풀이를 추가합니다. 불필요하게 영어로 쓴 문장은 가급적 우리말로 이해하기 쉽게 수정합니다. 맞춤법 검사기(네이버 맞춤법 검사기, 우리말 배움터 한국어 맞춤법/문서 검사기 등)을 적절히 활용하면 좀 더 효율적으로 잘못된 부분을 찾고 수정할 수 있습니다.
또한, 시각 자료와 글이 함께 있을 때 시각 자료부터 먼저 인지하기 때문에 필요한 경우 이미지와 도표 등 시각 자료를 추가하는 게 좋습니다. 이때 자료의 설명을 먼저 배치한 후 시각 자료를 배치합니다.
글의 제목은 '무엇을 어떻게 한다'라는 식으로 풀어서 작성하면 명사만으로 구성된 제목보다 좀 더 명확하게 의미를 전달할 수 있습니다. 구글링을 하면서 기술 블로그의 글을 읽다 보면 글의 도입부만 보고 더 읽을지 말지를 정하게 되는데요. 강의에서 언급된 읽고 싶게 만드는 도입부를 작성하는 가이드 중 질문으로 시작하는 것과 용어를 미리 설명하는 것을 이번 글에 한번 적용해봤습니다.
고치기 단계까지 거쳤다면 동료 검토와 문서 배포를 하게 됩니다. 검토를 하는 입장에서는 글을 읽으며 내용을 분석하고 구조를 파악하며 분석적으로 읽을 수 있게 되고, 검토를 받는 입장에서는 혼자서 발견하지 못한 수정사항을 개선하여 더 좋은 문서를 만들 수 있게 됩니다. 배포하기 전에는 최신 정보인지와 시각 자료와 글이 일관되는지 등을 확인하고 샘플 코드가 있을 경우 잘 작동하고 설명에 맞는 코드인지 확인합니다.
테크니컬 라이팅이라는 용어를 종종 접하기는 했었지만 정확히 알지 못했었는데 이번 기회를 통해 개념과 특징을 알고 어떻게 잘 작성할 수 있는지를 전반적으로 짚어볼 수 있었습니다.
특히 각 글쓰기 단계별 세부 가이드에 대한 사례가 다양해서 좋았고 강의 양이 많지 않아 부담 없이 완강할 수 있었습니다. 글을 잘 쓰기 위해서는 계속 쓰고 고쳐보는 경험이 중요하다고 합니다. 이 강의에서 배운 방법들을 되새기며 꾸준히 글을 써보고 공유해 보겠습니다.
평소에 글쓰기에 막막함을 느끼셨거나 이해하기 쉬운 글을 작성하고 싶었던 분들께 강의를 추천합니다!
글 읽어주셔서 감사합니다. :)
해당 콘텐츠는 유데미로부터 강의 쿠폰을 제공받아 작성되었습니다.
'후기 > 강의' 카테고리의 다른 글
| [유데미(Udemy)] TDD로 배우는 웹 프론트엔드 강의 후기 (0) | 2024.02.18 |
|---|