상세 컨텐츠

본문 제목

라인에서 테크니컬 라이터는 어떻게 일할까?

테크니컬 라이팅

by 열이아빠 2021. 4. 13. 12:23

본문

지난 3월 일본 라인에서 테크니컬 라이팅 밋업이라는 영상을 공개했습니다. 라이브로 진행된 밋업을 정리해서 유튜브에 공개했더군요. 매달 1회 정도 진행할 예정이라고 합니다. 

3월에 공개한 영상은 2개의 세션으로 진행됐는데 첫 번째 세션은 개발자를 위한 글쓰기 팁이고 두 번째 세션은 테크니컬 라이터가 하는 일에 대한 소개입니다. 두 번째 세션에 일본 라인에서 어떤 식으로 일을 하는지 간단하게 소개하고 있어 그 내용을 간략하게 소개합니다.

 

1. 테크니컬 라이터는 무슨 일을 하나요? 어떤 글을 쓰나요?

주로 하는 일은 외부에 공개되는 개발자 문서를 작성합니다.

예를 들어 라인 로그인 기능을 내 사이트에서 어떻게 구현해야 하는지 알고 싶다면 라인 개발자 사이트에서 관련 가이드와 API 문서를 찾을 수 있습니다. 기본 작성되는 문서는 일본어와 영어로 작성됩니다.

 

2. 라인에서는 어떻게 문서를 작성하나요?

마크다운으로 문서를 작성합니다. 별도의 문서 작성 도구를 사용하지는 않고 VS Code에서 작성합니다.

로컬에서 작성한 문서(마크다운)는 깃허브 저장소에 풀 리퀘스트를 요청하고 동료 테크니컬 라이터 또는 제품 담당자가 내용을 샌드박스에서 검토합니다. 샌드박스에서는 실제 운영 사이트와 같은 환경에서 문서 내용을 검토할 수 있습니다.

 

리뷰를 통과하면 master(요즘에는 main이라는 용어를 사용합니다)에 병합해주고 젠킨스를 통해 배포가 처리됩니다.

문서 작성은 일본어로 작성하고 영어로 번역될 수도 있고 그 반대의 경우도 있습니다.

 

문서 작성 전에는 개발자와 30분 정도 미팅을 진행하거나 개발자가 작성한 기본 사양 문서를 받아서 확인합니다.

2020년 하반기 기준 116회 배포가 진행되었는데 대략 하루에 한 번 정도 새로운 문서를 작성하고 배포하고 있습니다(아마도 신규 문서뿐 아니라 수정 및 변경도 포함된 듯합니다).

 

3. 테크니컬 라이터 팀은 어떻게 구성되었나요?

2021년 3월 기준 6명의 테크니컬 라이터가 Developer Content Team에서 일하고 있습니다. 

기본적으로 라인에서 공용으로 사용하는 언어는 영어지만, 회의 시에 필요한 경우 통역을 요청하면 지원해줍니다. 아무래도 일본어만 쓰는 테크니컬 라이터는 영어로만 대화하기에는 어려움이 있어서~

4. 문서만 작성하나요?

앞에서 외부에 공개되는 문서를 작성한다고 했는데, 내부 공유 자료에 대한 리뷰나 작성 지원도 합니다.

그리고 사내 교육에도 참여합니다. 최근에는 신입 개발자 교육 커리큘럼에 테크니컬 라이팅이 포함됐다고 합니다.

 

5. 테크니컬 라이터가 기술을 어느 정도 알아야 하나요?

결론적으로 기술을 쉽게 설명하려면 기술의 배경을 이해하고 있어야 합니다. 예를 들어 라인 로그인 기능을 설명하려면 단순히 어떻게 API를 적용하느냐도 중요하지만 OAuth 개념을 먼저 이해해야 합니다. 그렇지 않고 기능만 설명해버리면 어느 부분에서 이해하기 어려운 문서가 만들어져 버립니다.

좋은 테크니컬 라이터가 되려면 항상 새로운 기술에 관심을 가지고 익히도록 해야 합니다.

 

6. 테크니컬 라이터는 어떤 사람에게 적합한가요?

기술에 대한 이해력과 문장력. 2가지가 중요하지만 발표자는 기술에 대한 이해력이 더 중요하다고 합니다.

뭐 이건 발표자의 개인적인 의견이긴 하겠지만, Yoshiko Horikoshi 같은 경우 개발자 > 홍보 > 인프라 > 테크니컬 라이터로 독특한 커리어를 가지고 있고 최근 기술 관련 서적을 집필한 경력을 가지고 있어서 그렇게 설명한 것이 아닌가 싶습니다. 첫 번째 발표자인 Yazaki Makoto는 개발 경력 없이 테크니컬 라이터로 20년 경력을 가지고 있는 분이라 의견이 다를 수는 있을 듯합니다. 특히 ビートラスト(beatrust.com/)라는 회사에서 16년간 테크니컬 라이터로 일했다고 하네요.

하지만 라인 테크니컬 라이터를 지원하는 분들에게는 기술에 대한 이해력이 어느 정도 중요한지 가늠할 수 있는 부분이 아닌가 싶습니다.

 

* 영상은 아래 링크를 참고하세요.

youtu.be/nmFVXJGiCxM

 

728x90
반응형

관련글 더보기

댓글 영역