-
[라인개발실록] 라인 테크니컬라이터가 하는일/전망/오해와 진실 요약Technical Writing/Technical Writer 2022. 12. 11. 17:13
(사담) 2주일에 최소 한번은 포스팅을 하자고 다짐했는데 요새 너무 정신도 없고 출퇴근에 체력을 소모해버려서 정말 오랜만에 포스팅을 한다😥 예전부터 이 동영상도 보고 꼭 정리해야지 라고 결심했는데 벌써 1개월 전 영상이다. 우아한 형제들에서 진행한 [우아한 테크 세미나]에서도 테크니컬라이터에 대해 다루어서 정리했었는데, 이번에는 라인에서 진행하는 [라인 개발 실록]에 테크니컬라이터를 다룬다고 하니 안 볼 수가 없었다. 영상은 아래 링크에서 볼 수 있고 3개의 테마로 나눠서 업로드되었다.
https://www.youtube.com/watch?v=95E0EbHo2xQ
Session 1: LINE에서 테크니컬 라이터가 하는 일먼저 이인실 테크니컬 라이터님께서 테크니컬라이터 일을 하게 된 계기에 대해서 간략하게 설명해셨다. 개발자에서 매뉴얼을 만드는 일로 시작을 하시다가 개발 가이드를 만드는 일을 시작하게 되었다고 한다. "테크니컬 라이터는 글을 작성해서 사람을 연결하는 일" 이라고 생각한다고 한다. 나도 자소서를 작성할 문서를 통해 사람을 연결하겠다~라는 뉘앙스로 작성한 경험이 생각난다.
이후에는 어떤 분들이랑 협업을 하느냐도 말씀해주셨는데 매뉴얼을 만들었을 때는 PM, QA엔지니어들이랑 협업을 많이 하셨다고 한다. 반도체 장비 사에 있을 때의 나의 경험과 비슷해서 공감이 되었고, 그중에서도 개발자들이랑의 협업이 가장 많다. 개발자나 엔지니어가 작성한 문서에서 질문이 있으면 찾아가서 질문하고 질문하고...의 연속이였던 경험이 생각난다.
가장 궁금했던 LINE테크니컬 라이터가 하는 일, 처음 테크니컬라이터 직무로 라인에서 근무하면서 진행한 일은 개발가이드를 만들고 모으는 일 부터 시작했다고 한다. 본격적으로 플랫폼 문서 작업과 다국어 작업을 수행하고 이후에는 교육도 수차례 진행했다고 한다. 라인은 특히 대만 일본 한국에 개발자가 있어서 다국어 작업이 많이 이루어지고 있는 것 같다. 어디에 어떤 문서가 있는지 모르겠다라는 요청이 들어왔을 때는 태그를 정리하고 어떤 문서가 있는지 정리를 해달라고 해서 문서 컨설팅을 하신 경험 또한 있으셨다. 나도 이런 문서가 필요한데 개인적으로 어떤식으로 작성하셨는지 궁금하다🤷♀️ 2022년에는 용어사전을 만들어서 다국어로 배포했다고 한다. 나도 용어사전을 만들어서 배포하는 일을 하고 싶은데 규모가 큰 회사일수록 혼자 하기는 힘들고 중요도도 모르시는 분들이 많아서 협조를 구할 수 있을지 걱정이 된다.
이 섹션은 다른 회사에서 어떻게 일하고 있는지 프로세스를 소개해주셔서 좋았다. (18:30부터) 초안은 대부분 개발자가 작성하고 다시 쓰는 작업을 하고 내용을 보완하고 확인하는 내용이 이루어진다. 내가 작업하고 있는 방식이랑 비슷했다. 현재 도 내가 작성하고 있는 문서는 대부분 개발자가 작성하고 내가 내용을 보완하고 있다.
Session 2: 테크니컬 라이터에 관한 오해와 진실
이번 세션은 전정은 님이 진행해주셨다. 개발자로 먼저 일을 하셨고 테크니컬라이터로 직무를 전향하셨다고 한다. 전정은 님은 스스로 테크니컬라이터라기보다는 문서 엔지니어라고 소개한다고 한다. 라이터에 초점을 맞추시기보다는 엔지니어에 초점을 맞춘 것 같다.
이 세션을 진행하게 된 것은 모든 것은 글 하나로부터 시작되었다고 한다. 블라인드라는 직장인 어플에 "테크니컬라이터는 뭐하는 거야?"라는 글이 올라온적이 있는데 댓글로 '문서 노가다꾼','초안 주면 다듬어 주는 사람'이라고 올라왔다고 한다. 공감가면서도 너무 웃겼다😅..(조금 슬프기도)
이 글은 현재는 삭제된 상태지만 개인적으로 문서 노가다꾼이라고 대답하신 분은 테크니컬라이터로 근무하시는건지 궁금하다.뭔가 그쪽으로 한번이라도 일해보시지 않았을까...힘든 일을 하셨던 걸까 궁금하다.테크니컬 라이터들을 대상으로 한 설문조사 결과도 보여주는데 흥미로웠다. 설문에 응답한 테크니컬라이터 대부분은 IT쪽이고 API문서를 많이 작성하신다고 한다. 사실 나는 IT쪽은 잘 모르지만 제조업 보다는 IT분야에 종사하시는 분들이 압도적으로 많다고 느껴진다. 설문조사 결과 중에 문서 뿐만 아니라 정말 많은 일을 하고 있다는 설문 결과도 재미있었다. (나잖아..?)
개발자가 작성한 문서를 재작성할 때는 항상 두가지가 따라온다고 한다. 하나는 용어를 정리하는 것, 다이어그램 만드는 것이라고 하신다. 나도 사실 용어를 정리해야하는데 작성된 기술문서들의 내용을 이해하는데만 급급했던 것 같다. 정리하면서 용어나 규약을 좀 정리해둘 필요성이 있겠다. (개인적인 의견으로는 가끔 문서 재작성이 되게 쉬운거라고 생각하시는 분들도 많은 것 같다. 맞춤법, 오탈자, 템플릿 보기 좋게만 써주는게 아닌가요?라고 생각하시는분도 있는데 ^_ㅠ 엄청 많은 고민을 하고 리라이팅을 한다는 것을 알아주셨으면😥)
다시 주제를 넘어가서 작성 도구에 관한 이야기를 하자면 작성된 문서는 웹으로 배포하는 경우가 가장 많고, pdf로 배포하는 경우가 그 뒤를 따랐다. 작성도구는 점점 변화하고 있다고 하는데, 여기서 IT계열 테크니컬 라이터의 작성도구도 궁금했다. 나는 회사에서 거의 워드만 사용해왔는데 IT회사도 워드를 종종사용한다고는 한다. 워드는 방대햔 양의 문서를 작성할 때는 불편한점도 많은 툴이지만 아무래도 가장 접근성이 좋고 편한도구도 맞는것 같다. 워드는 글쓰는 방법이 결국 출력하는 방법이되는 툴인데 시대의 흐름은 글쓰는 방법과 출력하는 방법을 분리하는 방향으로 바뀌어 간다고 한다. 많이 쓰이는 도구는 깃북, jekyll등 자바스크립트 기반으로 한 도구들을 많이 사용된다고 한다. 새로운 툴을 다뤄보는 것도 중요하지만 그 기술을 이해할 시간에 글을 더 써보는 걸 추천한다고 한다! 결국에는 '라이팅'을 잘하는 것이 핵심이기 때문에... 새로운 도구들을 사용한다면 프론트개발에 대해 공부를 해본 후에야 효율적으로 사용할 수 있지 않을까 싶다. 나도 결국에는 이런 다양한 툴들을 개인적으로 공부해야될 것 같다. 실제로 jekyll을 써서 블로그를 만들어본 적도 있지만 익숙하지 않은 도구라 시간이 많이 걸렸다.
Session 3: 테크니컬 라이터 전망은 어떤가요? 질문을 포함한 Q&A
마지막 세션은 Q&A 형식으로 진행되었다. 그 중에서 가장 기억에 남았던 질문을 작성해보고자 한다.
어색한 외래어 표기법 지키시나요?
예시로는 Solution을 한글로 표기할때 '솔루션'이 아니라 '설루션'이 맞는 외래어 표기법이라고 한다. 설루션이 맞춤법상 맞다고는 하지만 아무래도 솔루션이 더 보편적으로 쓰이는 편이라 어색하게 보인다. 개인적으로는 외래어 표기법을 반드시 지켜야될까? 라는 입장이긴하다. 세분 중 한분은 독자들이 불편하지 않게 술술 읽히는 단어를 쓰는게 더 중요하지 않을까라는 의견을 가지고 계셨고, 다른 한분은 맞춤법은 당연히 지켜야되는 약속이다 라고 하셨다. 실제로도 섬네일, 스레드, 라이선스 라는 표현들을 다 맞게 지키신다고 한다. 그래서 설루션이라고 쓰거나 Solution 혹은 해결책이라고 써야되는거 아니냐 라고 하셨다. 두분의 의견이 다른데 라인에서는 어떻게 통일해서 사용하고 계신지도 궁금하다. 내 스스로도 많은 고민이 되는 부분중 하나이다.개발자와 협업할 때 특별한 팁이나 노하우가 있을까요?
개발자가 전체적인 문서를 볼 수 있도록 도와주는게 테크니컬라이터의 역할이고 전체적인 관점에서 밸런스와 용어 표현이 일치해야된다고 한다. 개발자는 반드시 이렇게 표시해야된다는 의견 충돌이 있던 경험이 있었는데 이때 전체적인 문서를 볼 수 있도록 설득하셨다고 한다. 단, 기술블로그의 경우에는 각각 포스트의 개성이 묻어나는게 좋다라고 말씀하셨다.테크니컬 라이터가 개발을 할 줄 알아야하나요?
이 질문도 굉장히 많이 받는다고 하는데, 꼭 필수는 아니지만 코딩까지 깊이 공부할 필요는 없겠지만 도메인 기술에 관한 이해력은 필요하다고 한다. 개발은 안하더라도 개발자와 의사소통은 해야하니까 당연히 공부해두는게 좋다. 개발이 아니더라도 작성하고 있는 기술에 대한 이해도는 필수적이지 않을까 싶다.
영상을 보면서 받아적다보니 다소 두서없이 적히긴 했지만 테크닌컬라이팅에 관해서는 아직 국내에 정보가 많이 없기 때문에 테크니컬라이팅에 관심있는 분들이라면 추천할만한 영상이다! 추가로 혼자 일하는 테크니컬라이터들을 위해 Write the docs라는 슬랙 채널을 소개해주셨는데 해당 커뮤니티도 가입해봐야겠다. 유튜브 영상에서는 라인에서 작성하고 있는 사이트들을 알려주니 나중에 참고해보는 것도 좋을 것 같다. 앞으로도 이런 영샹이 많이 올라오면 좋겠다✋
'Technical Writing > Technical Writer' 카테고리의 다른 글
[우아한 테크 세미나] "개발자도 글을 잘 써야 한다고요?" 테크 세미나 요약과 느낀점 (0) 2022.07.29 2.1-Technical Writer(테크니컬라이터) 채용공고 분석, 갖춰야할 역량 (0) 2021.09.12 1-Technical Writer(테크니컬 라이터)직무에 대해서 (0) 2021.08.26