테크니컬 라이터를 위한 6가지 새해 결심과 목표

이 포스팅은 '7 New Year's Resolutions for Technical Wrtiers'(원문링크)의 포스팅을 번역하고 나는 이제까지 어떻게 공부해 왔는지 되돌아보고 올해 목표 설정 해보려고 한다. 

원문 링크의 목표는 2023년에 시도해야 할 7가지 테크니컬라이팅 목표와 역량을 향상하기 위해 염두해야 할 사항을 설명하고자 한다. 이 글은 2022년 12월에 올라온 글이고 1월부터 이 글을 토대로 목표를 세워야지!라고 결심을 했지만 이런저런 일로 이제야 포스팅을 마무리한다.(임시저장한 글만 몇 개인지 모르겠다😂)

---

1. 테크니컬 라이터 컨퍼런스 참여하기

컨퍼런스 및 기타 업계 이벤트를 통해 테크니컬라이터로 성장을 촉진하고 업계 사람들과 연결될 수 있다. 테크니컬 라이팅이라는 주제만으로는 컨퍼런스를 찾기 힘들지만 API , SDK 소프트웨어 문서 관련된 컨퍼런스는 나름 쉽게 찾아볼 수 있다. 내가 최근에 관심을 가지고 등록까지 해둔 컨퍼런스는 API THE DOCS에서 진행하는 컨퍼런스이다. 이런 계열의 비슷한 컨퍼런스는 해외에서 진행되기 때문에 영어자막+새벽시간에 들어야 하는 고충이 있지만, 이 사이트에서는 녹화본과 슬라이드쇼까지 제공한다! 관심 있는 주제만 찾아봤는데 꽤 자주 진행되기도 하고 무료로 지난 세션들도 볼 수 있다는 점이 가장 좋았다. 

이외에도 원문에서는 Write the Docs도 추천하고 있다. 2023년에 컨퍼런스가 열리는 걸로 알고 있는데 아마 오프라인에서 열리는 것 같다. 문서화와 관련된 주제로 커뮤니티도 활발하고 테크니컬라이팅 관련해서 나름 유명(?)한 사이트이기 때문에 한 번도 접속해보지 않았다면 한 번 즘은 들어가서 보는 것을 추천한다. 

2. 테크니컬라이팅 과정 교육 수강하기

테크니컬 라이팅 교육이력은 이력서에서 경쟁력이 될 수도 있다고 말한다. 원문에서도 내가 이전에 포스팅했던 Google Developers 과정을 소개하고 있다. 이 과정은 기술문서를 작성하는데 아주 기본이 되는 사항들을 설명하고 있다. 이외에도 영어로 진행되는 강의들은 정말 많다. Udemy만 검색해 봐도 소프트웨어 문서를 작성하는 방법에 대해서 다루고 있는 강의가 많으니 꼭! 올해에는 수강해 봐야겠다. 혼자 API관련해서 공부를 하고 포스팅을 하고 있기도 하지만 강의가 있으면 조금 더 이해도가 높아지지 않을까 싶다.(자막도 설명도 영어지만... 겸사겸사 영어공부도 하는 거지😣) 하지만 Udemy에서 들은 강의가 수료증을 받는 다고 해서 경쟁력이 있을지는 모르겠다. 

국내에서 진행되는 과정도 있다. 처음 테크니컬라이팅이라는 직무를 알았을 때는 교육과정이 많지는 않았지만 지금은 TTA(한국정보통신기술협회)에서 진행하기도 하고 한겨레에서도 진행한다. 두 가지 교육과정 모두 들어보았는데 정보가 없는 나에게 정말 도움이 많이 되었고 실제로 매뉴얼을 작성할 때도 많은 도움을 받았다. 특히 한겨레에서 진행되는 교육이 꽤 긴 시간 동안 진행되기도 하고 내용도 알차서 추천한다. 

 

3. 새로운 툴 사용해서 문서작성해 보기

문서도구를 만드는 회사의 블로그에서 참고를 한 것이기 때문에 세 번째 항목의 제목은 자사에서 만드는 툴을 사용해 보라는 목표를 제시하고 있다. 이 항목에서는 새로운 툴을 사용해서 시도해 봐!라는 목적이지 않을까 해서 제목을 바꿔보았다. 나도 이제까지 워드만을 사용해서 매뉴얼을 작성해 왔기 때문에 새로운 툴을 사용해 보자 라는 목표가 생겼다. 어떤 유형의 문서를 쓰느냐에 따라 다르겠지만 웹페이지에서 보여주려면 html, 마크다운 형식의 문서를 작성해 보는 것도 좋을 것 같다.

개인적으로 올해의 목표는 markdown이나 html로 문서화하는 것에 대해 공부를 하고 GitHub, Gitbook등으로 문서를 제작하거나 커뮤니케이션 도구를 사용해보려고 한다. 

 

4. 다양한 문서 읽어보기

스티븐 킹은 “If you don’t have time to read, you don’t have the time to write.”고 말했다고 한다. 읽을 시간이 없다면 글을 쓸 시간도 없다는 뜻인데 이 원칙은 테크니컬 라이팅에도 적용되기 때문에 가능한 많이 읽는 것이 중요하다고 말한다. 당연하게도 기술문서를 잘 작성하려면 좋은 사용 설명서의 예시나 다양한 기술문서의 예시를 공부하고 벤치마킹하면 복잡한 내용을 더 쉽고 간결하고 가독성이 좋게 작성할 수 있을 것이다. 

 

5. 테크니컬 에디터 되기

테크니컬 에디터는 전문 용어, 수식이나 공식의 정확성 등을 확인하기 위해 테크니컬 라이터와 함께 콘텐츠를 만들어나가는 역할을 수행한다. 아마 여기에서 말하고자 하는 건 테크니컬 라이팅뿐만 아니라 자료와 편집 내용 검토와 같은 테크니컬 에디터의 업무를 시도해 보는 것을 권장하는 것 같다. 하지만 회사나 부서에 테크니컬라이터가 혼자라면 테크니컬 라이터가 결국 테크니컬 에디터 업무를 수행하게 되지 않을까🙄(= 내 얘기, 직무의 범위를 넓혀 나간다고 생각하자)

 

6. 다른 테크니컬 라이터 만나기

다른 테크니컬 라이터를 만날 수 있는 그룹이나 컨퍼런스에 참석하고 동료들로부터 많은 정보를 얻을 수 있도록 목표를 세우라고 권장하고 있다. 예전에는 국내에서 다른 테크니컬 라이터가 어떻게 일하고 있는지 알기가 쉽지 않았지만 최근에 배달의민족/라인과 같은 곳에서 세미나를 종종 진행하고 있다. 나름 테크니컬 라이터 규모가 있는 곳에서는 어떻게 일하고 있는지 어떤 툴을 쓰고 있는지 무엇을 중점적으로 공부해야 하는지를 알 수 있다. 

국내 커뮤니티로는 TCN이라는 카페를 추천한다. 구인 구직글도 자주 올라오고 커리어 관련 고민글을 올리면 비슷한 일을 하고 있는 사람들의 의견도 들을 수 있다. 특히 오는 2월 15일에는 TCN meetup을 진행한다고 하니 꼭 참여해보려고 한다. 다른 사람들은 어떻게 일하고 있는지 어떤 고충이 있는지 알고 싶었는데 이런 좋은 밋업 이라니 다음에는 나도 발표자로 참여해보고 싶기도 하다. 

 

7. 디자인 배우기

테크니컬 라이팅은 단순히 글쓰기 그 이상이며 독자가 시각적인 것을 중요시하기 때문에 문서를 디자인하고 일러스트레이션이나 스크린 샷을 어떻게 보여줘야 할지 고민해야 한다. 또한 많은 기업에서 온라인 문서를 작성하므로 문서의 UX는 명확해야 한다고 설명한다. 예를 들어 Android 개발자 가이드를 봐도 글쓰기 그 이상의 것들이 녹아있는 것을 알 수 있다. 동영상을 첨부하거나 사용자가 원하는 내용을 어떻게 쉽게 찾을 수 있을지를 생각하고 온라인 환경에서 문서를 보여주고 있다. 

효과적인 문서 디자인은 사용자와 플랫폼을 이어주는 다리역할을 하기 때문에 테크니컬 라이터지만 문서의 UX 그리고 문서를 어떻게 디자인해야 할지도 생각해야 한다. 나조차도 지금도 온라인에서 문서를 어떻게 보여줘야 할지 많은 고민을 하고 있다. 만약 직접 디자인은 하지 않더라도 디자이너들과 의사소통을 하기 위해서는 기본적인 UI/UX요소들은 알아두는 편도 좋을 것 같다. 

---

결론

7가지 목표를 올해 완벽하게 달성하겠어!라는 마음가짐도 좋지만 하나의 목표라도 제대로 달성해 보자!라는 마음가짐을 가지고 공부해보려고 한다. 특히 다양한 글들이나 레퍼런스도 많이 찾아보고 디자인과 새로운 툴 사용해 보는 것도 중요하지만 결국 근본적으로는 '글쓰기'를 잘해야 되지 않을까🧐! 2023년에도 다양한 강의를 찾아 듣고 열심히 공부해야지...