한빛출판네트워크

기술의 빠른 발전으로 소프트웨어 서비스나 제품의 출시 주기는 가속화되고, 제품 내부는 더 복잡해지고 있습니다. 이로 인해 제품이나 서비스를 빠르게 파악할 수 있는 기술 문서의 수요가 높아지고 있죠. 물론, 효율적인 개발과 협업을 돕는 다양한 개발자 문서도 그렇고요. 기술정보를 가공하여 독자가 소화하기에 적합한 문서를 만드는 일인 테크니컬 라이팅과 이를 작성하는 테크니컬 라이터의 중요성이 날이 갈수록 높아지고 있는 이유인데요.

회사 규모나 사업 특성, 여러분이 하는 일에 따라 회사에 독립적인 테크니컬 라이팅 팀이 있는 경우도 있고, 소수의 테크니컬 라이터가 별도 조직에 소속되어 일하는 경우도 있습니다. 어떤 회사에서는 개발자나 다른 직무 담당자에게 문서화를 맡기다가 필요성을 절감하고 테크니컬 라이터를 새로 채용하기도 하죠. 또한 테크니컬 라이팅 업무에 대한 정의가 저마다 다르기도 합니다. 한 가지 공통적인 것은 기술 문서의 수요와 중요성이 높아지는 만큼 앞으로 우리 주변에서 어렵지 않게 접할 수 있게 될 거라는 사실입니다.

테크니컬 라이팅과 테크니컬 라이터

테크니컬 라이팅은 기술 정보를 가공하여 독자가 소화하기에 적합한 문서로 만드는 일입니다. 테크니컬 라이터는 이 일을 전문적으로 하는 사람으로, 복잡한 정보를 독자가 이해하기 쉽게 정제하여 명확하고 간결한 문서를 만들어냅니다.

테크니컬 라이터는 ‘라이터(writer)’라는 이름에 담긴 글쓰기 이외에도 기술 콘텐츠를 만드는 데 필요한 다양한 활동을 합니다. 문서화 계획을 세우고, 정보를 취합하여 초안을 작성하고, 문서를 편집하여 배포하며, 전반적인 문서화 프로세스를 관리합니다. 문서에 들어갈 다이어그램, 이미지 등 시각화 자료를 만들기도 하며, 문서가 늘어나도 일관성과 명확성을 유지할 수 있도록 스타일 가이드나 용어집 같은 표준 참고 자료를 관리하기도 합니다.

테크니컬 라이터가 만드는 문서는 제품의 성격에 따라 달라집니다. 제품이 일반 소비자용 기기나 앱이라면 매뉴얼이 주 산출물이 되지만, 개발자가 사용할 서비스나 SDK, API라면 개발 가이드, API 레퍼런스 등 개발자 문서가 주 산출물이 됩니다.

테크니컬 라이터의 업무 소개

그림1. 테크니컬 라이터의 주요 업무와 유관 부서(또는 직무)

 『Docs for Developers 기술 문서 작성 완벽 가이드』에 나오는 프로세스를 참고해 개발자들이 직접 개발자 문서를 작성할 수도 있지만, 중요한 변곡점이 찾아왔을 때는 전문가인 테크니컬 라이터의 도움이 필요합니다.

일반 사용자용 앱만 만들던 회사에서 개발자를 위한 서비스와 API를 제공하는 B2B 사업을 새로 추진하는 경우나 오래된 개발자 사이트의 구조를 개편하는 데 어려움을 겪는 경우 등이 그렇습니다. 이번 글에서는 국내 소프트웨어 회사에서 테크니컬 라이터가 일반적으로 맡게 되는 업무를 간략히 살펴보고자 합니다

➀ 문서 콘텐츠 개발

기술 문서 콘텐츠를 만들어 내는 일로, 일반적인 기술 문서 작성의 작업 흐름을 포함합니다. 다음처럼 몇 가지 범주로 나누어 볼 수 있습니다.

제품이 국내 사용자만 타깃으로 한다면 한글로 문서를 작성하면 되지만, 외국인 사용자도 염두에 두는 경우 문서를 처음부터 영어로 작성하거나, 한글로 작성한 후 영어로 번역합니다. 다른 언어가 필요한 경우 다국어화를 진행하기도 합니다.

② 문서화 엔지니어링

정보의 구조를 분석하고 데이터 변환과 검증, 문서 생성을 툴로 자동화하여 생산성을 높이는 일로, 『Docs for Developers 기술 문서 작성 완벽 가이드』 11장 ‘문서 유지 관리 자동화하기’ 섹션과 관련이 있습니다.

③ 문서화 플랫폼 유지 관리

문서화 플랫폼은 문서 사이트를 만드는 데 사용되는 시스템 또는 툴을 의미하며, 워드프레스WordPress 같은 서버 기반 CMScontent management system (콘텐츠 관리 시스템) 또는 정적 사이트 생성기가 될 수 있습니다. 어떤 제품을 처음으로 문서화할 때는 문서화 플랫폼을 직접 조사하고 선정하거나 의사결정 과정에 참여하며, 문서화 플랫폼이 결정된 이후에는 기능을 최적화하는 일을 합니다.

④ 문서화 교육

사내 개발자들이 직접 문서화를 잘 할 수 있도록 교육하는 일을 맡을 수도 있습니다. 문서화에 대한 회사의 전략이나 인력 구성에 따라 교육 업무의 비중이 높을 수도 있습니다.

⑤ 기타 업무: 문서 번역 검수 및 기술 콘텐츠 검수

외국에서는 테크니컬 라이터가 영어를 비롯한 자국어로 문서를 작성하고 다국어화 요구 사항이 있다면 현지화 담당 팀이 번역 관리 업무를 맡습니다. 하지만 국내에서는 현지화 담당 팀이 별도로 있기보다는 테크니컬 라이팅 팀에서 번역 업무를 관리하는 경우가 많습니다. 보통은 사내 번역 담당자나 외부 업체가 번역을 하고, 테크니컬 라이터가 번역을 검수를 진행합니다.

이외에 회사 기술 블로그에 게시될 아티클을 검수할 수도 있습니다. 회사에 UX 라이터가 별도로 없다면 개발자나 UX 디자이너가 작성한 UI 텍스트의 검수를 담당하기도 합니다.

이 글은 도서 『Docs for Developers 기술 문서 작성 완벽 가이드』 내용에서 일부를 발췌, 작성하였습니다. 국내에도 회사마다 다양한 문서화 프로젝트를 수행하는 테크니컬 라이터분들이 있습니다.

우아한 형제들, 카카오엔터프라이즈, 쿠팡, AWS, LINE Plus, NHN Cloud, 데브시스터즈, 넷마블 등 국내 조직의 다양한 형태와 관점에 따른 테크니컬 라이터의 경험은 『Docs for Developers 기술 문서 작성 완벽 가이드』에서 상세히 확인해 보세요.

『Docs for Developers 기술 문서 작성 완벽 가이드』