💎토스페이먼츠 테크니컬 라이터가 하는 일 (1)

테크니컬 라이터라는 직무를 들어보셨나요? UX 라이팅이랑 헷갈리는 경우도 종종 있는데요!

두 직군은 완전 다르답니다. 테크니컬 라이터는 개발자를 위한 설계서를 작성하는 일을 해요. 일반 유저를 위한 후킹한 멘트와 문구를 작성하는 UX 라이터와는 결이 조금 다르죠.


테크니컬 라이터는 어떤 직무이고, 어떤 일을 하는지
<토스테크 블로그>에 올라 온 토스페이먼츠 테크니컬 라이터가 하는 일이라는 글을 가져와 봤습니다!


  1. 테크니컬 라이터(Technical Writer)란?

    • 개발자 고객을 대상으로 문서를 씁니다. 일반적으로 독립적으로 구성된 기술 문서 제품을 만들어 제공하죠.

    • 테크니컬 라이터의 목표는 도구나 기술을 더 빠르고 효과적으로 익힐 수 있게 돕는 것으로 복잡한 기술을 명확하고 이해하기 쉬운 언어로 전달하는 게 중요합니다.

  2. 테크니컬 라이터의 일

    • 연동 문서의 모든 것

      • 문서 전체 메뉴와 정보 구조를 만들고, 튜토리얼이나 상세한 가이드를 작성함

      • 가이드에 들어 갈 이미지를 제작하고, 예제 코드를 작성함

      • 새로운 기능을 설명하기 전 직접 개발자 고객 입장에서 테스트하고 간단한 코드를 짬

      • 개발자들이 남긴 피드백과 문의에 답변하고, 문서를 계속 유지 보수함

    • 좋은 API 만들기

      • API 리뷰는 API의 설계와 구현을 검토하는 과정으로 테크니컬 라이터 또한 리뷰에 참여함

      • 테크니컬 라이터 입장에서 설명하기 어려운 스펙은 코드스멜(Code smell)이 있다고 보고 피드백 해서 개선에 기여함

    • DevRel(Developer Relations)

      • DevRel은 개발자와 관계 맺고 상호작용하는 것을 의미함 (=일종의 기술 브랜딩)

      • 내부 개발자들이 동기부여 될 수 있도록 돕고, 외부 개발자 고객이 제품을 인식하게 함

      • ex) 토스페이먼츠의 기술적 도전, 문제 해결, 결제 연동에 대한 기술적 콘텐츠를 만들고 외부에 공유함 -> 트위터 운영, 콘텐츠 Velog / Toss.tech 발행

    • 그 밖에 팀을 위한 다양한 일들

      • 모든 맥락과 정보를 한 곳으로 모아 서로 다르게 쓰고 있던 용어를 정리

  3. 테크니컬 라이터에게 필요한 역량

    기술 글쓰기를 넘어 '개발자가 기술을 학습하고 일에 적용하는 방법을 이해하고 돕는 것'

    • 능동적으로 학습하기

      • 새로운 지식에 거부감이 없고 잘 학습해 나갈 수 있는 역량

      • 개발자의 문제 해결 과정에 관심을 가지며, 학습하기

      • 능동적으로 학습한 내용을 더 많은 사람들을 위해 양질의 콘텐츠로 공유하기

    • 기술에 서사를 부여하기

      • 학습한 지식과 정보로 글을 쓰며 일종의 서사 만들기

      • 닥친 문제에 공감하고, 해결해 나가는 과정의 서사를 잘 연결하기

    • 개발자 경험 개선하기

      • 글 외에도 영상이나 개발자 도구 제공과 같이 개발자 경험의 전체적인 여정을 이해하고 설계하기

    지금까지 <토스의 테크티컬 라이터가 하는 일> 콘텐츠를 중심으로 테크니컬 라이터가 하는 일과 역량을 알아보았습니다 :-) 더 자세한 설명을 아래 링크를 참고하세요 :-)


    https://toss.tech/article/tech-writer-1

그 많은 개발 문서는 누가 다 만들었을까 (1) 토스페이먼츠 테크니컬 라이터가 하는 일

toss.tech

그 많은 개발 문서는 누가 다 만들었을까 (1) 토스페이먼츠 테크니컬 라이터가 하는 일

다음 내용이 궁금하다면?

또는

이미 회원이신가요?

2024년 2월 13일 오전 6:44

댓글 0

    함께 읽은 게시물

    《말할 것도 없는 힘, 지속력》

    ... 더 보기

    스토리북 9 출시 소식

    ... 더 보기

    Storybook 9

    Storybook Blog

    Storybook 9

    WWDC 2025 감상. 애플은 여전히 진짜 필요한 걸 잘 만드는구나. 엄청난게 아니라, 별거 아닌 것 같지만 사람들이 매일 필요로 하는 걸 정말 잘 찾아서 제대로 만든다. 스티브 잡스가 떠난지 강산이 한 번 바뀐 시간 이후에도 계속 이렇게 하는게 대단하다는 생각도 들고, 뭔가 좌절스럽기도 하고.. 🫠


    전략적 입사 지원

    ... 더 보기

     • 

    저장 15 • 조회 968



    ⟪UX 디자이너가 사라지고 있다⟫

    ... 더 보기

    LinkedIn

    lnkd.in

    LinkedIn