[TW] 목차의 중요성

시작하며

안녕하세요. 카카오엔터프라이즈 테크니컬라이팅팀의 Crystal(김유리)과 Sandy(차신영)입니다.

이번 테크니컬 라이팅 포스팅에서는 목차(Table of Contents)라는 주제를 다뤄보려고 합니다. 얼마 전에 저희 테크니컬라이팅팀에서 “기술 문서 작업 단계에서 가장 중요한 하나를 꼽는다면?” 이라는 질문에 대해 의견을 나눈 적이 있었는데요. 저희 모두 목차 구성으로 의견 일치를 본 만큼, 테크니컬 라이팅 기법에서 목차는 정말 중요한 주제가 아닐 수 없습니다.

본론으로 들어가기 전에 여러분이 지금 서점에서 특정 주제에 대한 책을 구매하려 한다고 가정해 보겠습니다. 이 상황에서 여러분들은 책의 어떤 부분을 가장 먼저 살펴보시나요? 아마 대부분의 경우 “목차”일 것입니다. 해당 목차에서 특정 페이지로 이동하여 한 단락 정도 책을 읽어보고, 이 책을 선택할지 말지를 판단할 것입니다. 우리가 이렇게 목차 페이지를 살펴보는 것은 콘텐츠나 책의 논리 구조를 파악할 때 목차가 그만큼 중요하기 때문인데요. 독자 입장에서 이렇게 목차가 중요하다면, 글을 쓰는 입장에서도 이 점을 인지하고 목차를 잘 구성해야 하지 않을까요?

이제 본격적으로 목차 구성이 중요한 이유와 목차 구성 전략을 살펴보도록 하겠습니다.

목차가 중요한 이유

서론에서 독자가 책이나 문서를 볼 때 가장 먼저 보는 부분이 목차이기 때문에 목차가 중요하다고 말씀드렸는데요. 목차가 기술문서에서 어떠한 역할을 담당하고 있는지 구체적으로 살펴보겠습니다.

▪ 로드맵 제공

목차는 기술문서의 필수 요소로서 독자에게 기술문서의 구성을 한 눈에 보여주는 로드맵 역할을 합니다. 하지만 실제 회사에서 문서 작업을 하다 보면 목차가 기술문서의 필수 구성요소라는 사실을 인지하고 있는 분들은 많지 않습니다. 목차를 누락하고 본론부터 문서를 작성하는 경우도 있고, 구색 맞추기로 목차 섹션을 삽입하여 목차에 핵심을 담지 못해 목차가 유명무실해지는 경우도 있습니다. 물론 한두 장 내외의 짧은 문서라면 목차가 그리 중요한 역할을 하지 않을 수도 있지만, 만약 문서가 10장, 20장, 100장이라고 가정하면 어떨까요? 목차가 없다면 독자는 해당 문서가 어떤 목적으로 어떠한 정보를 어떻게 담고 있는지 오랜 시간을 들여야 파악할 수 있을 것입니다. 하지만 목차가 잘 작성되어 있으면, 100장 분량의 기술문서라고 하더라도 독자는 목차를 통해 시작부터 끝까지의 문서 구조를 보면서 문서 속 정보를 빠르게 읽어낼 수 있습니다. 목차는 로드맵처럼 각 챕터의 핵심을 제목으로 표현하여 전체 문서 내용의 전개를 보여주기 때문입니다. 특히 기술문서의 경우에는 상황에 따라서 필요한 챕터로 이동하여 원하는 정보를 찾는 경우가 많은 만큼 문서의 로드맵으로써 목차의 역할이 강조됩니다. 그렇기에 기술문서에서는 필수적으로 정확한 목차를 제공해야 합니다.

▪ 논리적 오류 최소화

목차는 기술문서의 설계도라고도 할 수 있습니다. 건물을 건축할 때에도 설계도를 보고 건물을 짓는 것처럼, 기술문서를 작성할 때에도 어떤 주제와 목적을 가지고 글을 작성할 것인지에 대한 목차 구성을 먼저 한 후에 세부 내용을 작성합니다. 분명 특정 문서의 대분류가 A에 대한 주제인데, 소분류에서 갑자기 B에 대한 주제가 전개되면 독자들은 혼란스러울 것입니다. 만약 목차가 처음부터 잘못 작성된 경우에는 초안 작성자들 역시 내용의 맥락을 잡지 못하게 되고, 문서는 논리 전개가 없어져 점차 산으로 갈 가능성이 커집니다. 목차가 없는 일반 글에서 이런 논리적 오류를 발견하기는 쉽지 않지만, 핵심 주제로 구성된 기술문서의 목차에서는 이런 오류들을 쉽게 발견할 수 있습니다. 따라서 품질 높은 기술문서를 생성하기 위해서는 처음부터 목차를 논리적으로 구성하면서 내용 전개의 일관성을 유지하는 것이 무엇보다 중요합니다.

좋은 목차란

앞서 목차가 왜 중요한지 목차의 역할에 대해 살펴보았는데요. 목차의 중요성에 대해 독자 여러분의 이해를 돕기 위해 실제 저희 테크니컬라이팅 팀에서 작업했던 기술문서의 목차 초안을 직접 보면서 설명드리겠습니다.

자, 여러분들은 아래 “수정 전”과 “수정 후” 중 어떤 목차가 눈에 더 잘 들어오시나요?

구체적인 내용을 들여다보지 않더라도 대부분의 독자들은 “수정 후”의 목차가 훨씬 더 구조적이고, 가독성이 높다고 느끼실 것입니다. 사실 “수정 전”과 “수정 후”의 목차는 완전히 동일한 내용으로, “수정 후”는 “수정 전”의 목차를 핵심어 위주로 간결하게 리라이팅을 하여 재구성한 것입니다. “수정 전”과 “수정 후”는 같은 내용을 담고 있는 목차이지만 주제별로 그룹화를 하고 테크니컬라이팅 4대 원칙 중 하나인 “간결성” 원칙을 적용하여 핵심어 위주로 목차를 재구성하니 가독성과 정보 탐색의 편의성 측면에서 훨씬 독자 친화적인 목차가 되었습니다.

목차 구성 전략

그렇다면 목차는 어떻게 구성해야 할까요? 테크니컬 라이팅에서 일반적으로 사용되는 목차 구성 방법과 전략을 살펴보도록 하겠습니다.

▪ 주제별 그룹화

일단 방대하고 복잡한 주제의 문서를 마주했을 때, 가장 먼저 해야 할 작업은 무엇일까요? 바로 비슷한 주제끼리 카테고리를 만들어 그룹화하는 것입니다. 큰 주제별로 그룹화하여 대분류를 만들고, 해당 대분류에 속하는 소분류 주제들을 하위에 적절하게 나열하도록 합니다. 이때 문서 속 챕터들이 독자가 논리적으로 이해할 수 있도록 분류되어야 한다는 점을 명심하도록 합니다. 독자가 목차를 읽었을 때, 어떤 챕터가 잘못 분류되어 있다고 느껴질 경우에는 해당 문서의 신뢰성이 떨어지게 되기 때문입니다. 테크니컬라이팅 팀에서는 기술문서의 목차를 구성할 때, 주제별로 그룹화를 하고 이를 엑셀이나 마인드맵으로 정리하곤 하는데요. 이렇게 정리하면 그룹화한 내용을 시각적으로도 파악하면서 논리적 오류를 범하지는 않았는지 확인할 수 있습니다.

▪ 숲에서 나무로

다음으로는 주제별로 그룹화한 내용을 가지고 포괄적인 내용으로 시작하여 세세한 내용을 다루도록 목차를 구성하도록 합니다. 만약 특정 시스템을 설명하는 문서의 목차를 구성할 때, 시스템의 큰 맥락은 무시하고 하위 기능들에 초점을 맞춰 목차 초반부터 해당 기능들을 나열하면 어떻게 될까요? 문서의 이해를 돕기 위해서 작성자는 독자에게 먼저 “숲”을 보여주고, 그 다음에 숲을 구성하고 있는 “나무”들을 보여줘야 하는데요. 자칫 하위 기능들을 목차 최상단에 구성하면, 독자들은 몇 그루의 나무들만 볼 뿐 큰 숲은 보지 못하게 될 가능성이 큽니다. 즉, 독자들은 해당 시스템에 대한 이해가 부족한 상태에서 시스템의 하위 기능만을 보게 됩니다. 따라서 목차를 구성할 때는 큰 개념에서 하위 개념으로, 큰 시스템에서 하위 시스템으로, 주요 기능에서 부가 기능으로 구성하는 것이 좋습니다. 한 마리의 새(독자)가 거대한 숲(문서)을 내려다 보며 숲의 생김새를 먼저 이해하고, 자신이 원하는 나무(개별 챕터)로 내려올 수 있도록 안내해야 합니다.

▪ MECE 기법 활용

마지막으로 목차 구성을 완료한 후에는 이를 확인하는 작업이 필요한데요. 구성한 목차를 확인할 때, 좋은 전략은 MECE(Mutually Exclusive & Collectively Exclusive) 기법을 활용하는 것입니다. MECE 기법은 세계 3대 경영 컨설팅 회사 중 한 곳인 Mckinsey & Company가 도입한 논리적 분석 원칙으로 테크니컬 라이팅의 목차 구성 시에도 유용한 개념입니다. MECE는 “서로 중복되지 않으며, 전체적으로 누락이 없도록 한다.”로 해석할 수 있는데요. 비유를 들어 설명하자면 그림의 퍼즐 조각처럼 각 챕터가 서로 독립적인 내용을 다루지만, 퍼즐 조각을 모두 맞추고나면 각 퍼즐 조각이 짜임새 있는 목차가 되어 문서라는 하나의 그림을 완벽히 완성할 수 있게 하는 기법입니다. 테크니컬라이팅 팀에서도 트리 구조로 정리한 목차를 MECE 기법으로 확인하고 있습니다. 이렇게 MECE 기법을 활용하여 필요한 내용은 모두 포함되어 있고, 중복된 내용은 없는 논리 정연한 목차를 구성할 수 있습니다.

마치며

지금까지 문서 작성에 있어 목차가 중요한 이유, 좋은 목차의 예시, 그리고 목차 구성 전략을 살펴보았습니다. 저희 테크니컬라이팅 팀에서는 기술문서 작업 요청이 들어오면 먼저 협업 담당자들과 회의를 잡고 문서화 계획을 세우는데요. 회의에서는 초안 작성자와 함께 작성하려는 기술문서의 대상 독자, 목적, 그리고 구성 범위를 논의하고, 대략적인 목차를 함께 구성합니다. 여러분들도 목차를 구성할 때 주제별로 그룹화 후, 새의 관점에서 문서를 내려다 볼 수 있도록 숲에서 나무로 목차를 구성하고, MECE 기법을 활용하여 중복되거나 누락된 목차를 검토한다면 독자분들도 좋은 목차를 구성할 수 있을 것입니다.

어느덧 카카오엔터프라이즈 기술블로그에서 테크니컬 라이팅에 대한 소개와 방법을 드린지 8번째 글이 되었네요.

이번 포스팅을 재미있게 읽으셨다면 앞서 테크니컬라이팅 팀에서 작성한 다른 포스팅도 참고해 보시면 좋을 것 같습니다. 감사합니다.

📍 테크니컬 라이팅 관련 글 더보기

✓ 기술 문서 작성 5단계
✓ 테크니컬 라이팅 4대 원칙
✓ 기술 문서 쉽게 쓰기 지침
✓ 언어학 관점에서의 기술문서 가독성 향상 전략
✓ 카카오 i 기술문서 사이트 여정, 그리고 벌써 한 달
✓ Technical Writer에서 Technical Communicator로...
✓ [KREW INSIDE] AI 서비스의 기술 문서를 책임지는 사람들, 테크니컬 라이터