[KREW INSIDE] AI 서비스의 기술 문서를 책임지는 사람들, 테크니컬 라이터

AI 서비스의 기술 문서를 책임지는 사람들,

카카오엔터프라이즈는 기술 문서의 중요성을 인지하고, 테크니컬 커뮤니케이션 조직을 신설하였습니다. 그리고 그 안에는 완성도 높은 기술 문서 작성부터 관리, 배포, 운영 및 사내 글쓰기 교육까지 모두 담당하는 이들이 있습니다. 바로 테크니컬 라이터인데요, 테크니컬 라이터라는 직무, 실제로 어떤 일을 담당하고 무슨 역량이 요구되는지, 비전은 어떤지 궁금하지 않으신가요? 개발자에서 10년 차 테크니컬 라이터로, 이제는 카카오엔터프라이즈 AI서비스플랫폼실의 테크니컬라이팅팀을 책임지고 있는 Crystal.yull을 만나 보겠습니다.

Q. 자기소개와 함께 테크니컬 커뮤니케이션셀에 대한 소개 부탁드려요 :)

안녕하세요. 저는 카카오엔터프라이즈의 테크니컬라이팅 조직에서 테크니컬 라이터로 일하고 있는 Crystal(김유리)이라고 합니다. 제가 리딩하고 있는 테크니컬 라이팅 조직은 카카오엔터프라이즈에서 제공하고 있는 모든 기술 또는 서비스에 대한 개발 문서들을 작성할 뿐만 아니라 효율적인 문서화 프로세스 수립, 배포, 관리 등에 대한 모든 부분을 연구하고 관리하고 있습니다.

Q. 방금 답변에 기술 문서라고 말씀해 주셨는데요, 좀 더 구체적으로 설명해주실 수 있나요?

일반적으로 기술 문서라고 하면 단순히 어떤 기술 정보를 나열한 문서라고 생각하실 수 있는데요, 기술 문서는 책이나 블로그처럼 일반 독자를 대상으로 구성된 문서가 아니라 특정 독자(개발자/엔지니어)를 대상으로 작성된 문서라고 할 수 있어요. 여기서 특정 독자라고 하면 자사 또는 외부의 개발자가 될 수 있고, 경우에 따라서 일반 사용자도 될 수 있어요.

저는 기술 문서를 자사의 기능과 기술들에 대한 정보들을 효과적으로 전달하는 매개체라고 정의하고 싶어요. 기술 문서가 왜 중요하고 목차 구성이 왜 잘 되어 있어야 하는지, 그리고 어떻게 구성되고 작성되어야 잘 쓰인 문서라고 할 수 있는지에 대해서 이해를 쉽게 할 수 있도록 요리책에 비유해서 설명을 해볼게요. 요리책을 보는 사람들은 그 책을 처음부터 끝까지 다 정독하는 게 아니라 본인이 필요한 부분을 목차에서 찾아보고, 해당되는 페이지로 넘겨서 보곤 하죠. 그리고 원하는 요리 페이지를 펼치면, 요리하기 전 독자가 준비해야 하는 재료와 도구가 무엇인지, 요리 작업은 어떠한 과정으로 이루어지는지 하나하나 순서대로 나열되어 있는 식으로 내용이 구성되어 있어요.

기술 문서도 비슷해요. 처음부터 끝까지 다 읽을 수도 있겠지만, 특정 개발이나 서비스에 대한 부분을 열람하고 싶은 경우라면 목차에서 필요한 부분만 찾아 해당 페이지로 바로 이동하게 될 거예요. 즉, 기술 문서는 기술 정보를 최대한 효율적으로 이용할 수 있도록 구성된 문서라고 생각하시면 될 것 같아요. 그래서 저희는 문서의 목차를 중요하게 다루고 있어요.

Q. 개발 기술 용어가 읽히기 쉬운 기술 문서로 나오기까지, 그 과정을 간단하게 말씀해주실 수 있나요?

저희가 기술 문서를 쓸 때, 테크니컬 라이팅 프로세스라는 표준에 따라서 5단계로 업무를 진행하고 있어요.

기술 문서 작성이 필요한 경우, 처음에는 프로젝트 Kick-Off 회의부터 기획 단계를 거쳐서 문서 작성 범위, 문서 관계자, 작성 도구, 파일 형식 및 일정 수립에 대한 논의를 진행해요. 이 부분이 정의되면 문서를 작성하는 작성자와 함께 독자를 분석해서 목차 구성을 진행해요. 구성된 목차에 따라 실제 작성자께서 초안 작성을 해주시는데, 사실 기술에 대한 부분은 저희보다는 개발자분들이 더 잘 알고 계시기 때문에 초안의 내용은 개발자 분들이 직접 작성해 주세요.

작성해주신 내용을 바탕으로 저희 테크니컬 커뮤니케이션 조직에서는 추가로 필요한 내용을 검토하여 요청하거나, 사용자 입장에서 정확하고, 명확하고, 간결하면서 일관성 있도록 글쓰기 4대 원칙에 맞추어 글을 작성합니다. 이렇게 작성이 되면 리뷰의 시간이 필요한데요. 기술적인 면과 스타일적인 면에서 동료 리뷰를 진행하게 됩니다. 리뷰가 완료되면 마지막으로 배포 방식에 따라서 문서를 고객사 또는 독자들에게 전달하고, 추가적으로 다국어 버전이 필요할 경우에는 국문 버전을 기준으로 다국어 번역을 진행하고 있어요.

Q. 크리스탈의 하루 업무 일과가 궁금해요!

아침에 오면 오늘 하루 무슨 업무를 해야 할지 리스트업을 해요. 자사의 업무 공간인 아지트(Agit)에 제가 오늘 해야 할 업무들을 대략적으로 적어 큼지막하게 체크리스트를 만들고,그거에 맞춰서 일을 하려고 해요. 오늘의 미팅 일정은 언제인지 파악하고, 시간을 잘 활용해서 집중해서 글을 쓰고 리라이팅 시간을 최대한 정해서 진행하려고 하고 있어요. 기술 문서는 꼼꼼함이 좀 필요한 부분인데요, 작성해주신 내용들을 바탕으로 기술을 이해하고 사용자 입장에서 리라이팅해야 하기 때문에 고도의 집중력을 발휘해야 해요.

오전에는 어제 못했던 업무들을 하거나, 아니면 아지트에서 다른 업무들을 살펴보며 하루를 시작하고 있고요. 맛집을 찾아 점심 식사를 한 후에는 팀원분들과 티타임을 주로 즐겨요.

테크니컬 라이팅 업무는 말씀드린 것과 같이 독자와 작성자 사이에서 중간자의 역할을 하기 때문에 커뮤니케이션 능력이 아주 중요한데요, 이런 커뮤니케이션 능력이 단순히 업무적인 부분에만 해당되는 게 아니기 때문에 일상생활에서도 이해를 곁들인 의사소통을 위해 커피 한잔으로 서로의 어려움도 나누고 감사함도 표현하면서 서로를 알아가기 위해 주로 티타임을 즐기는 편이에요.

Q. 테크니컬 라이터 일을 시작하게 된 계기가 있을까요?

저는 TrustZone이라는 OS를 개발하는 회사에 개발자로 처음 입사를 했어요. 반년 정도 개발을 하다가 이전에 석사 과정에서 많은 프로젝트를 하면서 제안서, 결과 보고서 같은 문서들을 많이 작성했고, 발표자료도 능숙하게 작성하다 보니 회사의 임원분께서 저한테 테크니컬 라이터 직무를 추천해주셨어요. 우리 회사에 이런 업무를 하는 사람이 필요하고, 해외에는 이런 업무가 있다고 하는데 도전해 보는 것이 어떻겠냐고 제안을 주셨어요.

제안을 듣고 나니 테크니컬 라이터 직무가 생소하기도 하고 어떤 업무를 하는지 궁금하기도 해서 테크니컬 라이터 직무에 대해 많은 리서치를 하다 보니 점점 매력을 느끼게 되더라고요. 개발자의 경험을 바탕으로 새로운 기술에 대한 호기심도 많은 저에게는 정말 딱이라고 생각이 들었어요. 하지만 그냥 무작정 이걸 해야겠다는 생각보다는 이 직무에 대해 좀 더 정형화된 교육을 듣고 기초를 탄탄하게 만들어야겠다는 생각이 들더라고요. 그래서 회사로부터도 지원을 받고, 추가로 개인적인 사비를 털어서 테크니컬 라이팅에 대한 교육을 받고 공부도 했어요. 회사 업무 이외에 테크니컬 라이터들과 외부 활동도 하면서 테크니컬 라이팅에 대한 논의도 하고, 다른 회사들의 프로세스도 공유하고 계속 공부를 진행했어요.

Q. 테크니컬 라이터에게 필요한 능력이 있다면요?

제가 테크니컬 라이터로 거의 10여 년 동안 일을 하면서 이 직무에서 진짜 필요한 것은 무엇인가에 대해 생각을 많이 해봤어요. 생소한 직무이기도 하고 보통 “그냥 글쓰기만 잘하면 되는 거 아니야?”라는 인식만을 갖고 채용 공고에 지원하시는 분들이 많이 계시는데요. 사실 테크니컬 라이터에게는 단순히 글쓰기 능력뿐만 아니라 기술적인 내용을 빠르게 이해하는 능력, 커뮤니케이션 능력이 필요하다는 생각이 들어요.

테크니컬 라이터는 주로 개발자/엔지니어가 개발을 할 때 필요한 문서들을 작성하고, 이를 리뷰하는 업무를 주로 하고 있어요. 해당 분야의 기술적인 내용을 빠르게 이해해서 문서로 전달해야 하기 때문에 기술을 이해하는 만큼 독자에게 정확하고 명확하게 설명을 할 수 있다고 생각해요. 모든 기술에 대한 내용을 개발자만큼 상세하게 다 알아야 하는 것은 아니지만 새로운 기술에 대한 거부감 없이 빠르게 적응하고 습득하려는 열정이 있어야 할 거 같아요.

또한, 테크니컬 라이터는 사용자 입장에서 글을 써야 하면서 동시에 작성자(개발자/엔지니어)들 입장을 고려하여 그들이 가지고 있는 기술들을 잘 표현하고 알릴 수 있어야 하는 중간 커뮤니케이션 역할자이기 때문에 커뮤니케이션 스킬도 있어야 해요.

Q. AI서비스플랫폼실에서 TW로 일한다는 것?

처음 AI서비스플랫폼실에 입사했을 때는 기술 문서에 대한 모든 부분들이 미흡하고, 설계도 되어있지 않은 하얀 도화지같은 상태였다면, 지금은 저희 테크니컬 커뮤니케이션 조직에서 원하는 방향으로 하나씩 그림을 그리면서 채워나가고 있다는 것이 개인적으로는 뿌듯한 마음이에요.

TW 전담 조직이 있다는 사실 자체가 회사에서 기술 문서에 대한 중요성을 잘 알고 있다는 것을 보여 준다는 생각이 들어요. 카카오엔터프라이즈의 AI서비스플랫폼실에서도 기술 문서 중요성에 대한 인식이 크다는 것에 대해 모든 크루들께도 감사하게 생각하고 있어요.

저도 이공계 출신이긴 하지만 아직까지 이공계 전공을 하신 분들께서 글쓰기가 어렵다고 많이 말씀해주셨어요. 이런 어려움과 거부감 같은 것들을 저희 테크니컬 커뮤니케이션 조직에서 줄여보겠다는 목표를 가지고 있어요. 글쓰기에 대한 많은 정보들을 공유 및 교육하고, 다양한 커리큘럼으로 글쓰기에 대한 친근감을 만들어 보겠다는 미션에 충실히 임하고 있습니다. 이러한 미션들을 하나씩 해결하면서 즐거운 책임감도 생기고, 테크니컬 라이터 직무를 저희 카카오엔터프라이즈의 내부뿐만 아니라 국내 또는 나아가 해외에도 널리 알릴 수 있을 것이라는 기대감을 가지고 있습니다. 이렇게 테크니컬 라이팅에 대한 중요성을 알고 있는 회사와 팀에서 일을 한다는 게 저한테는 개인적으로 너무 행복한 일이고, 저 또한 새로운 기술들을 많이 배우고, 다양한 경험을 통해서 성장하고 있다고 생각해요.

기술 문서의 문장 하나하나가 사용자가 서비스에 대해 느끼는 만족감과 편리함에 중요한 역할을 하기도 합니다. 기술 문서를 작성하는 일에 즐거운 책임감과 중요함을 느끼는 Crystal을 보며, AI서비스플랫폼실에서 얼마나 큰 자부심을 가지고 일하는지에 대해서 느낄 수 있었습니다. 헤이카카오를 만들어가는 사람들, 다음엔 다른 분과의 즐거운 인터뷰 소식으로 다시 돌아오겠습니다 :)