본문 바로가기

테크니컬 라이팅/WTD 컨퍼런스

WTD 애틀랜틱 2023 - 어떻게 복잡한 기술을 쉽게 전달할까

반응형

스플렁크에 합류하고 나서 오픈텔레메트리에 대한 이야기를 PM과 했습니다. PM은 자신도 오픈텔레메트리를 이해하는데 6개월 이상이 걸렸다고 하소연을 합니다. 그럼 나(테크니컬 라이터)는 어떻게 이 기술을 이해할 수 있을까요?

 

오픈텔레메트리 웹사이트는 여기입니다.

https://opentelemetry.io/

나름 한국어로 된 쉬운 자료는 제니퍼소프트에서 발행한 글을 참고하세요.

https://jennifersoft.com/ko/blog/tech/opentelemetry/

 

하지만 이런 자료들을 테크니컬 라이터 입장에서 보면 이런 기분이라고 합니다.

이게 뭐야 싶은 거죠.

 

 

기술을 제대로 이해하려면 엔지니어의 경우에는 오랜 시간의 수련이 필요합니다. 하지만 테크니컬 라이터처럼 기술을 가지고 뭔가 하려는 것은 아니지만 기술을 제대로 이해해야 하는 경우에는 이런 방식을 사용할 수 없습니다. 그런 경우에 활용할 수 있는 것이 미디어 같은 것입니다. 예를 들어 SHENZHEN I/O 같은 퍼즐 게임은 게임을 통해 회로에 대해 이해할 수 있는 그런 방식입니다.

참고로 기술을 제대로 이해한다는 것에 대한 이야기를 자신의 블로그에 가볍게 정리해 놓았습니다.

https://passo.uno/circles-product-truth/

 

어느 날 해커 뉴스에서 아파치 카프카를 동화 형식으로 설명한 웹사이트를 발견했습니다.

https://www.gentlydownthe.stream/

 

그래서 오픈텔레메트리 기술을 설명하는 동화를 만들기로 했습니다.

동화는 일반적으로 다음과 같은 특성을 가집니다.

- 문장이 짧고 읽고 이해하기 쉽습니다.

- 그림과 문장이 잘 어우러져있습니다.

- 모든 걸 다 설명하지는 않습니다. 상상할 수 있는 여지를 남겨놓습니다.

- 특정 용어를 사용하기보다는 은유적으로 설명합니다.

 

조직 내에서 오픈텔레메트리 기술을 심도 있게 다루는 동료들이 있어서 동화에서 사용한 은유나 설명이 적절한지 피드백을 받을 수 있었습니다(그냥 맘대로 은유적인 표현을 사용하면 위험할 수 있는데 어찌 되었든 전문적인 검토를 받았다고 하는군요). 일러스트도 혼자서 어찌어찌해보려고 하다가 도저히 안되어서 일러스트 전문가를 섭외했는데 그 비용이 자신의 한 달 급여보다 많아서 회사에 도움을 청했다고 합니다(영상에도 나오지만 이미 스플렁크에서는 일러스트를 사용한 가이드 책자를 만든 경험이 있고 오픈텔레메트리에 긴밀하게 연결되어 있어서 마케팅 조직에서도 쿨하게 허가해 준 것 같네요).

 

1년 넘게 진행된 작업이고 수백 건의 이메일이 오고 갔습니다. 그 결과물은 아래 링크에서 볼 수 있습니다.

https://www.splunk.com/en_us/resources/amir-and-the-magical-lens.html

 

 

https://youtu.be/2C4XJe7OPT0?si=Q2fVJMwGD3rFzp-x

 

https://flic.kr/p/2p3Ws4j

 

OnceUponaTime

 

www.flickr.com

 

728x90