글쓰기가 서툰 기술자를 위한 테크니컬 라이팅 10계명

기술 문서 작성법 마스터

최근 글쓰기가 서툰 기술자를 자주 만난다. 그들 중 한 명이 이런 이야기를 한 적이 있다.

"저에게 글이란 잡히지 않는 안개 같습니다..."
"자세히 이야기해주세요?"

"좀 알 것 같다 싶으면 다시 모호해져서 말입니다."
엔지니어들에게 테크니컬 라이팅 교육의 문의가 많다. 굳이 기술자에게 글쓰기 교육이 붐을 일어나는 것일까?

테크니컬 라이팅(Technical Writing)이란 분야가 생긴 이유도 유독 기술자들이 다른 직무 근무자보다 글쓰기를 잘 못하는 것이다. 인간의 뇌를 봐도 좌뇌가 발달된 사람은 숫자와 사실에 강하지만, 큰 그림이나 직관이 떨어지는 경우가 많다. 옛말에 문리가 터지기 위해서는 한쪽만 공부하면 안 된다. 과학, 이학, 논리, 숫자 등에 강한 이공계는 글쓰기를 잘 배워야 나중에 리더로서 성장할 수 있다.
매뉴얼(manual)은 새로운 제품의 특징과 안전 그리고 사용법을 알려주는 설명서이다.
매뉴얼은 단순히 제품 설명서가 아니라 제품의 품질과 안정을 보장하는 역할을 해야 한다. 매뉴얼의 내용이 잘못되어 소비자에게 손해를 끼친 경우에는 손해 배상이라는 참담한 결과가 돌아오기도 한다. 외국 사례로 미국 일로이드주에서 용접기를 물 묻은 손으로 감전사고로 사망한 사건 판례에서 용접기 사용설명서에 좀 더 강조해서 경고하지 않았다고 해서 배상 판결이 있다.
반대로 잘 만들어진 매뉴얼은 제품의 성능을 널리 인지시켜, 회사의 이미지와 광고 효과를 제고시키기도 한다. 이러한 매뉴얼의 중요성은 회사를 비롯하여 대한민국 각층으로 확대되고 있는 추세이다.
과거 우리나라에서는 매뉴얼의 중요성이 크게 인식되지 않았다. 그래서 제품이 출하되면서 으레 부여되는 귀찮은 과제 정도로 여겨졌다. 물론 매뉴얼을 작성하는 전문 인력의 필요성도 크게 인식되지 않았다. 그러나 최근 매뉴얼의 중요성은 상당히 커지고 있다. 일단 첨단 과학 기술의 발전으로 출하되는 제품의 기능이 복잡해지고 다양화되면서, 이를 효과적으로 사용하기 위한 지침서가 필요해졌다. 제품을 출하하는 회사에서도 이를 효과적으로 기술하고 전달할 인력의 필요성이 생겨났다.

1. 읽는 사람(Who)을 파악하라!
당신은 누구를 위해 글을 쓰는가?
엔지니어? 관리자? 기술자? 일반인?
글을 읽는 사람이 가지고 있는 배경지식에 적합하도록 글의 기술적 깊이를 조절해라.

2. TMI보다 KISS로 써라!
용접기에 관한 기술 문서는 당연히 한 사람에게 쓰는 편지와는 방향과 내용이 달라야 한다. 하지만 엔지니어들은 기술적인 부분에 치우치는 경향이 있어서, TMI(Too Much Information)로 과한 정보를 쏟아내기 바쁘다.
지나치게 설명식 산문체로 인해 모호해지기 쉽다.   
기술전문가일수록 기초지식이 없는 사람을 은근히 무시하는 경향이 있다. 기초지식 없는 사람도 읽을 수 있도록 써라.

3. 특수전문용어보다 적확한 일반 표현을 찾아라!
이공계에서 사용되는 용어는 특별하다. 같은 산업이라고 하더라도 직무에 따라 의사소통을 할 때 전문용어는 필수지만 일반 엔드유저에게는 혼란만 일으킬 수 있다. 예를 들면 AI도 약자로 여러 뜻이 존재하기 때문에 처음에는 무엇을 뜻하는지 적어줘야 한다. 일반인들이 이해하기 위한 적확(的確)한 기술 용어를 사용한다.

4. 일반적인 것보다는 구체적으로 쓰라
기술 문서를 읽는 사람은  사실, 특징, 결론, 유의 사항 등 정보의 구체성에 관심이 있다. 세상사람보다 한 사람에 대해서 서술하라. 모호하게 되는 이유가 일반적인 표현 때문이다. 되도록 구체적이어야 한다.

5. 복잡한 것보다 단순하게 써라.
기술자는 같은 산업계에 종사자가 다들 바쁜 사람들을 의식하라. 기술 문서를 읽는 사람이 시간을 소비하지 않고 빨리 알아볼 수 있도록 전체 내용을 압촉해야 한다.  어떻게 하면 더욱 간단명료하게 쓸 수 있는가? 좋은 방법은 중복을 피하는 것이다. 중복은 누구나 잘못되었다는 것을 쉽게 알 수 있다. 쓸데없이 반복한 문구를 삭제하라. 기술 문서에서 흔히 보이는 장황한 어구를 지우고 단순함을 유지하라. 감동시키는 문학적 글을 쓰지 말고 단백하게 표현하는 글을 쓰라.

6. 혼란한 것보다 일관되게 써라!
기술 글쓰기에서 문구나 어미가 다르면 독자들을 혼란스럽게 해서 과학적 글과 근거를  엉터리로 보이게 한다. 글을 잘 쓰는 기술자는 숫자, 하이픈, 구두점, 등식, 문법, 기호, 대문자 사용, 기술 용어, 축약 등 기호를 쓸 때 더욱더 일관성을 유지하기 위해 노력한다.

7. 부사.관형사보다 명사.동사를 써라!
기술자는 때로 짧고 간단한 단어를 사용하는 대신 거창하고 중요한 것처럼 보이는 단어를 사용하기 좋아한다. 이것은 잘못하는 것이다.  환상적인 단어는 읽는 사람을 혼란시킬 뿐이다. 알기 쉽게 평범하게 쓸수록 독자들은 당신을 좋아할 것이다. 기술 문서에서 자주 나타나는 몇 가지 거창한 단어들과 바람직한 대안을 제시했다.

8. 수동태보다 능동태를 써라!
능동태는 수동태로 행동을 직접 표현한다.
 예를 들어 "실험은 기술자에 의해 실시되었다."라고 수동태로 쓰면 행동은 간접적이 된다. 가능하면 능동태로 쓰라.  행위의 주체가 뚜렷이 나타나고 힘찬 글이 된다. 문장도 더욱 간결하게 된다.

9. 문장보다 단락으로 나누어라!
문장은 어(語),구(句),절(節)과 함께 문법을 나타내는 언어 단위의 하나, 사고나 감정을 말로 표현할 때 완결된 내용을 나타내는 최소의 단위다. 무조건 긴 글은 독자를 복잡하게 만드는 장애물이다. 글을 소주제별로 짧은 문단으로 나누면 훨씬 시각적으로 읽기 쉽고 의미 파악도 쉽게 된다.

10. 텍스트보다 비주얼 정보를 이용하라!
실제로 그림은 글보다 의사소통하는데 좋다. 그림이나 도표와 같은 시각 정보는 글로 된 문장에 힘을 실어 준다. 사람들은 읽은 것은 10%만 기억하지만 본 것은 30%를 기억한다. 시각 정보는 기술 정보를 더욱 효과적으로 만들어 준다.

서구에서는 일찍이 이러한 중요성을 인지하고 이공계열 전공자들의 글쓰기를 강화해 왔다. 미국의 공대에서는 기술 글쓰기 과정(Technical Writing Course)을 필수적으로 가르치고 있다. 일본에서도 일찍이 이러한 기술적 글쓰기의 중요성을 인식하여 전문 기관을 설립하고 그곳에서 전문 인력을 양성해 왔다.
과학 기술이 많이 발달하기 전에는 비교적 간단한 기계 장치에 대한 사용 설명서가 매뉴얼의 주를 이루었다. 그러나 과학의 제반 분야가 발달하고 전기 전자 산업이 발달하면서 복잡한 기능을 갖춘 기계, 전기, 전자 제품이 등장하고 이러한 제품의 사용 설명서는 많아진 기능만큼이나 복잡하고 그 양이 많아졌다.
예를 들면 기계, 제품, 조립 설명서, 약 복용법, 안전 관리 요령 등의 매뉴얼을 말한다. 이제 기술자가 글쓰기를 잘하면 그 결과는 계약이 성사되는 제안서, 제품이 팔리는 광고, 기술자들이 쉽게 따라 할 수 있는 사용설명서. 상사에게 예쁨을 받는 보고서로 나타난다. 읽는 사람이 글쓴이의 메시지를 잘 이해할 수 있는 편지나 메모도 잘 작성할 수 있다.  기술자들이여! 어떤 문체와 단어 선택을 하였을 때 뜻이 분명하고 설득력이 있는지에 고민하라.