Google Developers에서 진행하는 Free technical writing courses-1

Free technical writing courses  |  Technical Writing  |  Google Developers

Free technical writing courses  |  Technical Writing  |  Google Developers

구글에서 제공하는 Technical Writing 과정을 공부하고 정리하던 중에 구글에서 'Free technical wirting courses'를 1월에 진행한다는 소식을 들었다. 어떤 식으로 강의를 진행하는지 궁금했었는데 시간이 맞아서 참석해보았다. 

Google Meet를 통해 진행하며 당연하게도 강의는 모두 영어로 진행된다😂 영어 리스닝이 부족하지만 자료를 제공하고 다양한 사람들의 의견을 들어볼 수 있어서 참석하기로 했다. Technical Writing One 과정에 참석했고 한국 시간으로는 24시에 진행되었다. 혹시 1월 25일에 진행하는 강의를 참석하고 싶다면 시간 맞춰서 'Click to join class'를 클릭하면 접속할 수 있다. Technical Writing Two 과정도 참석할 예정이다. 

대략 400명이 넘는 사람들이 참석을 했고 URL을 사전에 공유해준다. 해당 강의에 참석하지 않아도 자료는 아래 링크에서도 확인할 수 있다.
다만 다양한 사람들의 의견을 듣고 싶으면 참석하는 것을 권장한다. 

Facilitating Technical Writing Courses  |  Google Developers

여기에서는 우선 강의에서 진행했던 3가지 토론 주제에 대해서 정리해보고자 한다. 

---

Class Discussion1

첫번째 토론은 Curse of knoledge, 지식의 저주란 무엇인가이다. 

Curse of knowledge(지식의 저주)

Curse of knolege, 지식의 저주(폐해)라는 단어를 처음 들어봐서 먼저 구글링을 해봤다.

지식의 저주란 어떤 개인이 다른 사람들과 의사소통을 할 때 다른 사람도 이해할 수 있는 배경을 가지고 있다고 자신도 모르게 추측하여 발생하는 인식적 편견이다. 

예를 들어, 시니어 개발자가 작성한 문서의 대상이 고객 또는 주니어 개발자라고 가정해보자. 시니어 개발자들이 고객 또는 주니어 개발자들의 지식을 수준을 고려하지 않고 문서를 작성하는 경우를 지식의 저주라고 볼 수 있다. 시니어 개발자들이 당연하게 아는 내용을 독자는 모를 수도 있다는 것이다. 지식을 많이 알고 있는 사람이 설명도 잘하리라는 법은 없다. 오히려 시니어 개발자에게 설명을 들은 주니어 개발자가 더 단순하고 구체적으로 문서를 작성할 수도 있는 것이다.

독자가 누구인가를 명확하게 파악하고 소통을 통해 그들의 수준을 인지하는 것이 지식의 저주에 걸리지 않는 방법이지 않을까? 내가 아는 지식을 상대방도 알고 있을 것이라는 생각을 버려야 한다. 

 

 

Class Discussion2

두번째 토론은 왜 독자들은 목록에 끌리는가?이다. 

Why are readers attracted to lists?

독자들은 일반적으로 글이 목록 형태로 되어있는 것을 선호한다고 한다. 그 이유는 다음과 같다. 

• 읽기 쉬워서
• 단락 형태의 줄글 보다 간략해 보이기 때문에
• 목록을 사용하면 글의 끝이 어디까지인지 알기 때문에 

등의 정말 다양한 의견들이 나왔다. 문장이 줄글로 나열되어있는 방식보다 목록으로 작성하면 내용이 체계적으로 보이고 독자가 느끼기에 읽기 쉽다는 것이다.

여기서도 예시를 들어보자면 '00을 위한 5가지 방법'이라는 기사를 봤을 때 앞에 설명하는 단락은 잘 보지 않는다. 독자는 5가지 방법에 초점이 맞춰져 목록으로 작성된 5가지의 방법만 읽는다는 것이다. 그리고 목록의 끝이 어딘지 알기 쉽기 때문에 글을 읽을 때 부담이 없다고 느낀다고 한다. 단, 글에 너무 많은 목록이 들어가는 것도 지저분해 보일 수 있다. 

그럼 어떤 경우에 목록 형태로 작성하는 것이 좋을까? 목록은 크게 글머리 기호 목록이 있고 번호가 매겨진 목록으로 나눌 수 있는데 이에 대해서는 정리한 글에서 보다 자세하게 다루어 보고 링크를 추가하려고 한다.   

 

 

Class Discussion3

세번쨰 토론은 오컴의 면도날에 관한 주제이다.  

Occam's razor(오컴의 면도날)

먼저 Occam's razor, 오컴의 면도날이란 무엇이냐

같은 현상을 설명하는 두 개의 주장이 있다면, 간단한 쪽을 선택하라는 것이다. 면도날이란 필요하지 않은 가설을 잘라낸다는 비유이다. 

이렇게만 보면 이게 무슨 말이지? 싶다. 오컴의 면도날을 문서를 작성할 때 적용하면 문장의 길이를 잘라낸다는 말이다. 토론하면서 이런 질문이 나왔다. "What techniques can you use to shorten sentences?" 문장을 짧게 하기 위해서 어떤 기술을 사용할 수 있냐는 물음인데 여기에 오컴의 면도날을 적용할 수 있다. 

테크니컬 라이팅의 4원칙 중에 간결성이라는 원칙이 있다. 기술 문서를 작성할 때 불필요한 설명을 덧붙이지 말고 간결하고 단순하게 작성하라는 의미이다. 만약 지나치게 길게 작성된 문장이 있다면 한 문장의 하나의 주제만 들어가도록 수정하고 간결한 용어를 사용하면 가독성을 높일 수 있다. 또한 불필요한 단어나 수식어가 있는지 확인해봐야 한다. 

하지만 여기서 Oversimplifed(지나치게 단순화)하는 것도 주의해야 한다고 덧붙였다. 지나치게 단순화해서 문서를 작성해버리면 독자가 문서를 이해하지 못하는 경우가 발생하기 때문이다. 가장 간단한 설명이 항상 옳은 것은 아닐 수도 있다. 이 경우에도 역시 문서의 유형과 읽는 독자를 고려해서 작성하는 것이 가장 중요하지 않을까 싶다. 

---

역시 문장을 짧고 간결하게 작성하는 것은 아직도 너무 어렵다..면도날을 이용해서 긴 문장을 잘라내되 지나치게 단순화는 자제하는 것을 기억하자.