B2B 기술문서 이해하기 쉽게 쓰는 법
직구를 예쁘게 던진다고 생각하시면 됩니다
기술문서를 자주 읽고, 활용해보고, 개선 작업도 해 본 결과, 기술문서가 읽기 어렵게 쓰이는 이유는 흔히 말하는 '기술용어가 어려워서'는 아니다. 그 이유도 없지는 않지만, 사실 기술용어는 말 그대로 어휘이기 때문에 그 용어를 피하다 보면 오히려 모호한 글이 되는 문제가 생긴다. 차라리 기술용어를 정확히 사용하되, 보편적이지 않은 용어라면 용어 풀이를 넣어주는 방식으로 개선하는 것이 나은 경우가 많았다.
기술문서가 이해하기 어렵게 쓰이는 진짜 이유는
기술문서가 이해하기 어렵게 쓰이는 진짜 이유는 '작성자의 의도가 분명히 있지만, 그 의도를 뚜렷하게 드러내는 것을 부담스러워 하기 때문'이다. 기술문서도 결국 영리활동을 하는 기업에서 작성하는 것이기에 원하는 방향성이 있다.
'A 기술보다 B 기술이 좋다'라거나, 또는 '이렇게 더 좋은 B 기술을 우리 솔루션에 도입했으니 많관부!' 같은 이야기를 전하고 싶은 것. 물론 콘텐츠의 성격에 따라 작성자의 의도를 얼마나 노골적으로 드러내느냐에 차이를 둬야 할 필요는 물론 있지만, 중립적으로 작성해야 한다는 조심성이 너무나도 과하면 오히려 아무도 이해할 수 없는 글이 된다.
앞서 잠깐 예를 든 'A 기술보다 B 기술이 좋다'는 메시지를 전달하고 싶다면, 비교의 의미가 확실하게 전달되도록 작성하고 적절한 접속사를 활용하면 좋다.
[이해하기 어려운 문장의 예시] 'A는 ~하고, B는 ~한다.'라고 나열된 문장에는 어떠한 의도도 보이지 않아서 독자가 글을 이해하기 위해 더 많은 생각을 해야한다.
아래의 문장은 [이해하기 쉬운 문장]의 예시다.
[개선 방안(1)] A와 B의 우열을 비교하고 싶다면 'A는 ~하는 것이 반해, B는 ~를 한다'라고 표현하는 것이 좋다.
[개선 방안(2)] 비교의 방법으로는 이런 것도 있다. 'A는 예전에 자주 사용되던 방법이었던 것에 반해, B는 최근에 대두되고 있는 방법이다'라는 표현은 시점, 또는 트렌드의 관점에서 A와 B를 비교하겠다는 의도를 쉽게 읽을 수 있다.
[개선 방안(3)] 꼭 비교가 아니더라도, 선후 관계를 표현하고 싶다면 'A 프로세스가 모두 끝난 뒤에, B 프로세스가 진행된다'라고 분명하게 적어주는 것이 좋다.
A와 B에 대한 문장에 대해 세 개의 예시를 적을 수 있을 만큼, 다양한 의도가 존재한다. 보다 의도에 적합한 문장을 짓고, 의미에 맞는 접속사를 활용하면 훨씬 읽기 편해진다.어휘를 다양하게 활용해야 읽기 쉬운 기술문서가 탄생한다
어휘를 다양하게 활용하면, 더 읽기 쉬운 기술문서를 쓸 수 있다
단순히 단어 중복을 피해야 한다는 이야기가 아니다. 정확한 의미의 어휘를 골라서 사용하다보면 결과적으로 어휘가 다양해질 수 밖에 없다는 이야기를 하고 싶었다.
'A는 ~라고 말했다'라는 문장에 문제는 전혀 없지만, '말했다' 대신 좀 더 정확한 의미의 어휘를 찾아서 사용하면 독자가 그 문장의 의도를 좀 더 쉽고 분명하게 이해할 수 있다.
예로 든 '말했다'라는 단어는 그 의미에 따라 이렇게 바꾸어 사용할 수 있다.
시점에 대한 의미를 담아 과거의 일이라면 '회고했다', '기록했다' 같은 단어를 사용할 수도 있고, 미래의 일에 대한 의미를 담고자 한다면 '예견했다'라고 쓸 수 있다.
평가에 대한 의미를 담아 '호평했다'처럼 긍정적인 의미, '평가했다'처럼 중립적인 의미, '경고했다'처럼 부정적인 의미를 담을 수도 있다.
B2B 기술문서 작성 시 사용하는 생성형AI 툴 'Gemimi'이런 작업을 할 때 생성형 AI가 유용하다. 마케터가 생성형 AI를 쓰는 방법은 다양하지만, 나는 콘텐츠를 작성하는 초반 작업(개요 짜기 등)을 할 때는 생각이 갇힐까봐 잘 쓰지 않는 편이고, 다 작성된 콘텐츠를 검토시켜서 놓친 내용이 없는지 확인하거나, 보다 정확한 어휘를 찾는 후반부 작업에 주로 사용한다. 이런 용도로 사용해본 것 중 가장 만족스러웠던 서비스는 Gemimi다.
내가 작성한 기술문서, 이해하기 쉬운지 검토할 때 가장 좋은 방법은 '들어보는 것'이다
텍스트를 읽을 때는 쉼표, 따옴표 같은 문장부호의 도움을 받을 수 있지만, 음성으로 들을 때는 그런 도움이 없기 때문에 '텍스트를 보지 않고 듣기만 할 때도 쉽게 이해가 되는 글'이면 정말 이해하기 쉬운 글이라고 생각한다. 그래서 중요한 글, 오래 남을 글은 꼭 TTS 툴(텍스트→음성 변환 툴)을 통해 들어보면서 잘 이해가 되는지 검토하는 편이다.
한 개의 글을 쓰고, 퇴고하느라 오래 붙잡고 있다 보면 눈에 완전히 익어 버려서 읽지 않아도 읽은 것 같은 상태가 되는데, 이럴 때 눈을 감고 TTS 툴을 통해 들어보면 새로운 글처럼 느껴져서 좀 더 객관적인 검토가 가능해지는 효과도 있다.
B2B 기술문서 검토할 때 자주 사용하는 TTS 툴 '네이버 파파고'TTS 툴을 자주 사용하지는 않기 때문에 PC 접근성이 좋은 네이버 파파고 정도면 충분하다고 생각한다. TTS 툴에 넣기 전에 (괄호) 안의 글자는 지워주는 것이 좋다. 텍스트 원고를 붙여넣기 한 뒤 좌측 하단의 '발음듣기'를 누르기만 하면 된다.
