글쓰기

언제나 독자를 생각하라

글의 독자가 누구인가? 독자는 몇 살인가? 독자의 연령대는 어떤 취미를 즐기는가? 또 무엇을 좋아하는가? 독자의 직업은 무엇이고 지식 수준이 어느 정도인가? 독자는 글을 주로 어디서 읽는가? 독자는 어떤 문체를 선호하는가? 독자가 선호하는 분량은 어느 정도인가? 좋은 글은 이처럼 ‘독자’에 대한 철저한 분석과 이해로 쓰여진다. 글을 기획할 때부터 글을 쓰고 퇴고하고 배포하는(알리는) 전 과정에서 ‘독자’를 계속 떠올리고 고민해야 한다.

내용의 깊이를 정하라

독자가 이 글에서 무엇을 얻기를 바라는가? 독자의 지식 수준은 어느 정도인가? 전하고자 하는 지식, 즉 목적과 독자의 수준에 맞춰 내용의 깊이를 정해야 한다. 주니어 개발자를 위한 글이라면, 기술을 너무 깊이 다루기보다는 가볍게 전반을 익히게, 기초를 탄탄하게 쌓게 돕는 게 좋을 수 있다. 반면, 시니어 개발자에게 기초적인 개발 용어까지 세세하게 설명할 필요는 없을 것이다. 어느 정도의 깊이로 설명할 것인가에 따라 ‘목차’ 또한 달라질 수밖에 없다. 따라서 글의 대상에 맞춰 기술의 깊이를 잘 정하고 그에 맞춰 용어나 원리를 설명하고 뼈대를 구성해야 한다.

갓 입사한 신입 개발자가 독자라 생각해 보자. 그들의 상당수는 SRE가 무엇인지 모를 수 있다. “이 정도는 알겠지”라고 섣불리 판단하지 말자. 대상 독자의 눈높이에 맞춰 내용의 깊이를 잘 맞추는 게 중요하다. 그게 어렵다면 설명이 불충분한 것보다는, 차라리 과한 것이 낫다. 설명이 불충분해서 독자가 검색하며 글을 읽게 만들지 말자.

처음 나온 용어는 정의부터 하라

글에서 새로운 용어가 처음 등장하는 부분에는 반드시 용어부터 정의해야 한다. 약어를 썼다면 전체 이름을 해당 용어가 처음 쓰인 곳에 반드시 함께 적어주도록 한다. SRE(Site Reliability Engineering)를 다루는 글이라고 독자가 SRE가 뭔지 모두 알거라 기대하지 말라. 

용어를 통일하라

기술 문서에서 용어를 아는가, 모르는가는 문서 이해를 좌우할 만큼 중요하다. 글에서 가장 먼저 처음 나온 용어를 정의부터 하는 것도 이 때문이다. 용어 정의 이후에는 최소한 한 문서 안에서는 용어를 통일해 써야 한다. ‘알림’이란 용어를 어디서는 ‘경고’로, 다음 장에서는 ‘메시지’라고 쓰지 말자.

분량을 고민하라

독자가 누구고 글을 어디에 올릴지에 따라 문장과 문단, 글 전체의 분량을 고민해야 한다. 대표적인 단문 소셜 네트워크 서비스인 트위터와 같은 SNS의 영향으로 사람들은 점점 더 짧은 글 소비에 익숙해지고 있다. 그렇다면 몇 분 정도면 읽을 분량으로 써야 할까? 미디엄에서 우리와 같은 고민을 하며 분석해 얻을 결론이 있다. 그에 따르면 인기 글의 적정 분량은 6~7분 정도라고 한다. 또 문장은 한 줄을 넘지 않고, 문단은 5줄이 넘지 않는 게 읽기 편하다고 한다.

사전과 친구가 되라

글과 말이 다른 점은 무엇일까? 문자와 소리라는 점 외에도 말은 한 번 내뱉으면 주워 담을 수 없다는 점이 있다. 그렇기에 말은 실수나 오류를 범하기 쉽다. 반면 글은 내뱉은 글일지라도 읽고 고치고 고칠 수 있다. 책이 여전히 주요한 지식 전달 매체로 쓰이는 이유가 여기에 있다. 저자뿐 아니라 편집자, 감수자 등 수많은 사람이 읽고 오류를 잡기 때문에 책은 많은 사람이 신뢰한다.

따라서 올바른 문장을 쓰고, 올바른 뜻의 단어를 적재재소에 쓰려고 노력해야 한다. 그럴려면 아는 단어도 사전에서 의미를 찾아보는 습관을 들여야 한다. 정확한 의미를 모른채 문맥에 맞지 않게 써온 단어가 적지 않을 것이다. 

목적을 잊지마라

무언가에 골몰하다 보면 그 일을 왜 시작했는지 목적을 잊기도 한다. 당신은 왜 글을 쓰는가? 그 글은 누구를 위한 글인가? 글을 쓰는 ‘목적’을 잊지 않아야 한다. 그래야 방향성을 잃지 않고 목적을 달성할 수 있다.

그렇다면 기술 블로그에는 어떤 글이 실려야 할까? 구름은 왜 글쓰기 동호회와 기술 블로그를 운영하려는 걸까? 그리고 구름 기술 블로그의 타깃 독자는 누구일까? 그속에 우리가 써야 할 글에 대한 모든 힌트가 있다. 

구름이 기술 블로그를 운영하려는 목적은 다음과 같다.

• 구름 개발자의 성장을 글로 기록하고 공유하며 ‘함께 성장’하는 문화 조성
• 사내 개발 사례와 지식, 노하우를 알려 개인과 기업 브랜딩
• 더 나아가 인재 채용에 활용

구름 사내 기술 블로그는 ‘개발하며 얻은 지식과 경험, 우리의 개발문화가 담긴 글을 지향한다. 업무상 필요에 의해 학습하거나 경험한 것을 기술 블로그에 정리해 함께 나누는 것이다. 이를 통해 구르미가 어떻게 일하는지, 우리의 개발 문화는 어떤지, 문제를 어떻게 해결하며 성장하고 있는지 알리려 한다.

글쓰기가 어렵다면, 다음 방법을 시도하라

글쓰기가 생각보다 쉽지는 않을 것이다. 한 가지 조언을 한다면 자신만의 효과적인 글쓰기 방법을 찾으라는 것이다. 다음은 몇몇 월간 마이크로소프트웨어 필자들이 밝힌 자신만의 글쓰기 방법이다.

• 아이디어가 떠오를 때마다 메모장에 적는다. 이러한 아이디어는 훌륭한 소재가 된다.
• 전하고 싶은 핵심 메시지를 맨 처음 쓴다. 이를 효과적으로 전달하려면 어떤 흐름으로 이야기하면 좋을지를 짧은 문장으로 나열해 뼈대를 구성한다. 이 뼈대에 살을 붙여 완성!
• 기술 문서라면 글부터 쓰지 말고 예제(코드)부터 작성한다. 예제를 나열하고 그 예제를 설명하는 글을 추가하고, 앞뒤에 내용을 추가하는 것만으로도 좋은 기술 문서가 완성된다.
• 서두부터 쓰기가 어렵다면 쓰고 싶은 이야기부터 쓴다. 단락, 단락으로 쓴 짧은 글을 나열하고 이어붙이는 것만으로도 글이 완성된다.

글을 쓰면 쓸수록 잘쓰게 된다?!

흔히 글은 쓰면 쓸수록 잘쓰게 된다고 말한다. 일부는 동의한다. 그러나 이 말에 전적으로 동의하기는 어렵다. 무조건 많이 쓴다고 글을 잘 쓰게 되지는 않는다고 생각하기 때문이다. 글을 쓰는 것보다는 더 효과적인 방법은 다른 누군가에게 피드백을 받는 것이다. 한걸음 더 나아가 다른 사람의 글에 피드백을 남겨보자. 정확히 모른다면 피드백을 남길 수 없다. 피드백을 하기 위해서는 아는 것도 재차 확인하고 남기기 때문에 더 많이 공부하게 된다. 코드리뷰 경험과 글을 리뷰하는 것은 크게 다르지 않다.

맞춤법을 무서워하지 마라

100% 맞춤법을 준수하는 사람은 없다. 맞춤법이 두려워 글쓰기를 주저하지는 말자. 맞춤법 검사기만 사용해도 80점 이상의 준수한 글이 될 것이다. 귀찮더라도 맞춤법 검사기를 꼭 이용하자. ChatGPT, DeepL SE로 글을 다듬는 것도 방법이다.

• 부산대 맞춤법 검사기 http://speller.cs.pusan.ac.kr/

절대 잘 쓰려고 하지 말고 무조건 써라 

‘글 잘 쓰고자’ 하는 욕심이 커질수록 글의 무게가 늘어나 한 줄도 쓰기 어려워진다. 팁을 주자면 글쓰기의 8할은 글을 다듬는 작업이다. 글을 다듬다는 건 더 이상 뺄 게 없을 때까지, 자연스럽게 읽힐 때까지 글을 고치는 것이다. 그러니 두려워하지 말고 써라.  처음부터 완벽한 글을 쓰려고 시간을 허비하지 말고. 

초고를 빠르게 쓰고 수정하고 다듬는 습관을 들이려고 노력하자. “제대로 쓰려 말고, 무조건 써라.”라고 말한 제임스 서버(James Grover Thurber, 미국 만화가)의 말을 기억하자.