공유용 문서를 작성할 때의 팁들

Sep 26. 2022

직장 생활을 하다 보면 공유용 문서를 작성해야 할 때가 있다. 직무에 따라서, 이런 문서를 자주 작성하는 사람들도 있지만, 아주 가끔 작성하게 되는 사람들도 있다. 자주 작성하는 사람들이라면 이미 자신만의 노하우나 템플릿을 가지고 있을 것이다. 하지만, 공유용 문서를 작성하는 일이 드문 사람들 중에는 그런 노하우나 템플릿이 없는 경우가 있다. 그러다 보니 들이는 시간에 비해 결과물이 만족스럽지 못하게 되고, 이런 문서를 작성하는 일 자체가 스트레스가 되기도 한다.

나는 현재 AI 연구를 하고 있지만, 기획자, 프로젝트 매니저, 프로젝트 리더 등의 역할을 다 년간 수행했다. 그러다 보니 직장 내 문서를 작성하는 일에 다른 연구자들보다 다소 익숙한 편이다. 게다가, 정보를 공유하는 것을 중요하게 생각하기 때문에, 내가 알고 있는 지식을 정리하거나, 혹은 내가 진행 중인 작업을 정리하여 종종 연구소 동료들에게 공유하기도 한다. 그래서, 이번 글에서는 내가 공유용 문서를 작성하는 방식을 조금 나누고자 한다. 대단한 내용은 없지만, 여기서 얘기하는 간단한 팁들이, 공유용 문서 작성에 어려움을 겪는 사람들에게 조금이라도 도움이 되었으면 한다.

글을 본격적으로 쓰기 전에 일단 제목들을 먼저 작성해 두면 좋다. 나 같은 경우 파워포인트 형식을 애용하는 편인데, 늘 빈 슬라이드를 나열해 놓고 각 슬라이드의 제목을 먼저 채워 넣는다. 그러면 자연스럽게 전체 이야기의 구조를 잡게 되고, 내가 어떤 이야기를 하고 어떤 이야기를 하지 않을지 결정하게 된다. 그리고, 전체 문서의 길이가 어느 정도 되는지도 파악할 수 있다.

제목을 작성해 놓았으면, 그다음에는 각 슬라이드마다 내용을 채워 넣는다. 이때 처음에는 일단 내 머릿속에서 생각나는 대로 주절주절 써넣는다. 어법이 맞는지, 내용이 이상하지 않은지 고민하지 않고 생각의 흐름을 그대로 글로 옮겨 놓는다. 이미지나 데이터를 복사하여 넣을 때에도 대충 아무 위치에나 넣어 놓는다. 생각의 흐름이 끊기지 않고, 내가 생각했던 모든 내용이 문서에 포함되어 있는 것이 이 단계에서는 중요한 사항이 된다.

그다음에는 각 슬라이드의 내용을 남에게 보여줄 글로 바꾼다. 처음 생각의 흐름대로 적은 글들은 대체로 내가 이해할 수 있는 문장들로 구성되어 있을 것이다. 문장과 문장의 연결도 어색하게 짜여있을 수 있고, 용어도 나만 알 수 있는 용어들을 사용하고 있을 수 있다. 그런 용어와 문장들을 공유 대상자들이 이해할 수 있는 용어와 문장들로 바꿔주고, 글의 흐름도 자연스러워지도록 다듬어 줄 필요가 있다. 이미지나 도표의 구성과 위치도 잘 잡아주어야 할 것이다.

내용이 얼추 잡혔으면, 빠진 것이 없는지 먼저 살펴본다. 내가 이미 알고 있는 것들을 설명할 때는 무언가를 빠뜨리기 쉽다. 특히, 나와 직무가 다른 사람들을 대상으로 하고 있다면, 당연히 알고 있을 것이라 생각되는 것들을 전부 다시 살펴봐야 한다. 그 사람들에게는 당연하지 않을 수 있고, 기본적인 것부터 이해하지 못하면 문서 전체가 어려운 것이 될 수 있기 때문이다.

무언가를 빠뜨리는 것만큼, 없어도 되는 것을 넣어 놓는 일도 자주 발생한다. 특히, 문서를 '잘' 작성하려고 하다 보면, 이것저것 내용이 많이 들어갈 때가 있다. 문서를 쓰는 사람 입장에서는 이미 다 알고 있는 내용이기 때문에, 내용이 많고 장황해도 문제 될 것이 없을 것이다. 하지만, 공유 대상자들에게는 낯선 내용이고 새로운 정보일 수 있다. 낯설고 새로운 내용이 장황하게 나열되어 있으면, 사람들은 피로감을 느낀다. 그 내용을 다 기억하지 못할 뿐만 아니라, 공유 자체에 대해 부정적인 감정까지 가지게 된다. 따라서, 꼭 해야 할 이야기 위주로 내용을 간결하게 유지하는 것이 좋다. 이것은 꼭 문서의 양만을 의미하지는 않는다. 문서 전체가 하나의 이야기를 하고 있다면, 양이 많아도 사람들이 받아들이기 편하다. 반면, 양이 적어도 그 안에 들어있는 이야기가 너무 다양하면 사람들은 받아들이기 어려워할 수 있다.

문서를 검토할 때, 그 문서를 읽을 대상자를 고려하는 것이 중요하다. 같은 주제에 대해서도 사람들이 관심을 두는 부분이 다르고, 이해의 정도도 다르다. 따라서 대상자에 따라 문서의 구성이나 문장들에 변화를 주어야 한다. 예를 들어, AI 연구 내용을 공유하는 문서를 만들었다면, 같은 AI 연구자들을 대상으로 할 때, 서비스 프로그래머들을 대상으로 할 때, 사업 기획자들을 대상으로 할 때, 리더 그룹을 대상으로 할 때, 그 내용과 문장들이 전부 달라져야 할 수 있다. 같은 연구자들을 대상으로 할 때는 전문 기술 중심으로, 사업 기획자들을 대상으로 할 때는 결과 중심으로 서술해야 할 수 있으며, 서비스 프로그래머들을 대상으로 할 때는 그들이 익숙한 전문 용어를 활용하고, 리더 그룹을 대상으로 할 때는 비전문가도 이해할 수 있는 말로 바꿔주는 것이 필요할 수 있다.

대강 한 번 정도 검토를 했으면 일단 문서를 덮는다. 여러 번 검토해서 문서를 완성해야겠지만, 같은 시간 같은 자리에서 반복해서 보는 것은 한번 보는 것과 크게 다르지 않다. 그보다는, 다음 날 다시 보고, 그다음 날 또다시 보는 것이 더 효과적이다. 그러면, 마치 여러 사람이 검토하는 것과 유사한 효과를 얻을 수 있다. 머리를 완전히 환기시킨 후에 다시 보는 것이기 때문에, 어제는 보이지 않던 것이 오늘은 보이게 되고, 어제는 자연스럽게 느껴진 것이 오늘은 어색하게 느껴지기도 한다. 만약, 다음 날 다시 봤는데 고칠 것이 없고, 그다음 날도 고칠 것이 없으면 그 문서는 일단 완성된 것으로 생각할 수 있다.

문서를 작성하는 팁에 여러 가지가 있겠지만, 일단은 이 정도로 정리해 보고자 한다. 대단한 내용은 아니지만, 문서 작성이 불편했던 사람들에게는 조금이라도 도움이 되지 않을까 생각한다. 여기 있는 것을 다 적용해 볼 필요는 없고, 그럴듯하다고 생각되는 것 한 두 가지라도 사용해 보면 좋을 것 같다. 그러면 문서 작성이 이전보다는 덜 불편해질 수 있을 것이다. 그리고, 일단 불편함이 덜어지면, 문서 작성에 대한 자신만의 노하우가 하나씩 생겨날 것이라고 생각한다.