많은 기업들은 디지털 상품이든 유형의 제품이든 오랜 기간 개발에 시간을 투자하고 출시를 하게 됩니다. 이러한 제품을 사용하는 소비자 또는 B2B 기업이 정확한 정보를 가지고 제품의 사용법을 익히고 사용하기 위해 소비자를 위한 제품 설명서나 B2B 기업을 위한 유지보수 매뉴얼을 작성하게 됩니다.

오늘날 디지털 디바이스, 소프트웨어, 디지털 콘텐츠 등 디지털 기술과 관련된 산업의 영역은 점점 더 커지고 있습니다. 그러나 모든 사람이 디지털과 관련된 기술적 배경을 가지고 있는 것은 아닙니다. 기업과 고객 간의 기술적 정보의 격차는 기업이 비 기술적인 개인에게 기술적인 내용을 이해시키고 동일한 경험을 제공하는 데 어려움을 겪게 만들고 있습니다.

기술 문서 작가(테크니컬 라이터)는 소프트웨어 및 디지털 제품의 기술적 측면을 이해하고 기술적으로 숙련되지 않은 사용자에게 이해시키고 전달하기위한 전문 지식을 보유하고 있습니다. 때로 테크니컬 라이터들은 사용자에게 메시지를 전달하는 부분에서 번역사와 비슷하기도 하며 사용자에게 자신의 기술적인 배경을 바탕으로 정보를 제공합니다.

오늘은 제품 설명서 및 기술문서 제작을 위해 테크니컬 라이터들과 일을 하는 기업 담당자들에게 테크니컬 라이터를 찾거나 텍스트리와 같은 전문 제작사와 일을 하기위해 테크니컬 라이터들의 업무를 소개해 드리려고 합니다.

 

 

기술문서 작가(테크니컬 라이터)는 무슨 일을 할까요?

테크니컬 라이터는 제품을 사용하는 사용자 경험을 향상시키기 위해 제품 설명서 및 교육 자료를 만듭니다. 이러한 문서는 제품설명서, API 개발자 안내서, FAQ, 설치 / 구성 지침 및 시스템 운영, 유지보수, 제품 카탈로그 등의 형태로 제공 될 수 있습니다.

테크니컬 라이터는 일반적으로 영어, 커뮤니케이션, 저널리즘, 소프트웨어 공학, 컴퓨터 과학, 기술 문서 작성, 교육, 커리큘럼 개발 또는 과학 출판 등의 학사 학위를 가지고 있습니다. 일반적으로 해당 분야 중 하나에서 몇 년 동안 전문적인 경험을 가지고 있습니다.

다양한 사용자와 효율적으로 의사 소통하기 위해서는 테크니컬 라이터가 기술 및 비기술적 인 독자를 위해 글을 쓰는 전문가가 되어야합니다. 또한 컨텐츠를 지속적으로 편집하고 수정하여 사용자가 변화하는 디지털 제품에 대해 최상의 경험을 할 수 있도록 합니다.

테크니컬 라이터는 기술 플랫폼 및 언어에 대한 배경 지식이 있어야합니다.

 

코딩 및 스크립팅 언어 (Coding & Scripting Languages)

  • AJAX
  • BeanShell
  • CFML
  • CSS
  • Git
  • JavaScript
  • Jinja
  • REST API’s
  • Python

문서 출판 소프트웨어 (Documentation Publishing Software)

  • Adobe RoboHelp
  • MadCap
  • Ektron
  • IBM
  • SDL pic
  • Whatfix

분석 플랫폼 (Analytics Platforms)

  • Google Analytics
  • Matomo
  • Mixpanel
  • Open Web Analytics

 

 

 

테크니컬 라이터의 작업 설명

 

이번 포스팅에서는 테크니컬 라이터의 업무 내용에 대해 하나하나 설명 드리는 것보다 해외 및 국내 기업들의 테크니컬 라이트의 채용 정보에서 업무 내용이나 자격요건과 관련한 내용을 소개해 드리려고 합니다.

이런 테크니컬 라이터의 채용정보를 살펴보면 테크니컬 라이터의 업무에 대한 요구사항, 보유 스킬 등을 통해 업무 내용 등 파악해 볼 수 있습니다.

문서 콘텐츠 작업 내용

  • 사용자 설명서, 제품 통합 안내서, API개발자 안내서, 플랫폼 내 지침, 설치/구성 지침 및 시스템 작업의 형태로 기술 문서를 작성합니다.
  • 비디오, 데모, 튜토리얼, 교육 자료, 일반 및 기술 개요 및 FAQ를 포함한 고객 리소스 및 교육 자료를 작성합니다.
  • 웹 기반 응용 프로그램을 위한 세부 사용 설명서 문서를 작성합니다.
  • 광범위한 내부 및 외부 파트너에게 제공할 수 있도록 클라우드 소프트웨어에 대한 매주 릴리스 노트를 작성합니다.
  • 최신 업데이트 정보, 튜토리얼, 사용자 가이드 및 기술 자료 컨텐츠를 제작할 수 있습니다.
  • 기술 사양, 개발자와의 토론 및 실제 제품 테스팅을 통해서 소프트웨어 문서를 작성합니다.
  • 자세한 사용자 안내서, FAQ, 기술 개요 및 제품 내 도움말 문서를 작성합니다.
  • 내부 문서 작성 시스템을 유지 관리하여 소비자가 제시하는 문제를 해결합니다.
  • 소프트웨어 및 시스템 엔지니어링, 시스템 운영, 테스트 및 사용자 문서를 포함한 기술 문서를 준비, 검토, 수정 및 유지 사항을 관리합니다.
  • 개발, QA, 제품 관리 및 기타 그룹과의 팀 협업을 감독하여 일반 개요, 자습서, 설치/구성 지침, 교육 자료 및 API문서를 포함한 인쇄 및 온라인 문서를 계획, 조사, 작성 및 수정합니다.
  • 온라인 비디오, 데모, 가이드 투어 및 기타 교육 기법과 같은 기존의 문서에 국한되지 않는 고객 지원 도구를 구축하고 유지 관리합니다.
  • 디지털 콘텐츠의 복잡한 개념을 학습하고 사용자가 이해할 수 있는 방식으로 정보를 전달합니다.

 

 

 

내부 커뮤니케이션

  • 제품 업데이트, 릴리스 및 수정 사항에 대한 정보를 포함하여 매주 릴리스 노트를 내부 및 외부 이해 관계자에게 게시합니다.
  • 다른 작성자의 내용 및 문서를 편집하여 일관성을 유지하고 현재 정보로 내용을 지속적으로 업데이트합니다.
  • 개발, 엔지니어링, 품질 분석, 제품 관리, 제품 마케팅 및 고객 지원을 포함한 내부 팀과 협력합니다.
  • 다른 사용자가 작성한 서면 문서 템플릿(기술 사양, RFP응답 등)을 게시하고 유지 관리하여 일관된 문서 스타일을 유지합니다.
  • 고객 및 내부 지원 담당자가 게시한 컨텐츠에 대한 피드백을 효율적이고 철저하게 처리할 수 있도록 합니다.
  • 엔지니어링, 지원 및 제품 관리 분야의 주제 전문가들과 지속적인 커뮤니케이션 및 팀워크를 통한 협업을 진행합니다.

 

유지 관리 / 업데이트

  • 제품의 문제를 테스트하고 문제 해결에 대한 통찰력을 제공하며 기술문서에 정확하고 일관성이 있는지 확인합니다.
  • 콘텐츠 관리 시스템(CMS)을 정기적으로 사용하여 초안 작성, 검토 및 게시 단계를 포함한 기술 문서의 수명 주기를 관리합니다.
  • 제품과 설명서의 정확성과 일관성을 모두 테스트합니다.
  • 계획, 스케줄링 및 추적 문서 작업을 지원하여 제품 릴리스 날짜 및 클라이언트 제공 자료를 충족합니다.
  • 애플리케이션 라이브러리를 유지 관리하고 내부 및 외부에서 사용할 수 있도록 카탈로그를 작성합니다.

 

기타 업무 스킬 요구사항

  • 영어, 커뮤니케이션, 저널리즘, 소프트웨어 엔지니어링, 컴퓨터 과학, 기술 쓰기, 교수, 교육 과정 개발 또는 과학 출판 분야에서 학사 학위 또는 이와 동등한 경력.
  • 복잡한 기술적 주제를 내부 및 외부의 전문가가 아닌 이해 관계자에게 전달할 수 있는 능력.
  • 코딩 언어 삽입을 포함한 코딩 언어 경험.
  • 문서 게시 소프트웨어에 대한 경험.
  • 문제를 해결하고 결과를 제공하기 위한 사전 예방적이고 개방적인 태도.
  • CMS를 사용하여 소프트웨어 응용 프로그램에 대한 내용을 작성한 경험.
  • 사전 릴리스부터 지속적인 유지 관리에 이르기까지 문서 수명 주기의 우선 순위를 결정하고 이해한 경험.
  • 다이어그램, 스크린 샷, 워크 플로우, 그래프 등의 정보 작성에 대한 경험.
  • 공식적인 톤이나 좀 더 가벼운 톤을 사용하여 다수의 사용자를 위해 명확하고 간결하게 쓸 수 있는 능력.
  • 워크 플로우 프로세스와 추상적 주제를 보다 명확하게 전달하기 위해 인파 그래픽을 제작해본 경험
  • API 사용자의 요구 사항을 더 잘 이해하기 위해 코드 샘플 작업에 대한 이해도.
  • 분석 기술과 빠르게 변화하는 프로젝트 요구 사항과 우선 순위에 따라 프로젝트를 운영할 수 있는 능력.

 

 

이처럼 테크니컬 라이팅 직무는 탁월한 작문 기술과 기술분야에 대한 배경 지식이 있어야 합니다. 비즈니스 쓰기 또는 편집 과정을 수반하는 콘텐츠 제작 툴에 대한 이해도가 필요합니다. 내부의 개발진과의 원활한 커뮤니케이션을 위한 스킬이 필요하며 전반적인 프로젝트 관리를 진행합니다.

하지만 무엇보다 중요한 것은 전반적인 기술에 대한 이해를 바탕으로 최종 사용자가 이해하기 쉬운 언어로 전달할 수 있는 스킬이 가장 중요합니다.