[TW] 언어학 관점에서의 기술문서 가독성 향상 전략

시작하며

안녕하세요. 그동안 테크니컬라이팅팀에서는 테크니컬 라이팅의 소개, 글쓰기 전략 등에 대한 내용을 다뤘었는데요.

오늘은 조금 특별하게 테크니컬 라이팅 관점이 아닌 ‘언어학 관점에서의 기술문서 가독성 향상 전략'이라는 주제를 준비했습니다.

기술문서에서 가독성은 해당 문서의 사용성을 판가름할 뿐만 아니라, 더 나아가 특정 제품이나 기능의 비즈니스 목표를 달성하는데도 중추적인 역할을 하는데요. 그렇다면 가독성 좋은 글을 작성하기 위해서는 어떻게 글을 써야 할까요? 저희는 ‘가독성’이라는 주제와 관련하여 서적이나 논문들을 많이 찾아보는 편인데요. 얼마 전에 접했던 "한국의 이공계는 글쓰기가 두렵다"라는 책에서는 글쓰기 기법으로 다음과 같은 글쓰기 전략을 세부적으로 제시하고 있어 인상 깊었습니다.

이 책에는 이 밖에도 가독성 향상을 위한 글쓰기 전략들을 다양하게 설명하고 있는데요. 저희는 문득 글쓰기 과정에 어떠한 문제들이 있었기에 이런 글쓰기 전략들이 나오게 되었는지, 이러한 문제들의 원인은 무엇인지 궁금해지기 시작했습니다. 그러던 중 기술문서 가독성 저하 현상에 대해 좀 더 근본적으로 접근하기 위해 언어학적 관점에서 연구를 해보자는 의견이 있었고, 그 결과물을 오늘 "언어학 관점에서의 기술문서 가독성 향상 전략"이라는 주제로 상세히 풀어보고자 합니다. 지금부터 언어학 관점에서의 가독성 저하가 발생하는 문제 유형과 가독성 향상을 위한 글쓰기 전략에 대해 알아보겠습니다.

가독성 저하 원인

기술문서의 가독성이 떨어지는 원인은 크게 어휘적 관점, 문장 관점, 문단/글 관점으로 구분할 수 있는데요. 각 문제 유형에 해당하는 예시를 통해 가독성 저하의 원인을 언어학 관점에서 분석해 보도록 하겠습니다.

① 어휘적 관점

어휘적 모호성

어휘적 모호성은 여러 가지 의미로 해석될 수 있는 어휘로 인해 전체 문장의 의미가 모호해지는 현상을 말합니다.

[예시]
무료 요금제를 사용하는 경우에는 일부 API 호출이 통제됩니다.

위 예시를 보면, '통제'라는 어휘는 의미에 따라 두 가지 의미로 해석될 수 있습니다. 즉, '통제' 라는 어휘는 '허용하지 않음(not allowed)'이라는 의미와 '중앙에서 조종함(control)'이라는 의미로 사용될 수 있습니다. 전자의 의미로 사용한 문장을 후자의 의미로 해석한다면 어떻게 될까요? 이렇게 문장에 다른 의미로 해석될 수 있는 어휘가 포함되면, 독자마다 이해하는 방식이 다르기 때문에 결과적으로 독자에게 명확한 지시를 전달할 수 없습니다.

그렇다면 이런 어휘적 모호성을 지양하려면 어떻게 해야 할까요? 어휘적 모호성은 모호한 어휘를 보다 직관적인 어휘로 교체하여 뜻을 더 명확히 하는 방식으로 해결할 수 있습니다. 이 문장의 경우, '통제됩니다'라는 서술어를 '불가능합니다'로 교체하면, '허용하지 않음'의 의미만 남고 '중앙에서 조종함'으로 혼동될 여지가 사라집니다. 결과적으로 모호한 어휘를 변경하여 더 명확한 지시문이 되었습니다.

[수정 결과]
무료 요금제를 사용하는 경우에는 일부 API 호출이 불가능합니다.

문장 내 어휘 위계 불일치

언어학의 한 분야인 어휘의미론(Lexical Semantics)에 따르면, 어휘 간에는 어휘가 가지고 있는 의미에 따라 유의어, 반의어, 상의어, 하의어와 같은 다양한 관계가 성립합니다. 여기에서 상의어(Hypernym)와 하의어(Hyponym)는 상대적인 관계로, 하의어의 의미를 포함하며 포괄적 의미를 가지는 단어를 ‘상의어’, 상의어의 의미에 포함되어 개별적, 한정적 의미를 가지는 단어를 ‘하의어’라고 합니다. 가령 ‘생물’과 ‘동물’이라는 단어를 보면 의미상 ‘생물’은 ‘동물’을 포괄하는 상의어, ‘동물’은 ‘생물’의 한 종류이므로 하의어가 됩니다.

문장 내에서 상의어, 하의어 관계에 의해 구성된 어휘 간의 위계가 자연스럽지 않게 설정되면 독자는 어색함을 느끼게 됩니다. 다음 예시를 살펴보겠습니다.

[예시]
이 문서는 개인 디바이스, 스마트폰, 스마트워치에서 카카오 i 음성 비서 서비스를 이용하기 원하는 개인 사용자를 대상으로 작성되었습니다.

이 예시에서 “개인 디바이스, 스마트폰, 스마트워치”라는 각 단어는 A and B and C의 대등적 연결 구조로 제시되어 있습니다. 하지만, 정확히 말해 “‘스마트폰, 스마트워치”는 “개인 디바이스”의 하위 범주에 속하는 예시로, “개인 디바이스”와 같은 위계에 올 수 없습니다. 바로 이런 상황에서 어휘의 위계 불일치가 발생합니다.

따라서 이 예시에서 "개인 디바이스, 스마트폰, 스마트워치"라는 표현을 "스마트폰, 스마트워치 등 개인 디바이스"로 수정하면 문장 구조와 어휘 위계가 자연스럽게 일치하게 됩니다.

[수정 결과]
이 가이드 문서는 스마트폰, 스마트워치 등 개인 디바이스에서 카카오 i 음성 비서 서비스를 이용하기 원하는 개인 사용자를 대상으로 작성되었습니다.

불필요한 보조용언 사용

보조 용언이란 '-고 싶다', '-고 있다' 같이 동사에 덧붙여 추가적인 의미를 만들어 내는 표현을 의미합니다. 한국어는 어말을 늘여서 완곡하게 표현하는 특성이 있기 때문에, 보조용언에 의해 문장이 불필요하게 길어지는 경우가 많은데요. 다음 예시를 보겠습니다.

[예시]
API 서버는 OAuth2 인증 서버에서 구현되어질 수 있습니다.

위 예시에서 '구현되어질 수 있습니다'의 '-할 수 있다'는 본래 영어의 'can'과 같은 '가능성'의 의미를 나타내지만, 실제 언어 생활에서는 '-하다'를 완곡하게 말하는 표현으로 사용됩니다. 기술문서에서 이런 완곡 표현은 불필요할 뿐만 아니라, 문장을 늘어지게 만들어 자칫하면 '구현되어질 수도 있고 아닐 수도 있다'는 모호한 해석을 유도할 수 있습니다. 또한 '-되다'와 '-(어/아)지다'는 동일한 피동 표현으로 중복되어 사용되고 있습니다.

따라서 불필요한 피동 표현을 삭제하여 "구현되어질 수 있습니다"를 "구현됩니다"로 수정하면, 원문의 의미가 달라지지 않으면서도 설명은 한층 간결해집니다.

[수정 결과]
API 서버는 OAuth2 인증 서버에 구현합니다.

② 문장 관점

복합명제 문장

복합명제 문장은 명제가 두 개 이상 포함된 문장을 의미하는데, 이러한 문장은 핵심을 파악하기 어렵습니다. 아래 예시처럼 여러 명제를 한 문장에 넣으면 문장 구조가 복잡해 지고 문장의 의미는 모호해 집니다.

[예시]
🕓는 퇴근 시간이 경과됨을 알려주는 시계 아이콘입니다.

위의 예시 문장을 읽고 난 후의 느낌이 어떠신가요? 문장의 길이가 길거나 어려운 단어가 사용되지 않았음에도 불구하고 한 번에 읽히지 않습니다. 그 이유는 바로 이 문장이 한 문장에 여러 명제가 포함된 복합명제 문장이기 때문인데요. 즉, 이 문장은 “🕓는 ~ 시계 아이콘입니다”, “🕓는 ~을 알려주는(알려줍니다)”, “퇴근 시간이 경과됨(경과되었습니다)”와 같은 세 개의 명제로 구성되어 있습니다.

기술문서에서 이렇게 복합 명제가 중복되어 사용될 경우 가독성은 크게 저하됩니다.
문장을 한번 고쳐볼까요? “퇴근 시간이 경과됨” 이라는 명제는 굳이 명제의 형태를 갖출 필요가 없으므로, “퇴근 시간 경과”라는 명사구로 고칠 수 있습니다. “🕓는 ~ 시계 아이콘입니다” 명제 또한 직관적으로 알 수 있는 아이콘의 모양과 의미를 대응시킨 것에 불과하므로 윗 첨자를 사용하여 하나의 명사구 “시계 아이콘 🕓”으로 간략화할 수 있습니다. 이렇게 문장을 수정하면 문장의 명제는 “시계 아이콘 🕓은 ~을 알려줍니다"라는 명제 하나만 남게 됩니다.

[수정 결과]
시계 아이콘 (🕓)은 퇴근 시간 경과를 알려줍니다.

문장 구조의 중의성

문장 구조의 중의성이란 하나의 문장이 여러 개의 문장 구조로 해석할 수 있는 경우를 말하는데, 이 경우 각 문장 구조에 따라 독자는 상반된 의미로 달리 해석을 할 수 있는 문제가 생깁니다. 독자마다 이해하는 바가 다르다면 좋은 문장이라고 하기 어렵지 않을까요? 아래 예시를 살펴보도록 하겠습니다.

[예시]
[Back] 버튼을 누르면 애플리케이션 종료 또는 메인 화면으로 이동하여 이전의 View Template은 볼 수 없습니다.

위의 예시 문장에서 “[Back] 버튼을 누르는 것”에 대해 경고하는 의도는 이해할 수 있지만, “또는”이 포괄하는 범위가 모호하여 다음 그림과 같이 다양한 해석의 여지가 존재합니다. 작성자의 의도는 [그림 3]과 같을 것이라 추측할 수 있지만, '또는'을 중심으로 문장이 두 갈래로 분리되는 [그림 4]로도 해석될 수 있습니다.

문장 구조의 중의성을 해결하기 위해서는 문장이 해석될 수 있는 갈래를 먼저 파악한 후, 문장이 작성자가 의도하지 않은 방향으로 해석되지 않도록 문장을 수정해야 합니다. 이 때, 마침표나 쉼표를 사용하여 문장을 끊어 주거나, 포괄 범위가 모호한 접속사를 다른 표현으로 고치는 것이 좋습니다.

[수정 결과]
[Back] 버튼을 누르면 애플리케이션이 종료되거나 메인 화면으로 이동합니다. 따라서 이전의 View Template은 볼 수 없습니다.

불친절한 어순

한국어는 영어와 달리 어순이 자유로운 언어입니다. 하지만 어순이 아무리 자유롭다고 해도 주어가 제일 먼저, 서술어가 제일 나중에 위치하는 어순이 일반적이며, 독자는 이를 자연스럽게 받아들입니다. 대화를 할 때 상대방이 “뭐했어 너 어제 집에서?”처럼 일반적인 어순을 지키지 않으면 이해는 되지만 무언가 횡설수설한다는 느낌을 받을 수 있는데요. 마찬가지로 기술문서에서도 일반적인 어순을 고려하지 않고 어순을 불친절하게 배치한 경우, 의미 파악은 가능하나 가독성에 손실을 입게 됩니다.

[예시]
카카오워크에서는 Bot을 개발하기 위해 Bot 기획 및 생성 단계와 Bot 개발 프로세스 단계로 나누어서 가이드를 제공합니다. Bot 기획, 개발자 등록, Bot 생성 그리고 App Key 확인을 수행하는 과정이 Bot 기획 및 생성 단계에 포함되어 있습니다.

위 예시의 첫 문장은 카카오워크의 Bot 개발 단계인 “Bot 기획 및 생성 단계” 및 “Bot 개발 프로세스 단계”라는 새로운 정보를 독자들에게 소개하는 문장입니다. 다음 문장 또한 같은 맥락에서 “Bot 기획 및 생성 단계”를 설명하고 있지만, 문장의 주제가 되는 “Bot 기획 및 생성 단계”가 문장 내에서 먼저 등장하지 않아 자연스럽지 않습니다.

문장의 어순을 수정하여 “Bot 기획 및 생성 단계”를 먼저 배치하고, 조사 또한 한국어에서 주제어를 나타내는 조사 '은/는'을 덧붙였습니다. 이에 따라 주어가 먼저 등장하는 자연스러운 어순이 되었습니다.

[수정 결과]
카카오워크에서는 Bot을 개발하기 위해 Bot 기획 및 생성 단계와 Bot 개발 프로세스 단계로 나누어서 가이드를 제공합니다. Bot 기획 및 생성 단계에서는 Bot 기획, 개발자 등록, Bot 생성 그리고 App Key 확인을 수행하는 과정이 포함되어 있습니다.

③ 문단/글 관점

인접한 문장들의 비논리적 연결

하나의 문단은 여러 하위 문장으로 구성됩니다. 다양한 문장이 저마다 다른 내용을 담고 있어도 글이 어색하지 않게 느껴지는 이유는 문장들 간에 형식 또는 내용적인 측면에서의 유기성이 존재하기 때문인데요. 문장들 사이에 인접 문장들과 전혀 상관없는 모순적인 내용을 서술할 경우, 유기성이 흐트러져 문장 간 연결이 어색해질 수 있습니다. 다음 예시를 살펴보겠습니다.

[예시]
하나의 허브 기기에 여러 단말 기기가 연결될 수 있으나, 하나의 단말 기기는 하나의 허브 기기에만 연결될 수 있습니다.

- 하나의 단말 기기라도 여러 허브 기기에 연결되는 것이 가능한 경우가 있습니다.

저는 처음에 이 문장을 읽고, 몇 번이나 다시 읽어봐야 했습니다. 첫 번째 문장은 하나의 단말 기기는 하나의 허브 기기에만 연결될 수 있다고 설명하고 있습니다. 하지만, 다음 문장에서 하나의 단말 기기라도 여러 허브 기기에 연결되는 것이 가능하다고 설명하여 위 문장과 모순이 발생한 것이죠. 이런 경우 독자는 어느 지침을 따라야 할지 혼란스러울 수 밖에 없습니다.

실제 많은 기술문서 초안에서는 이렇게 문장들이 비 논리적으로 연결된 경우가 종종 있는데요. 이 경우, 실제 기술적 내용을 정확하게 파악하여 구체적으로 서술하는 것이 해결 방법이 될 수 있습니다. 두 문장 모두 기술적으로 옳은 내용이라면, 양쪽이 모두 성립할 수 있는 논리적 연결고리를 제시해야 합니다. 또한 특정 원칙에 예외 사항이 존재한다면, 단정적인 서술을 피하고 '일반적으로'와 같은 부사를 사용하면 독자의 이해를 도울 수 있습니다.

[수정 결과]
하나의 허브 기기에 여러 단말 기기가 연결될 수 있으나, 하나의 단말 기기는 일반적으로 하나의 허브 기기에만 연결될 수 있습니다.

- 기기에 대한 구분은 고유 ID를 통해 이루어집니다. 따라서 하나의 단말 기기라도 고유 ID를 별개로 할 경우 여러 허브 기기에 연결되는 것이 가능합니다.

가독성 향상 전략

앞선 내용에서 기술문서에서 가독성을 저하시키는 대표적인 원인들을 살펴 보았습니다. 이제 원인을 파악했으니 해결 방법을 찾아볼까요? 저희는 이번 포스팅을 준비하면서 가독성을 개선해 줄 수 있는 언어학 관점에서의 몇 가지 이론들을 관심있게 살펴보았습니다.

① 통제언어

통제언어(Controlled Natural Language)는 우리가 일반적으로 사용하는 언어의 축소판입니다. 일상적인 언어 사용에서 본질적으로 나타나는 요소인 중의성 또는 모호함 등을 해소하기 위해 언어 사용의 규칙을 더 엄격하게 지정한 것으로, 문서의 가독성을 높일 수 있는 기법 중 하나입니다.

통제언어는 목적에 따라 다양한 형태로 존재할 수 있지만, 일반적으로는 다음과 같은 특징을 가집니다.

어휘부의 사용어휘 제약 : 지정된 단어만 사용할 수 있습니다. 의미가 모호한 단어는 사용하지 않으며, 하나의 단어는 하나의 지정된 의미로 사용됩니다.
문법부의 쓰기규칙 제약 : 지정된 문법만 사용할 수 있습니다. 복잡한 층위의 문장 구조나 불필요하게 긴 문장 형식은 사용하지 않으며, 문장의 어순을 엄격하게 규정합니다.

[표 1] 어휘부의 사용어휘 제약 예시 (출처: 통제언어 모형개발의 필요성과 방향)
어휘	할당된 의미/사용	승인된 예	비승인/금지 사용
가다 (동)	(어느 장소로) 가다	화면이 문서 아래로 갑니다.	밤이 깊어 간다.
가져오다 (동)	(구체적인 것을 누구에게/어디로) 가져오다	다음 명령은 원하는 문서를 가져옵니다.	충격을 가져오다.
가하다 (동)	비승인 : ‘더하다’ 또는 ‘주다’를 사용하라.	-	충격을 가하다. 변화를 가하다.
...
나오다 (동)	(어느 장소로) 나오다	화면에 표시가 나옵니다.	사진이 예쁘게 나오다.
...
하다 (동)	비승인 : 구체적인 의미를 가진 동사로 교체하라.	-	작업을 하다.
...

동사에 관련된 통제 어휘 제약을 살펴보면, 가령 일상 언어에서 여러 가지 의미로 사용될 수 있는 동사 '가다' 및 '나오다'는 통제 언어에서는 동작을 의미하는 경우에만 사용할 수 있습니다. 동사 '하다'는 구체적인 의미를 가지지 않으므로, 구체적인 의미를 가진 동사로 교체하도록 지시합니다.

기술문서에서 통제언어를 사용하게 되면, 복합명제 문장, 불필요한 보조용언, 중의적 문장 구조 등 앞서 기술문서 가독성 저하의 원인으로 지적되었던 현상들을 대부분 해결할 수 있습니다. 또한 통제언어의 지정된 어휘와 문법을 외국어의 어휘와 문법에 대응시키면 기술문서의 번역을 용이하게 수행할 수 있습니다.

② 테마-레마 원리

같은 정보라도 다양한 방식으로 쓰여질 수 있고, 그 방식에 따라 독자가 정보를 수용하는 정도도 달라지게 됩니다. 따라서 어떤 방식으로 정보를 표현하느냐에 따라서 가독성도 달라질 수 있는데요. 문장의 어순 배치를 통해 정보 수용의 효율성을 극대화하기 위해 고안된 것이 있습니다. 바로 테마-레마(Topic and comment) 원리입니다.

[그림 5] 기술문서 내 개념들 간의 관계 (동일한 개념이 선으로 연결됨)

[그림 5]를 보면 기술문서 내에는 여러 개념이 연쇄적으로 등장하며 관계를 갖습니다. 실제로 개념을 설명한 문장, 한 개념을 설명하기 위해 다른 개념을 끌어온 문장 등이 존재합니다. 개념의 적절한 배치는 독자가 글을 이해하는 데 중요한 요소로 작용합니다.

테마-레마 원리는 어순이 자유로운 언어에서 테마가 주어(앞), 레마가 술어(뒤)에 위치하도록 하는 원리입니다. 테마(Theme; Topic)는 청자/독자의 일반지식에 속하는 보편적인 정보로, 상황이나 문맥에 주어져 있는 알려진 정보입니다. 반면 레마(Rheme; Comment/Focus)는 테마에 관련된 새로운 정보입니다. '테마' 및 '레마'라는 단어에서 보여지듯 이는 독일에서 온 말입니다. 독일어는 영어에 비해 어순이 자유롭기 때문에 테마-레마 원리에 대한 연구가 활발하게 이루어지고 있습니다.

[그림 6]은 앞서 본문에서 테마-레마 원리를 설명한 문장으로, 문장 자체도 테마-레마 원리를 준수하고 있습니다. 한 문장 내에서 테마(주제어) 및 레마(새로운 정보)가 테마-레마 순서로 등장합니다. 앞선 문장에서 '레마'였던 개념이 다음 문장에서 '테마'로 자리잡고, '레마'에 해당되는 새로운 정보를 설명하는 연쇄가 일어나는 것이 색깔과 화살표로 표현되어 있습니다.

마찬가지로 어순이 자유로운 언어인 한국어에서도 테마-레마 원리를 사용하는 것이 효과가 있을까요? 테마-레마 원리가 한국어 화자에게도 효과가 있는지 검증하기 위해 '자율조절읽기(self-paced reading)'라고 불리는 실험이 수행된 적이 있는데요. 자율조절읽기란 문장의 단어(또는 구)를 하나씩 보여주고, 특정 키를 누르면 다음 단어가 나와서 계속 읽을 수 있는 방식입니다. 이를 통해 한 단어 또는 구를 읽는 데 걸리는 시간을 측정할 수 있습니다.

재미있는 사실은 테마-레마 원리를 준수한 문장과 준수하지 않은 문장으로 자율조절읽기 실험을 수행한 결과, 한국어에서도 테마-레마 어순을 적용했을 때 평균 읽기시간이 짧은 걸로 나타났다는 것입니다. 실험 결과, 다른 모든 조건이 동일하다면 테마-레마 원리를 준수하여 문장을 작성했을 때 독자들이 문장을 더 빠르게 인식했습니다. 이는 독자들이 문장의 구조와 의미를 더 쉽게 받아들인 것으로 가독성이 향상되었다고 볼 수 있습니다. 문장 단위의 자율조절읽기 시간을 측정했을 때 테마-레마 원리를 준수하지 않았을 때에 비해 미묘한 차이가 발생했지만, 실제로 독자는 엄청나게 많은 양의 문장을 읽어가며 원하는 정보를 찾아가기 때문에 이 조그만 차이가 눈덩이처럼 불어날 수 있습니다. 따라서 글을 작성할 때 앞서 설명한 테마-레마 원리를 준수하는 것이 더 읽기 쉬운, 즉 가독성이 좋은 글을 작성하는 전략이 됩니다.

마치며

지금까지 언어학적 관점에서 기술문서의 가독성을 저해하는 원인을 분석하고, 이를 보완하기 위한 가독성 향상 전략을 살펴보았습니다. 언어학은 인간의 언어를 다양한 측면에서 다루고 있으며, 과학적이고 분석적인 방법론을 도입하여 언어를 연구하는 학문으로서 테크니컬 라이터들에게도 매력적인 학문인 것 같습니다. 특히 언어학의 통사론(Syntax) 분야에서는 문장의 형식과 구조를 연구하고, 의미론(Semantics) 또는 인지언어학(Cognitive Linguistics) 분야에서는 언어의 의미를 연구하기 때문에 테크니컬 라이터에게 꼭 필요한 부분인 것 같습니다. 통사론과 의미론은 각각 언어의 형식과 의미를 다루는 분야이지만, 앞선 복합명제 문장, 문장 구조의 중의성에서 보았듯 언어의 형식과 의미는 서로 면밀하게 연관되어 있다는 점이 인상깊었습니다. 또한 앞서 설명드린 테마-레마 원리에 따른 독자의 반응 속도처럼 독자가 텍스트를 수용하는 방식에 대한 연구를 진행하는 심리언어학(Psycholinguistics)에서도 도움이 되는 기법들이 다수 존재함을 알 수 있었습니다.
지금까지 언어학 관점에서 기술문서 가독성 저하 원인과 가독성 향상 전략을 살펴보았는데요. 앞으로 기술문서를 작성할 때 이런 점들을 고려하여 글을 쓴다면 보다 독자 친화적인 글을 쓸 수 있지 않을까 생각하며 이번 포스팅을 마치도록 하겠습니다.