본격적으로 개발 공부를 시작하기 이전, 개발자는 글을 잘 쓸 필요 없는 직업 아닌가? 라는 생각을 했다. 사실 내가 글을 쓰는 것을 좋아하지 않고, 또 잘하지 않기 때문에 저런 생각을 하지 않았나 싶기도 하다. 이 글은 지난 6개월이 좀 넘는 시간 동안 개발을 배우고 취업을 준비하는 과정에서 바뀐 내 생각을 적어본 글이다.
우리는 다같이 일한다.
개인적으로 생각하는 글을 잘 써야만 하는 가장 큰 이유이다. 프리랜서로 일하는 사람이 아니라면, 나를 포함한 우리 대부분은 회사에 취업하여 다른 사람들과 함께 일하게 될 것이다. 즉, 내가 작성하는 어떠한 글이든 높은 확률로 나 혼자만 읽는 것이 아니라 함께 일하는 동료들도 읽게 되는 것이다. 그리고 이는 팀 프로젝트를 진행하며 직접 내 몸으로 깨닫게 되었다.
개발자에게 글이란 꼭 어떤 내용을 정리한 줄글만을 말하는 것이 아니다. 나는 당연하다고 생각한 변수명, 함수명이 팀원에겐 당연한 것이 아니었고, 나는 알아보기 쉽게 작성했다고 생각한 코드가 팀원에게는 이해가 어려운 코드였었다. 더하여, 서로 맡은 부분에 대해 새로 접하는 개념, 마주하는 에러 등도 즉시 공유하는 것이 아니라 글로 정리 후 공유하였는데 이 부분에서도 쉽게 작성했다고 생각한 글이 팀원으로 하여금 다시 질문을 던지게 하는 글이었었다.
(당시 공유 내용의 일부분이다.)
이러한 상황 속, 이번 블로그 포스팅의 제목으로 던졌던 의문에 대한 나의 답이 완전히 뒤바뀌게 되었다. 개발자는 글을 잘 써야만 하는 직업이다. 그렇다면 어떤 글이 과연 잘 쓴 글이라 정의할 수 있을까?
가독성과 시간효율
잘 작성한 글에 대한 정의는 사람마다 다양할 것이다. 하지만 내가 겪은 상황에서 내린 나의 정의는 읽기 쉬운, 즉 가독성이 뛰어난 글이 잘 쓴 글이라 표현하고 싶다. 내가 작성한 글을 이해하는데 팀원이 많은 에너지를 소모한다면 분명히 팀의 업무 효율에 문제를 야기할 것이다. 반대로 가독성이 뛰어나게 작성된 글은 읽는 이에게 소모하는 에너지를 최소화 하고 팀의 업무 효율을 향상 시킨다.
이어서 작성할 내용은 그럼 우리는 어떤 방식으로 가독성이 뛰어난 글을 작성할 수 있을까에 대해 적어보려 한다.
1. 소제목을 활용한 작성, 전후 맥락 파악에 소모되는 에너지를 줄이는 방법
제목 그대로 소제목을 활용한 작성 방식이다. 대게 글은 하나의 주제를 바탕으로 작성된다. 그러기 때문에 글의 제목을 통해서 어느 정도 내용을 유추할 수는 있을 것이다. 하지만 이는 제목을 통해서 글 전체의 내용을 예상한 것뿐이지, 확실히 그 글의 내용을 파악한 것은 아니다. 내용을 파악하기 위해서는 글 전체를 모두 읽어야 할 것이며 그 과정에 줄글로만 구성된 글을 읽어간다면 꽤 많은 에너지가 소모될 것이라 확신한다. 이때, 적절한 소제목을 활용한다면 읽는 이는 마치 글의 요약본을 읽는 듯한 느낌을 받을 수 있게 된다. 다음은 개인프로젝트 리드미의 목차와 상세 내용의 일부분을 캡쳐한 사진이다.
|
|
|
| 리드미 전체 목차 | 상세 내용속 소제목 구분 |
(사실 이 소제목들도 완벽한가에 대해 생각해 보면 부족한 부분이 있지만, 소제목을 활용해서 작성한 형식에 포커싱해주시면 감사하겠습니다…)
누군가 나의 프로젝트에 대한 리드미를 확인할 때, 긴 리드미의 모든 분량을 읽고 문맥을 파악하기에는 많은 에너지가 소모될 것이다. 하지만 위와 같이 목차를 통해 대략적인 내용을 소제목으로 표기해 둔다면, 필요한 내용 또는 원하는 내용에만 집중하여 글을 읽을 수 있을 것이다. 또, 우측 사진에서 글의 모든 내용을 읽지 않고 소제목만 빠르게 훑어 나간다 해도 앞뒤 문맥을 파악할 필요 없이 내용을 빠르게 파악할 수 있을 것이다.
이처럼 소제목을 활용하여 글을 작성한다면, 전후 맥락을 파악할 필요 없이 빠르게 글의 핵심을 알 수 있게 되고 일을 함에 있어 효율을 높일 수 있다고 생각한다.
2. 글의 이해를 돕는 다양한 수단
다음으로는 다양한 보조장치를 활용하여 글의 가독성을 향상하는 방법이다. 글로만 표현하고자 할 때, 다소 난해한 내용이 포함되어 있다면 그 내용을 이해시키기 위해 꽤 긴 양의 글을 작성해야 할 것이다. 하지만 우리에게는 다양한 보조장치가 존재한다. 특히 마크다운 언어를 통하여 글을 작성할 때, 사진 이나 표 등의 보조장치를 사용하기 더욱 쉬워진다. 다음은 팀프로젝트 리드미에서 캡쳐해온 일부 내용들이다.
사진을 사용하여 글을 작성한 일부분이다. 소제목과 같이 여러 도형을 한 번에 회전시킨다는 내용이 있을 때, 읽는 사람마다 머릿속에서는 각양각색의 방법으로 도형을 돌리고 있을 수도 있다. 이 경우 우리가 의도한 내용과 전혀 다른 모습으로 도형이 돌아가고 있을수도 있다. 하지만 위와 같이 사진을 활용하여 직접 도형의 회전 모습을 회전 전, 후로 보여준다면 오해의 여지가 없이 읽는 사람마다 똑같은 모습으로 도형의 회전을 해석하게 될 것이다.
다음으로는 주석을 사용한 작성 방법이다. 개발자라면 일반적으로 알고 있는 내용이 아닌 조금은 생소한 내용을 설명할 때, 단순히 줄글로만 나열한다면 이게 무엇을 의미하는 단어인지 따로 검색을 해보거나, 읽지 않고 넘어가는 등의 상황이 발생할 수 있다. 이때, 해당 내용에 대하여 간단하게라도 주석 형식으로 글의 서두에 설명하고 넘어간다면, 앞으로 해당 단어가 글에서 계속해서 등장할 때 읽는 이로 하여금 단어의 이해를 위한 에너지를 아낄 수 있게 할 것이다.
마지막은 표를 사용한 방법이다. 어떠한 구현 상황에 대하여 두 가지 방법, 혹은 그 이상의 방법을 두고 비교를 할 때, 단순히 글로 나열하는 것보다는 이처럼 표를 통해 설명을 해준다면 직관적으로 표를 확인함과 동시에 내용을 비교할 수 있게 된다.
이처럼 다양한 보조 장치들을 사용해 글을 작성한다면 내가 글을 쓰는데 조금 더 시간이 걸릴지라도 읽는 이로 하여금 가독성이 좋은 글을 작성할 수 있다고 생각한다.
이번 글에서는 개발자가 글을 잘 써야 할까?에 대해 변화된 내 생각과 흔한 방법들일지라도 지난 6개월간 공부하며 경험하고 체화한 방법들을 토대로 가독성이 좋은 글을 작성하는 방법에 대해 적어보았다. 사실 아직도 좋은 글을 쓰는 것은 너무나 어렵고 계속해서 깔끔한 글을 써보려 노력 중이다. 우선은 그동안 공부한 내용들을 좀 더 가독성이 좋게 다듬어보며 연습을 해나갈 생각이다.