Technical Writing One - 단어 올바르게 사용하기

기술문서를 작성할 때 '단어'선택이 중요하다. 특히 어려운 기술을 처음 접하는 독자에게 쉽게 풀어서 설명하는 것은 어렵다. 작성하는 사람이 완벽하게 그 기술을 안다고 해도 남에게 쉽게 설명하는 것은 쉽지 않다. 특히 어려운 전문용어들을 남발하여 사용하는 것은 바람직하지 않다. 구글 테크니컬라이팅에서 권장하는 단어 사용법에 대해서 공부하고자 한다. 

---

새로운 용어 또는 익숙하지 않은 용어 정의

• 용어가 이미 사용되고 있는 경우에는 기존에 작성된 설명에 링크합니다.
• 문서에서 처음 사용되는 용어라면 그 용어에 대해 정의합니다. 만약 문서에서 새로운 단어들을 많이 사용한다면 해당 단어들을 용어집에 정리합니다. 

 

일관된 용어 사용과 약어를 올바르게 사용하기

일관된 용어를 사용하는 것은 독자가 문서를 읽을 때 흐름이 끊기지 않도록 한다. 구글에서 제공하는 예시는 다음과 같다. 

Protocol Buffers(or protobufs for short) provide their own definition language.

Protocol Buffers라는 긴 이름 또는 제품 이름을 소개할 때 해당 이름의 약어를 protobufs라고 괄호 안에 명시하고 있다. 누구나 흔하게 쓰이는 약어라면 설명할 필요는 없지만 해당 문서에서 새롭게 등장하는 또는 회사 내부 관계자만 알고 있는 약어라면 어떤 의미인지 풀어서 작성해주고 그 이후에는 줄임말을 사용해도 된다. 

또 다른 예시에서는 

This document is for engineers who are new to the Telekinetic Tactile Network (TTN) or need to understand how to order TTN replacement parts through finger motions.

앞에서 TTN이 무엇인지 풀어서 설명을 해주고 뒤에 나오는 TTN은 이미 앞에서 설명했으므로 풀어서 작성하지 않았다. 동일한 문서 안에서 풀어서 작성된 단어(expanded version)과 약어(acronym)를 번갈아가며 사용하는 것은 바람직하지 않다. 

 

모호한 대명사 사용은 주의하기

영어와 달리 한글에서는 대명사가 많이 사용되지 않는다. '그것', '이것'이라는 대명사를 한국어로 다 번역하면 굉장히 어색한 문장이 되기 때문이다. 구글에서 제공하는 대명사 지침은 다음과 같다.

• 명사에 대해서 설명한 후에만 대명사를 사용합니다.
• 대명사를 사용할 때는 명사와 가능한 가까이에서 사용합니다. 일반적으로 대명사가 명사에서 5단어 이상 분리되는 경우 대명사를 사용하는 대신 명사를 반복하는 것이 좋습니다.
• 명사와 대명사 사이에 다른 명사를 소개하는 경우 대명사를 사용하는 대신 첫번째 명사를 사용합니다. 

기술문서에서 가장 혼란을 야기하는 대명사는 it과 they, them and their 입니다. 

예를 들어 아래와 같은 문장에서 대명사 It이 Python 또는 C++를 지칭하고 있나요? 라는 예문이 하나 있다. 아래 예문에서는 대명사 It앞에 문장에서 Python과 C++ 명사 2개가 언급되고 있는데 뒤에 문장에서는 It이라고 무엇을 지칭하는지 분명하게 명시하고 있지 않기 때문에 독자에게 혼란을 야기할 수 있다. 

Python is interpreted, while C++ is compiled. It has an almost cult-like following.

 

또 다른 대명사는 this와 that이다. 여기서도 아래 예문을 보면 앞 문장에서 '프로세스를 실행하면 권한이 구성되고 사용자 ID가 생성됩니다.' 그리고 뒷 문장에서 직역을 하자면 '그것을 통해 사용자가 앱에 인증할 수 있습니다.'라고 작성되어 있다. 

Running the process configures permissions and generates a user ID. This lets users authenticate to the app.

여기서 This가 무엇을 지칭하는지 명확하지 않기 때문에 여기서도 독자는 This가 무엇을 칭하는지 생각해야 한다. 그래서 구글에서는 다음 처럼 작성하기를 권장한다.

• this 또는 that을 적절한 명사로 바꿉니다.
• this 또는 that 뒤에 명사를 놓습니다.

위 예시를 사용해서 문장을 바꾼 예시 중 하나만 설명하자면 This뒤에 user ID를 바로 명시해 무엇을 통해 사용자가 앱에 인증할 수 있는지 분명하게 작성할 수 있다. 

This user ID lets users authenticate.

 

그러나 영어 문장을 한글로 번역할 때는 대명사를 직역하기 보다는 아래와 같이 변환해서 작성해주는 것이 좋다. 

• This와 같은 지시대명사는 이것은 이라고 변환하기 보다는 다른 부사구/부사절로 변환해야 한다.
• 불필요한 대명사는 생략하고, 지시대명사가 지시하는 대상은 무엇인지 밝힌다.

한글로 예시를 작성하면 불필요한 대명사 this는 생략하고 대명사가 지시하는 대상이 무엇인지 명시해 아래와 같이 작성할 수 있다. 

프로세스를 실행하면 권한이 구성되고 사용자 ID가 생성됩니다. 사용자는 사용자 ID를 통해 앱에 인증할 수 있습니다. 

---

본문에 개인 공부 내용을 덧붙여서 작성했으며 예시에서 오역이나 번역이 있을 수 있습니다. 구글에서 권장하는 '단어'사용법은 아래 링크를 통해 확인할 수 있습니다. 

Words  |  Technical Writing  |  Google Developers

Words  |  Technical Writing  |  Google Developers