※ 글또에서 무료로 지원받은 유데미 강의입니다.
📚 강의를 선택한 이유
📖 강의 내용
- 챕터 별 정리&인사이트
💡 수강 후 느낀점
👋 마치며
강의를 선택한 이유
글또에서 유데미 강의를 2개 신청할 수 있는 기회가 주어졌다. 마침 기술 블로그를 잘 키워보고 싶었고, 내 글에서 기술적인 역량이 부족하다고 생각해서 테크니컬 라이팅 강의를 골랐다. 글또를 진행하며 즉각적으로 적용해볼 수 있다는 점도 선택에 한 몫 했다.
이전에 <Docs for Developers 기술 문서 작성 완벽 가이드> 책을 읽었지만 책에서는 회사의 기술 문서 작성을 위주로 다루고 있어서 아쉬웠다. 나의 현실에서 바로 적용하기 어려운 내용이었기 때문이다.
이번 유데미 강의는 쉽고, 바로 따라서 시도할 수 있는 내용으로 구성되어 있어서 수월하게 수강했다. 특히 처음 기술 블로그를 시작해서 막막한 사람들에게 많은 인사이트를 줄 수 있는 강의라고 생각한다.
강의 내용
강의는 총 5개의 챕터로 구성되어 있다. 각 장별로 강의 내용을 요약하고, 나의 인사이트를 정리해본다.
1️⃣ 1장. 테크니컬 라이팅의 개념과 문서 작성 프로세스
2️⃣ 2장. 독자를 선정하고 주제를 잡는 방법
3️⃣ 3장. 초안 작성하기
4️⃣ 4장. 문서 고치기
5️⃣ 5장. 동료 검토와 문서 배포하기
1장. 테크니컬 라이팅의 개념과 문서 작성 프로세스
테크니컬 라이팅(기술 글쓰기)는 특정 독자를 대상으로 특정 목적을 가진 특정 정보를 전달하는 글쓰기이다. 기술 정보를 명확하고 이해하기 쉽게 전달하는 글쓰기이다. 그렇기에 사실을 담은 내용과, 직설적인 표현, 순차적인 구성을 기술 글쓰기의 목표로 한다. 읽으면서 해석하는 시간이 필요한 글은 효과적인 글이 아니다.
글로써 얻는 장점으로는 효과적인 의사소통으로 증가하는 업무 효율, 정보 기록과 보존, 경험과 지식 공유를 통한 경쟁력 등이 있다. 회사 기술 블로그, 개인 브랜딩, 이력서 작성에도 도움이 된다.
기술 문서의 종류에는 API 레퍼런스, 가이드, 매뉴얼, 기술 블로그, 오류 메시지, 기획서, 보고서, 메일, 회의록 등이 있다. 개발자가 아니더라도 회사 생활을 하면서 기술 문서를 다루는 능력은 꼭 필요하다.
기술 문서 작성은 크게 3단계로 나눌 수 있다. 마지막 '고치기'가 가장 중요하고 시간이 오래 걸리는 파트다.
- 문서 작성 계획 : 소재 찾기, 일정 세우기, 독자 선정하기
- 초안 작성 : 자료 수집하기, 배치하기
- 고치기 : 검토하기, 수정하기
2장. 독자를 선정하고 주제를 잡는 방법
같은 주제를 두고 글을 쓰더라도 독자의 이해도 수준에 따라 설명 방법이 다르다. 그렇기에 독자를 확실하게 정의해야 한다. 독자에 따라 설명할 기술의 깊이, 전문 용어 사용 여부, 풀이방식 등을 조절한다.
쓰고자 하면 모든 것이 쓸거리가 된다. 새 환경 적응기, 개선 사례, 작업 절차, 세미나 후기 등 다양한 주제를 정할 수 있다. 쓸 주제가 없는 것이 아니라 주제를 정하지 못한 것이다. 주제를 선정할 때는 '독자가 관심이 있는가, 자료가 충분한가, 일정 내 끝마칠 수 있는가'를 고려한다. 한 편의 글을 일정 동안 좋은 품질로 완성하려면 세부적으로 주제를 좁히는 것이 좋다. 단순 내용 전달이 아니라 나만의 이야기를 전달해야 한다.
소재를 모을 때는 자료가 반이다. 많이 찾는다고 좋은 것이 아니다. 필요한 자료만 계획적으로 찾도록 한다.
"필요한 자료를 찾고야 말겠다는 다짐을 유지하며 각성한 상태로 찾는다"
강원국, <나는 말하듯이 쓴다> 中
메모를 통해 평소에 꾸준히 소재를 모아두면 좋다. 메모에는 날짜와 출처를 같이 적어둔다. 나중에 다시 찾으려면 시간이 오래 걸리고 찾지 못할 수 있기 때문이다. 어디에 적어두었는지 잊어버리지 않도록 한 곳에 꾸준히 메모를 모아둔다. '왜?'에 대한 답을 찾기 위해 구체적인 근거와 사례를 찾아두도록 한다. 사례, 데이터, 수치 등을 소재와 함께 수집한다.
3장. 초안 작성하기
일단 쓴다. 각자에게 맞는 글쓰기 방법이 있겠지만, 꼼꼼하게 계획을 세우기보다 어디서부터든 일단 써야 중도포기할 확률이 적다. 자신 있는 부분부터 작성하자. 키워드 > 문장 > 단락 > 챕터 > 문서 순서로 키워나간다.
💡 3C (Clear 명확, Concise 간결, Consistent 일관) 글쓰기 법칙
명확하게 쓴다. 확실하고 정확한 내용으로 오해를 일으키지 않도록 한다. 매우, 아주 등의 수식어보다 명확하고 객관적인 데이터를 사용한다. 대명사를 지양한다. 문학이라면 동어반복을 피하고 대명사를 활용하는 것이 좋을 수 있지만, 기술 글쓰기에서는 특정 부분만 읽어도 어떤 내용인지 바로 파악할 수 있게 작성해야 한다. 링크 이름을 대명사로 쓰지 않는다.
(Ex. 여기를 클릭 → 오류 코드 목록을 참고)
간결하게 쓴다. 짧고 쉽게 쓴다. 단문으로 한 호흡에 읽을 수 있도록 한다. 한자어보다는 한글로 쓴다. 평소에 쓰지 않는 말을 굳이 문서를 작성할 때 사용하지 않는다. 말하듯이 쓰면 쓰는 사람도, 읽는 사람도 쉬워진다.
일관되게 쓴다. 내용, 형식, 표현이 일관되어야 한다. 주제가 다르면 각각의 글로 분리한다. 각 문장을 일관성 있게 끝맺는지 확인한다. 특히 불렛 포인트를 이용할 때 주의한다. 독자가 혼란스럽지 않도록 용어와 표현을 하나로 통일한다. 여러 명이 작업하는 문서의 경우 용어집을 만들면 좋다.
4장. 문서 고치기
글쓰기의 본질은 고치기다. 퇴고에 글쓰기 시간의 40%를 투자하도록 한다. 문서 구조가 빠짐 없고 완전한지, 핵심 내용이 먼저 나와있는지 확인한다. 검토에 필요한 방법론 중에 두가지를 소개한다. 역피라미드 구조와 MECE 방법론이 그것이다.
글의 구조를 검토할 때는 역피라미드 구조로 작성되었는지 체크한다. 역피라미드 구조란, 핵심 내용 요약 → 배경, 근거 등 구체적인 설명 → 일반적인 내용, 참고사항 순서로 구성한 글을 말한다.
MECE 방법론을 이용해 글을 검토하는 방법도 있다.
MECE 방법론
Mutually Exclusive Collectively Exhaustive
상호배제와 전체포괄
서로는 배타적이면서, 전체적으로는 빠짐없이
같은 아이디어나 사례를 중복으로 사용하지 않는다. 주제에서 빠진 내용이 없는지 확인한다. 이로써 겹치지 않으면서 모였을 때 완전한 하나의 글인지 아닌지 확인할 수 있다.
문장을 검토하는 것도 중요하다. 오타나 잘못된 맞춤법은 글의 신뢰도를 떨어뜨릴 수 있다. 바른 문장을 사용하려면 주술 호응이 맞는지 확인하고, 불필요한 단어를 삭제한다. 문장이 짧아질수록 글이 명확해진다. 외국어를 지양하고 우리말을 사용한다.
가독성을 높이기 위해 시각 자료를 사용할 수 있다. 시각 자료에는 스크린샷, 그래프, 표 등이 있다. 맞춤법과 외래어 표기법이 제대로 작성되었는지 확인하려면 맞춤법 검사기를 활용한다.
5장. 동료 검토와 문서 배포하기
동료 검토를 하기 전, 먼저 자기 검토를 한다. 자기 검토를 효율적으로 하려면 객관적으로 글을 바라볼 필요가 있다. 시간이 지난 뒤에 읽으면 객관화 효과를 느낄 수 있다. 다른 감각을 활용해 소리내어 읽거나, 매체를 변경해서 읽어도 효과적이다.
동료 검토의 목적은 서로의 글을 읽으며 분석적 읽기를 연습하고, 자신의 글을 되돌아보기 위함이다. 넓고 깊게 읽으면 잘 쓸 수 있다. 분석적 읽기 방법에는 다음의 4가지 방법이 있다.
- 내용 분석하며 읽기
- 글의 구조 파악하기
- 글쓴이의 문서 개요를 독자 입장에서 찾아보기
- 동료 검토 체크리스트 활용하기
배포 또는 발행을 앞두고 최종으로 점검할 때는 전체적으로 훑어봐야 한다. 기밀 정보 유무, 최신 정보, 시각 자료, 코드, 링크, 출처, 문서 스타일 등 잘못된 내용이 없는지 돌아본다.
수강 후 느낀점
강의를 들으면서 여러 생각이 들었다. 내가 놓치고 있던 부분, 모르고 있던 요소, 알지만 실천하지 않았던 내용 등이 강의에 나왔다. 수강 후 바로 글쓰기에 적용해볼만한 팁도 많았다. 액션 아이템을 몇 가지 간추려 적어본다.
글을 쓸 때 한번에 많은 내용을 담고 싶은 욕심이 있었는데, 글이 너무 길어지면 지루하기 때문에 편수를 나눠 작성해도 될 것 같다. 양과 질 다 챙기느라 무리하지 말고 일정을 고려하는 습관을 들이자.
글 검토하기 파트에서 예시로 나오는 잘못된 문장의 사례가 내 얘기 같았다. 수식어 대신 명확하고 구체적인 데이터를 주의해서 사용해야겠다. 같은 단어가 반복되는 것을 피하려고 하는 편인데, 그것이 오히려 기술 글쓰기애서는 지양된다는 점도 처음 알게 되었다. 문학과 기술 글쓰기는 테크닉 측면에서 차이가 크다.
기술 글쓰기는 있어보여야 할 것 같다는 강박이 있어서, 일부러 일상에서 자주 쓰지 않는 어려운 단어를 사용하기도 했다. 쉬워보인다고 해서 만만한 글인 것은 아니다. 오히려 더 많은 사람이 쉽게 읽을 수 있는 좋은 글이 될 수도 있다.
나는 명확한 개요 없이 그냥 썼던 것 같다. 소재가 생기고, 글을 쓰고 싶은 영감이 찾아오면 그냥 썼었다. 요새 작성한 몇 편의 글은 개요를 고려하고 글쓰기를 시작했다. 개요를 글에 나타나도록 적지 않더라도 글 쓰기 전에 명확하게 생각해보는 시간을 가져야겠다.
마치며
강의에서는 연습의 중요성을 강조했다. 짧은 글이라도 천천히 작성하면서 계속 수정해나가면 좋은 글을 작성할 수 있다. 꾸준한 글쓰기 근육을 만들고 단련해야 한다. 테크니컬 라이팅을 잘 하고 싶은데 어떻게 시작해야할지 모르겠는 사람, 갑자기 회사의 기술 블로그를 담당하게 된 사람, 본인의 개발 블로그를 잘 꾸려나가고 싶은 사람에게 추천하는 강의다.
어느정도 테크니컬 라이팅의 궤도에 올라있는 사람이라면 아는 내용을 다시 정리한 것이라 아쉬울 수 있다. 그러나 그런 분들보다는 기술 글쓰기를 새로 시작하거나, 본인의 글이 아쉽고 부끄럽다고 생각하는 분들이 더 많을 거라고 생각하기 때문에 그런 대상에게 적합할 것 같다.
'대외활동 > 글또' 카테고리의 다른 글
| [회고] 함께할 때 즐거운, 글또 9기 (0) | 2024.05.10 |
|---|---|
| [글또 9기] 글쓰기 세미나로 돌아본 나의 글쓰기 전략 (7) | 2024.01.15 |
| [글또 9기] 새로운 보금자리에서의 일주일 (0) | 2023.11.27 |