깔끔하고 명확한 글을 작성하는 건 항상 어려운 것 같다. 블로그에 글을 올릴 때마다, 이 글이 다른 사람이 읽었을 때도 충분히 이해되는 내용일지 하는 고민을 하게 된다. 가끔은 내가 예전에 썼던 글을 읽는데도 잘 이해가 되지 않는 문장을 발견할 때가 있어서 더 고민이 됐던 것 같다.
이런 고민을 하던 중에, 감사하게도 글또에서 유데미 강의 쿠폰을 제공해 주셔서 기술블로그로 알아보는 테크니컬 라이팅 강의를 수강하게 되었다. 주제를 잡는 것부터 문서를 고치는 것까지, 평소에 궁금했던 내용을 다루고 있어서 특히 기대되는 강의였다.
이 강의는 총 2시간의 짧은 분량으로, 초안 작성부터 최종 퇴고까지 글쓰기 과정의 전반을 다루며 각 단계에서 주의해야 할 부분을 소개한다. 가독성과 문장 구조부터 전문 용어와 시각 자료를 활용하는 것까지, 기술 문서를 작성하면서 자주 실수하거나 놓치게 되는 부분에 대해 다루고 있다.
이런 분들께 추천!
글을 쓰긴 했지만 어떻게 완성도를 높여야 할지를 고민하고 계시거나, 작성한 문서가 이해하기 쉽지 않다고 느껴지시는 분들께 이 강의가 많은 도움이 될 것 같다. 문서를 퇴고하는 방법이 궁금하거나, 문서의 디테일을 채우고 싶은 분들께 추천해 드린다.
강의를 수강하면서 도움이 된 내용을 몇 가지 요약해 봤다.
문서 구조 잡기
문서를 작성할 때는 전달하고자 하는 내용이 빠짐없이, 완전하게 들어가 있는가를 확인해야 한다. 모든 내용을 잘 전달하기 위해서는 문서의 구조를 잡는 게 좋은데, 역피라미드 구조와 MECE를 생각하며 구조를 잡으면 좋다. 바바라 민토의 <논리의 기술> 책이 생각나는 부분이었다.
역피라미드 구조
역피라미드 구조는 핵심을 먼저 얘기한 후, 끝으로 갈수록 일반적인 내용을 서술하는 구조를 말한다. 문단의 첫 문장에서는 핵심 내용을 요약하고, 그다음 문장부터 그 내용에 대한 배경이나 근거 등 자세한 설명을 이어나간다. 이 뒤에 사례나 참고 사항 등을 덧붙여 마무리하면 좋다. 이 문단도 역피라미드 구조로 작성해 봤다.
MECE
MECE(Mutually Exclusive Collectively Exhaustive)는 ‘각각은 배타적이면서 전체적으로는 빠짐없이’라는 뜻이다. 글을 구성할 때, 모든 문단이 각자 다른 내용을 말하고 있지만 하나의 주제와 잘 연결된다면 MECE를 잘 지킨 것이다.
전문 용어 다루기
전문 용어를 사용할 경우, 용어가 처음 등장하는 부분에서 용어에 대한 짧은 설명을 덧붙여 주는 것이 좋다. 특히 약어를 사용한다면 그 풀이도 함께 적어 주는 것이 좋고, 영문 용어를 한국어로 작성한다면 원문을 병차해줘야 한다. 단, 서비스나 제품 이름은 원문 그대로 사용해야 한다.
그 외에도 아래와 같은 주의 사항이 있다.
- 독자 누구나 알고 있는 약어라면 풀어 쓰지 않는다 (PC, PDF 등)
- 고유명사를 임의로 줄여 쓰지 않는다
- ⚠️ AOS는 안드로이드의 약어가 아니다!
- 문서 양이 많다면, 별도의 용어집 페이지를 제공하는 게 좋다
시각 자료 활용하기
이런 경우에는 시각 자료를 활용하면 좋다.
- 사물의 생김새 - 캡처, 사진
- 수나 양 표현 - 그래프
- 구조나 관계의 논리적인 흐름 표현 - 다이어그램
- 항목 비교, 정리 - 표
시각 자료에 대한 설명은 자료가 나오기 전에 넣어 주는 것이 좋다. 시각 자료의 캡션으로 자료의 제목을 적어 주면 독자의 이해를 도울 수 있다.
화면의 캡처를 첨부할 경우, 캡처 안에서 강조하고 싶은 부분에 표시를 추가해 주면 중요한 부분을 한눈에 확인할 수 있다. 이미지 내에 캡처 일부에 대한 설명을 추가할 경우, 설명 텍스트는 이미지 바깥에 배치하는 것이 확인하기 편하다.
도입부 작성하기
글의 도입부는 다음과 같은 방법으로 작성할 수 있다.
- 질문으로 시작하기
- 용어나 개념 정리
- 경험, 에피소드 서술
- 문서와 연관된 문장 인용
- 최신 화젯거리 활용
- 짧고 인상적인 단문
여기에 더해서 글에 대한 개요를 작성해 주는 것도 좋다. 개요에서는 글을 쓴 배경 → 글에서 다루는 주제 → 대상 독자 → 독자가 이 글을 통해 알 수 있는 것 & 글에서 다루지 않는 것을 서술할 수 있다. 혹은 특정 독자의 경우 글의 일부는 생략할 수 있고, 특정 부분부터 읽으면 된다는 내용도 여기에 추가할 수 있다.
마치며
강의를 들으면서, 왜 내 글은 이해하기 어려운 것 같은지 고민해 볼 수 있었다. 나의 가장 큰 문제는 대부분의 시간을 글을 쓰는 데 사용해서 퇴고 시간이 짧다는 점인 것 같다. 글또를 하는 동안에도 일주일 동안 소재를 고민하다가 토요일까지 천천히 초안을 쓰고, 마감일에 급하게 퇴고한 후 제출한 글이 대부분이었던 것 같다. 그런데 강의를 듣고 보니, 일단 초안을 써두고 퇴고에 대부분의 시간을 사용하는 편이 훨씬 완성도 높은 글을 쓸 수 있겠다는 생각이 들었다.
더 좋은 글을 쓰기 위해 이런 노력을 해보려고 한다.
- 글 쓰는 시간과 퇴고하는 시간 측정해보기
- 지금까지 쓴 글을 읽어보면서 퇴고해보기
해당 콘텐츠는 유데미로부터 강의 쿠폰을 제공받아 작성되었습니다.
