오랜만에 공식 개발자 컨퍼런스에서 테크니컬 라이팅을 다루는 세션입니다. 라인의 경우에는 테크니컬 라이팅 팀에서 매월 밋업 행사를 온라인으로 진행하는 등 여러 형태로 활동하고 있는데요. 그러한 노력 덕분에 독립적인 세션을 유치(?)할 수 있었던 것 같습니다. 그냥 일만 하면 아무도 알아주지 않는다는 ^^
세션의 내용은 이전 밋업과 크게 다르지 않습니다. 테크니컬 라이터라는 직군 자체가 생소할 수 있는 분들이 많아서 기본적인 내용으로 진행하고 엔지니어도 관심을 가질 수 있도록 문서 퍼블리싱 플랫폼에 대한 설명도 포함하고 있습니다.
당연히 영어, 한국어는 자막이라 생각했는데 동시통역이었나 봅니다(라이브가 아니라 사전 녹화였을텐데 왜 동시통역을 ㅠㅠ). 동시통역이 들어가니 뭔가 행사장 분위기가 살짝 나긴 합니다.
간략하게 내용을 정리해보았습니다.
테크니컬 라이터는 무엇인가요?
- 대부분 잘 모르는 직군임
테크니컬 라이터가 만든 문서는 뭐가 다른가요?
- 실제 사용자 입장에서 전후 맥락을 고려해 문서를 작성함
- 엔지니어는 기능 자체에 초점을 맞추지만 테크니컬 라이터는 사용자가 과업을 진행할 수 있도록 하는데 초점을 맞춤
회사에서 테크니컬 라이터는 무슨 일을 하나요?
- 일반적으로 매뉴얼을 만드는 일을 함
- 라인은 외부 개발자를 위한 기술 문서를 만듬
라인의 테크니컬 라이팅 팀 구성은 어떠한가요?
- 테크니컬 라이터 6명, 엔지니어 1명
- 영어, 일본어, 한국어 문서로 작성, 일부 문서는 중국어로도 제공
(한국 라인은 또 별도 조직으로 운영된다고 알고 있습니다. 세션에서 설명하는 것은 일본 라인의 경우입니다. 물론 플랫폼은 같이 사용하겠죠~. 뒤에 설명되지만 엔지니어가 테크니컬 라이팅 팀에 있는 것이 독특한 케이스입니다. 문서 배포를 위한 플랫폼을 만들고 개선하는 작업을 지원합니다. 문서 콘텐츠에 대한 기술적인 조언을 하는 역할이 아니라 일반적인 회사의 전산팀의 역할을 팀 내에 별도로 구성한 형식입니다).
라인의 문서 작성 절차는 어떤가요?
- 테크니컬 라이터의 메인 언어에 따라 작성
- 번역도 팀 내에서 진행
- 스펙 문서를 받거나 라인 내부 위키 페이지에 작성한 내용을 기반으로 작성
- 마크다운으로 작성
- Vale, textlint를 사용해 문서에 대한 기본 규칙 검증
- 로컬에서 웹브라우저로 실행해서 내용을 확인하고 교정 진행
- 풀리퀘스트 요청
(1) 기본 규칙 자동 체크
(2) 샌드박스 페이지 생성
(3) 교정 담당자는 샌드박스 페이지에서 검토 진행
라인에서는 얼마나 많이 문서를 배포하나요?
- 한 달에 25번 정도 배포
회사에 테크니컬 라이터가 있으면 뭐가 좋은가요?
- 문서의 품질이 향상됨
- 기술지원으로 접수된 이슈에 대해서도 대응
- 개발자 본인이 개발 결과에 대해 문서를 작성하는 것은 쉽지 않음
어떤 사람이 라인에서 테크니컬 라이터가 될 수 있나요?
- (필수) 스펙 문서를 이해할 수 있는 수준의 기술적 배경
- 알기 쉬운 문서를 작성할 수 있는 능력
- 모국어가 아닌 언어(일본어 또는 영어)를 읽고 쓸 수 있는 수준
* 기술적 배경에 대해서는 좀 애매한데, OAuth 같은 경우 물론 테크니컬 라이터가 기본적인 배경은 이해해야 하겠지만, 제품(솔루션) 단에서 사용자가 OAuth에 대한 배경 지식 없이도 사용할 수 있게 지원한다면 그렇게 중요한 요소는 아닐 수도~
규모에 따라 다르겠지만 테크니컬 라이터가 작성할 대상 문서에 필요한 기술적 배경을 모두 다 갖추는 것은 한계가 있습니다.
해당 지식보다는 기술을 보고 이해할 수 있는 정도의 배경 지식 정도가 아닐까 싶네요.
- 외부에서 새로운 테크니컬 라이터를 찾는 것은 쉽지 않기 때문에 사내에서 주로 찾게 됨 (테크니컬 라이터 구인 정보가 많지 않은 이유)
문서 UX
- 잘 작성된 문서라도 웹사이트 UX가 좋지 않다면 사용자 입장에서 불편할 수 있음
라인 문서 퍼블리싱 환경
- VuePress 기반으로 SPA 구현
- 일래스틱서치로 전문 검색 구현
- 피드백 기능 구현
- 인터랙티브 API 레퍼런스 기능 제공 (API 플레이그라운드)
라인 테크니컬 라이팅팀에서 엔지니어의 역할
- 엔지니어 입장에서는 외부 개발자, 내부 테크니컬 라이터 모두 고객임
- 문서 퍼블리싱 환경을 만들고 있고 주 사용자는 테크니컬 라이터임
- 기본 마크다운을 확장할 수 있도록 VuePress에서 사용할 수 있는 Vue.js 컴포넌트 개발
> Vue.js 컴포넌트 개발 사례 2가지
(1) 인터랙티브 API 레퍼런스 기능 - 세부 기능 각각이 개별 Vue.js 컴포넌트임
(2) Messagine API 스티커 찾기 기능 - 기존 PDF에서 웹사이트 내 찾기 기능으로 개선
* 밋업 관련해서는 이전 글을 참고하세요. 앞 부분 내용은 살짝 비슷합니다.
https://koko8829.tistory.com/2173
라인에서 테크니컬 라이터는 어떻게 일할까?
지난 3월 일본 라인에서 테크니컬 라이팅 밋업이라는 영상을 공개했습니다. 라이브로 진행된 밋업을 정리해서 유튜브에 공개했더군요. 매달 1회 정도 진행할 예정이라고 합니다. 3월에 공개한
koko8829.tistory.com
