좋은 문서를 쓰는 방법

좋은 문서를 쓰는 방법

좋은 문서를 쓰는 방법
Category
Share Story

좋은 문서란 무엇일까?
작성자의 업무에 따라서, 문서의 성격에 따라서 달라질 수는 있겠으나, 필자는 좋은 문서의 특징을 다음의 두 가지라고 생각합니다.

첫 번째, 작성자의 생각과 의도, 주장을 명확하게 전달할 수 있어야 한다.
두 번째, 훑어볼 때는 내용의 구조(Framework)를 이해할 수 있고, 꼼꼼하게 볼 때는 주장과 근거가 무리 없이, 일목요연하게 파악될 수 있어야 한다.

문서에 명확하고 논리 정연한 생각이 들어가 있어야 함은 당연합니다. 그러나 좋은 문서는 훑어보는 것도, 꼼꼼하게 보는 것도 가능해야 한다는 것이 필자의 주장입니다. 세부적인 내용에는 수긍이 감에도 불구하고 ‘그래서 뭘 말하는 것이지.’ 가닥이 잡히지 않는 문서를 자주 보게 됩니다. 이런 문서는 작성자가 나무만 보고 숲을 놓쳤기 때문에 비롯되는 문제입니다. 반면에 숲은 그럴싸한데 세부적인 내용은 터무니없는 근거와 주장으로 가득한 경우도 종종 만나게 됩니다.

이 글은 시중에 나온 ‘문서 작성법류’의 책들과는 다른 관점에서 ‘좋은 문서 작성’을 위해서 필요한 조건들을 담아 보았습니다. 새벽에 읽은 캐나다 Munk Debates의 토론회가 글을 쓰게 된 기폭제(trigger)가 되었지만, 평소 고객이나 동료 컨설턴트들과 문서를 가지고 토론하면서 한 번쯤은 문서 작성의 노하우(Tacit Knowledge)를 공유하고 싶은 마음이 있었습니다.

이 글이 UX 컨설턴트들뿐만 아니라, 좋은 문서를 작성하기 위해서 오늘도 불철주야 일하고 계신 여러 지식 노동자분들에게 조금이나마 도움이 되시기를 바랍니다.

 

■ 문서 작성의 5가지 고려요소

방향

구조

전개

작성

전달

의도/목표

범위

유형

요소

체계

구성

흐름

  우선순위

배치(순서)

스타일

서술

강조

요약

꾸미기

Pause

 

1. 방향
방향을 명확히 하는 것은 좋은 문서를 작성하기 위한 출발점입니다. 아무리 다양한 지식과 논리가 들어가 있다고 하더라도 뭘 이야기(주장)하고 싶은 건지 주장이 모호하다면 그것은 결코 좋은 문서가 될 수 없습니다. 사실 문서를 작성하고자 마음먹었을 때에는 누구나 그 방향을 고민하기 마련입니다. 그러나 방향이 ‘충분히’ 고려되어 있지 않다면 좋은 문서를 만들기도 힘들뿐더러 만들어진 다음에도 읽는 이를 괴롭게 만들게 됩니다.

먼저 문서를 만들고자 하는 의도(시작점)와 문서를 통해서 얻고자 하는 목표(종착점=기대효과)를 명확히 해야 합니다. 누군가 시킨 것이든, 스스로 마음을 먹은 것이든 의도와 목표는 동시에 고려해야 합니다. 어떤 이들은 의도만 고려하고 목표는 고려하지 않는 경우가 많은데, 문서를 통해서 얻고자 하는 기대효과가 확실하지 않으면 길을 잃어버리기 쉽습니다. 의도와 목표는 동시에 고민되어야 합니다. 의도(시작)와 목표(끝)가 정의되면 방향이 만들어집니다.

대략적인 방향을 정한 다음에는 어느 범위까지 내용을 담을지 고려합니다. 범위는 문서의 방향과도 상관있지만, 이전에 만든 문서나 이후에 만들 문서도 염두에 두어야 합니다. 어느 정도 이전/이후 문서와의 연결성을 드러내는 것은 좋지만, 지나친 중복은 당연히 피해야 합니다.

범위를 정의한 다음에는 문서의 유형을 고려합니다. 문서의 유형을 결정하기 위해서는 많은 경험과 통찰력이 필요합니다. 가장 간단하게는 내용의 길이/깊이로 유형을 나눌 수 있고, 짧고 간결하게 내용을 제시할 것인지, 다양하고 구체적인 근거를 통해서 확고부동한 논리를 설파할 것인지 결정합니다. 유형에는 이 외에도 여러 가지가 있을 수 있는데, 이에 대해서는 다음 기회에 다시 얘기하도록 하겠습니다.

 

2. 구조
방향 다음으로는 구조(Framework)를 고민합니다. 이 시점부터 내용에 대한 고민이 본격적으로 이루어집니다.

구조의 첫 번째 단계는 어떤 요소들을 담을지 고민하는 것입니다. 읽는 이에게 주제를 명확하게 전달하기 위해서는 어떤 요소를 담을 것인가? 요소는 체계와 같이 고민하는 것이 좋습니다. 이 둘은 긴밀하게 연결되어 있어서 따로 떼어내서 고민하기보다는 한 번에 같이 고민하는 것이 좋습니다. 체계는 영어로 Hierarchy입니다. 하나의 개념이 파생되는 트리모델과 같은 것으로 요소들을 의미론적 관계에 따라서 체계화시키다 보면 빠진 요소들을 추가하거나, 필요 없는 요소들을 빼게 됩니다.
바로 ‘요소-체계’가 동시에 고려되어야 하는 이유입니다.

‘요소-체계’를 통해서 개념적인 구조가 만들어졌다면, ‘구성’이라는 논리적인 구조를 완성합니다. 개념적인 구조를 작성자의 의도에 따라서 논리적인 구조로 ‘구성’합니다. 사과와 배는 과일이라는 논리적인 개념으로 묶일 수 있지만, 계절적 변화를 주제로 한다면 사과와 배를 논리적으로 구분할 수 있는 것과 같은 이치입니다.
맥킨지의 MECE(Mutually Exclusive, Collectively Exhaustive)는 ‘요소-체계’ 고려를 위한 최상의 툴입니다.

 

3. 전개
구조가 정의되었다는 것은 내용이 결정됐다는 것이기 때문에 이번에는 내용을 어떻게 ‘전개’ 시킬 것인지 고민합니다. 내용을 어떻게 전개할 것인가? 흔히 다음과 같은 방식들이 존재합니다.

• 기 – 승 – 전 – 결
• 배경 – 목표 – 분석 – 전략 – 아이디어 – 수행방안 – 기대효과
• 개요 – 분석1 – 결론1- 분석2 – 결론2 – 분석3 – 결론3 – 키파인딩 종합 – 인사이트

위의 예시는 일반적인 방식이기 때문에 실제 주제나 구조가 그대로 적용되기에는 무리가 있습니다. 이 때문에 내용이 결정된 다음에는 그 내용을 어떻게 전개할 것인지 ‘구체적으로’ 고민해야 합니다.

‘요소-체계’와 마찬가지로 흐름과 우선순위 또한 동시에 고민합니다. 흐름만 강조하면 우선순위를 놓칠 수 있고, 우선순위만 강조하면 흐름이 애매해질 수 있으므로 둘을 동시에 고려하는 것이 좋습니다. 논리적인 구조와 흐름-우선순위가 만나면 배치(순서)가 완성됩니다.

f (논리적인 구조*이야기 흐름*우선순위) = 배치(순서)

 이 과정을 거치면 최종적으로 여러분은 목차를 완성할 수 있을 것입니다.

 

4. 작성
본격적인 문서 작성 시에는 스타일을 먼저 고려합니다. 표지, 간지, 넘버링, 타이틀, 리드문, 설명문, 표, 그림, 인용문, 예시, 출처 표시 등에 대해서 어떤 스타일로 문서를 작성할지 고민합니다. 스타일이 결정되면 목차와 템플릿을 만들어서 작성자 모두에게 공유합니다.

문서의 내용을 서술하는 것은 시중에 나온 책들이 많은 참고가 될 수 있는데, 여기에서는 UX 컨설팅에 한정해서 몇 가지만 얘기하겠습니다.

• 애매모호한 표현 지양, 구체적으로 주장을 서술할 것
• 각 장표에서 이야기하는 내용의 수위(granularity)를 일정하게 맞출 것
• 모든 주장에는 근거를 반드시 제시할 것
• 주장이 일반적이지 않을 경우에는 조건을 달아서 주장의 범위를 한정지을 것
• 불필요한 수식어 지양
• 모든 인용자료는 출처를 밝힐 것
• 지나치게 상세한 근거자료는 별첨(appendix)으로 빼고, 문서 본문에서는 요약된 결과만 보여줄 것
• 단락의 시작이나 끝에는 해당 단락의 결과를 요약해서 보여줄 것

서술이 끝난 다음에는 강조할 내용들을 두드러지게 표시합니다. 강조는 결국 일반적인 내용과 두드러져야 할 내용을 대비시키는 것이으로 대비가 너무 두드러질 경우에는 문서의 품질을 떨어뜨릴 수 있으므로 주의해야 합니다.

 

5. 전달
작성이 끝나면 문서의 전체 내용을 한두 장 정도로 요약해서 문서의 제일 처음에 배치하는 것이 좋습니다. 짧은 문서는 생략해도 무방하지만, 긴 문서인 경우에는 읽는 이들이 끝까지 읽어볼 확률이 낮으므로 요약이 반드시 필요합니다.

문서 작성이 모두 완료되었다면 ‘꾸미기’를 고려합니다. 공공기관이나 SI 기업들의 문서를 보면 3차원 도식들을 활용해서 화려하게 문서를 꾸미고 있는데, 지나치게 화려한 문서는 이야기 전개를 오히려 방해합니다. 그러나 ‘조형미’는 반드시 고려해야 하며 조형미와 화려함은 다른 개념으로 화려함은 선택의 문제이지만 조형미는 필수라고 할 수 있습니다. 조형미가 떨어지는 장표는 보는 이들에게 무의식적인 반발감을 초래할 수 있습니다. 미술이나 편집 디자인을 알고 있는 동료를 동원해서 문서의 조형미를 살려줍니다. 가장 좋은 것은 본인이 조형미에 대해서 공부해서 남들의 도움을 받지 않고도 ‘대비-균형-여백’ 등의 조형미에 대해서 아는 것입니다. (평소에 미술 작품에 관심을 많이 두는 것도 도움이 되겠습니다.)

마지막 팁으로, 보고용 문서라면 중간에 pause를 넣는 것도 좋습니다. (pause의 적당한 한글명이 떠오르지 않는데, ‘잠시 쉬어가는 코너’라고 보면 되겠습니다.) 너무 본론만 얘기하다 보면 듣는 사람들이 피로해질 수 있습니다. 특히 30분을 넘어가는 보고에서는 반드시 중간 중간에 pause를 넣는 것이 필요합니다. pause에는 내용과 관계된 인용문이나 누군가의 격언을 보통 넣는데, UX 컨설팅 보고서에는 가장 인상적인 리서치 결과(사용자가 직접 한 얘기)를 많이 사용합니다.

이상으로 ‘좋은 문서 작성을 위한 팁’을 마칩니다.
앞서 밝혔듯이 이 글이 조금이나마 여러분들의 문서 작성에 도움이 되길 기원합니다.

 

– UX1컨설팅그룹 조성봉