테크니컬 라이터 1년 회고

나는 지난 1년간 무슨 일을 했나?

테크니컬 라이터로 일한 지 벌써 1년이 지났다. 솔직히 고백하자면 테크니컬 라이터 혼자서 이렇게 다양한 일을 하는지 미처 몰랐다. 지금까지 맡았던 업무들을 나열해보자면 다음과 같다.

기존 기술 문서 사이트 콘텐츠 re-writing

이해가 안 되거나 어려운 내용이 있으면 고객 지원 엔지니어 혹은 개발자와 확인 후 업데이트한다. 기본적인 오탈자나 맞춤법도 수정한다.

문서 PM (Project Manager) 역할

기능 배포 날짜에 맞추어 가이드 문서도 같이 배포할 수 있도록 문서 작성 일정을 관리한다. 개발자 컨텍부터 시작해서 초안 작성 일정 확인, 초안 검수 및 테스트, 스크린샷 편집 등을 모두 포함한다.

기술 문서 사이트 플랫폼 조사

새로운 기술 문서 사이트를 기획할 때 어떤 플랫폼을 쓸지? 장단점은 무엇이 있는지? 비용은 얼마나 들지 등을 조사하고 비교했다.

기술 문서 사이트 TOC (Table of Contents) 개편

기술 문서 사이트 내용을 어떻게 구조를 짤지 목차를 기획한다. 분량이 보통 적게는 몇 백 페이지부터, 몇 천 페이지까지 된다. 구조를 짤 때는 SimpleMind 마인드맵 툴을 이용했다.

기술 문서 작성

기술 문서 내용 수준에 따라 기본적인 API 기능 설명이나 콘솔에서의 사용법 정도는 테크니컬 라이터가 직접 초안을 쓰기도 한다 (초안은 개발자가 쓰고, 테크니컬 라이터가 리뷰만 하는 회사도 많은 것 같다) 처음에는 초안을 직접 쓸 수 있나 싶어 부담이 됐다. 하지만, 사실 내용이 그렇게 어렵지 않으면 할 만했다. 기본적인 설명을 듣고 직접 기능을 테스트해보면서 초안을 쓰는 것도 꽤 재밌다.

회사 뉴스레터 및 기술 블로그 작성

무엇을 쓸지 자료 조사부터 시작해서 주제 선정 및 내용 작성까지 알아서 한다. 콘텐츠 주제는 주로 기술적인 주제 중에 사용자들이 어려워하거나 혹은 문의가 많이 들어오는 내용을 선정했다. 콘텐츠에 들어가는 디자인이나 다이어그램은 UI/UX 디자이너에게 요청했다. 이 내용을 설명하기 위해 어떤 디자인이 들어갔으면 하는지 시안을 구체적으로 협의하는 게 좋다.

UX Writing 문구 피드백

작은 회사든 큰 회사든 테크니컬 라이터가 UX Writing 업무도 겸하는 경우도 꽤 있는 것 같다. 예를 들면, 공지에 나가는 문구부터 시작해서 버튼 이름, 함수명까지 리뷰해주는 경우도 있다고 한다.

사내 글쓰기 교육 기획 및 진행

도움이 될만한 글쓰기 교육 소재를 직접 발굴하고, 개발자들에게 공유했다. ‘글을 잘 쓰는 방법: 짧게 쓰기, 쉽게 쓰기’, ‘UX 라이팅 시작하기: 고객 경험 관리를 위한 메시지 가이드’란 주제로 사내 글쓰기 교육 세션을 직접 진행했다.

내부 스타일 가이드 및 용어집 제작

개발자들이 문서를 작성할 때 참고할 수 있도록 A4 20 페이지 분량의 스타일 가이드를 제작했다. 개인적인 의견이지만 영문은 굳이 새로 제작하기보단 Microsoft Style Guide같이 잘 만들어진 가이드를 참고하는 것도 방법이 될 것 같다.

한영, 영한 번역

영문으로 기술 문서도 같이 배포되는 경우엔 한국어 버전이 완성되면 동일한 내용으로 영문도 작성했다. 꼭 기술 문서가 아니더라도 내부 구성원들에게 도움이 될만한 내용이면 번역을 도맡아 했다 (사실 기술적인 내용이 아니면 반드시 테크니컬 라이터가 번역을 도맡아야 할 필요는 없다고 본다. 이 부분은 내부적으로도 R&R이 명확하지 않을 땐 어느 정도 선을 그어야 할 수도 있다)