10월 26일 저녁 8시부터 진행된 행사입니다. 저녁 8시라는 시간이 좀 애매한데... 요즘 온라인 밋업이나 콘퍼런스는 7시, 8시 이 정도 시간에 진행을 하더라고요. 하여간 이번에도 라이브는 시청하지 못하고 거의 한 달이 지나 이제야 정리해 봅니다.
참고로 아래 정리한 내용은 발표한 내용을 그대로 옮긴 건 아니고 중간중간 잡다한 개인적인 의견이 포함되어 있습니다.
지난 2월 밋업과 마찬가지로 3개의 세션으로 구성되어 있습니다.
(1) 한 셋트의 매뉴얼이 만들어지기까지 - 김세혁
김세혁 님은 네이버 TCN 카페를 만들고 운영하고 있는 분입니다.
닉네임은 unartist이고 현재 한화정밀기계에서 테크니컬 라이터로 근무하고 있다고 합니다.
발표를 시작하기 전에 제품 소개 영상을 살짝 보여주었는데요. HM520W라는 모델이고 칩마운터라고 하네요. 칩마운터는 인쇄회로기판(PCB) 위에 부품을 자동 장착하는 장비라고 합니다(20분 발표에 영상이 3분 30 초라니요 ㅠㅠ 물론 이후 제품과 함께 제공되는 매뉴얼에 대해 설명하기 위해 미리 보여준 것입니다).
해당 장비에는 5가지 매뉴얼이 인쇄되어 제공됩니다.
- 관리자 안내서, 문제 해결 안내서, 기술정보 지침서, 작업자 핸드북, 유지보수 핸드북
관리자 안내서를 만들기 위해서는 개발 부서에서 작성한 여러 형태의 규격서가 필요합니다.
대략 A4 기준 300~500페이지 분량입니다. 시뮬레이션할 수 있는 소프트웨어를 기반으로 작업을 진행하고 필요한 경우 일러스트도 추가합니다.
문제 해결 안내서는 일반적인 트러블슈팅의 영역이고요.
기술정보 지침서는 좀 독특한데, 이런 장비 제품에 같이 제공되는 부품 도면입니다. 약 2만 개 정도의 부품이 들어가는데 부품을 어떻게 구분하고 분류하는지에 따라 서비스 제공이 달라진다고 합니다. 독특한 것은 각 부품의 서비스 단위(?)를 같은 팀에서 설정한다고 하네요(테크니컬 라이터는 아닌 것 같고 소속팀 내에 함께 그런 작업을 하는 분이 있는 것 같습니다).
작업자 핸드북은 말 그대로 현장에서 작업자들이 기계를 다룰 때 따라 할 수 있는 형식으로 구성합니다. 때문에 시각적인 자료에 많은 비중을 두고 있습니다.
매뉴얼 작업은 신제품 기준으로 2-3개월 정도 필요합니다. 1500~2000페이지 정도 분량이라고 하네요.
콘텐츠 작업은 FrameMaker, Indesign을 사용합니다. 기본적으로 인쇄된 매뉴얼의 형태를 제공하고 있으니깐요.
문서의 형태에 따라 FrameMaker, Indesign을 구분해서 사용하고 있습니다.
관리자 안내서, 문제 해결 안내서, 기술정보 지침서는 FrameMaker를 사용합니다. 문서의 형식이 정해져 있고 싱글 소싱을 위한 Structure 기반의 문서 작업을 진행한다고 합니다.
작업자 핸드북, 유지보수 핸드북은 시각적인 요소가 중요하고 자유로운 형태로 사용자 중심 문서가 제공되어야 하기 때문에 Indesign으로 작업합니다.
그 외에 디자인 작업은 어도비 제품을 사용하고 있으며 3D 모델링은 creo라는 소프트웨어를 사용합니다. 웹매뉴얼은 InstallShield로 빌드해서 배포한다고 합니다(아마 웹매뉴얼이 아니라 전자 매뉴얼을 의미하는 것이 아닌가 싶습니다). 리소스는 SVN을 내부에서 사용한다고 하네요.
https://youtu.be/To37ZEaXfrc?si=KB0p0LB8zAreaW0S
(2) 업무적 글쓰기가 고민인 당신을 위하여 - 남정현
남정현 님은 2월 밋업에 이어 10월에도 발표를 진행했습니다. 2월에는 조직 내에서 사용한 문서화 엔지니어링이라는 좀 디테일한 내용을 다루었는데 10월에는 그보다는 가벼운 내용으로 준비했습니다(가벼운 내용이라 생각했는데 설명은 쉽게 하고 있지만 실제 이걸 적용해보려 한다면 쉽지 않을 겁니다 ^^).
문서화 부채에 대한 내용으로 시작하는데 외부에 공개되는 문서보다는 개발 조직 내부에서 필요한 문서에 대한 이야기가 아닐까 싶습니다. 문서화에 부채가 쌓이면 가장 어려움을 겪는 것이 온보딩 단계라고 합니다. 새로운 동료가 합류했는데 어떻게 시작해야 하는지 정리된 내용이 전혀 없다면 무척이나 당황스럽겠죠. 이런 과정이 계속되면 이탈하는 동료도 생길 수 있고요.
3가지 단계로 업무적 글쓰기를 쓰는 방법을 설명합니다.
첫 번째는 독자가 누구인지 알아야 한다.
문서의 성격이 명확하면 독자를 지정해서 만들 수 있습니다. 예를 들면 관리자 가이드, 사용자 가이드 이런 식으로 구분하는 것이 깔끔하고 그 안에서도 기본적인 내용과 고급 설정 등의 내용을 분리해서 사용자의 수준에 따라 내용을 선택할 수 있게 하는 방법을 주로 사용합니다.
두 번째는 독자가 해야 할 과업을 정리한다.
이건 제품의 영향을 어느 정도 받습니다. 제품의 기능이 명확한 경우에는 시나리오를 만들기가 어렵지 않습니다. 하지만 제품의 기능이 뭔가 두리뭉실한 경우에는 시나리오 자체를 만드는 것이 쉽지 않습니다.
세 번째는 독자가 경험할 수 있는 어려움을 정리한다.
예전에는 트러블슈팅 문서를 제공하는 것이 당연한 것이었는데 요즘에는 트러블이 생기지 않도록 제품을 설계하는 쪽에 더 많은 관심을 가지고 있습니다.
https://youtu.be/n3asekge_D0?si=NVL15iNguUf1TTSE
(3) 정말 잘 알고 있을까? Technical Writing 기본과 원칙 - 서병만
서병만 님은 엔씨소프트 테크니컬 라이터로 일하고 있고 현재 19년 차라고 합니다. 문서 기획 전문 업체에서 시작해서 보안업체를 거쳐 엔씨소프트에서 일을 하고 있습니다.
초급 테크니컬 라이터를 위한 내용이며 실무에 적용하고 업무 능력을 향상하는 것이 이번 세션의 목적이라고 합니다.
가장 중요한 것은 독자(사용 대상)에 대한 분석과 이해입니다.
테크니컬 라이팅의 가장 큰 특징은 독자를 명확하게 지정하는 것이라고 정의하고 있습니다. 독자에 따라 용어, 내용, 어조, 형식 등이 달라져야 하기 때문입니다.
문서의 구성 또한 사용자에 따라 달라집니다. 초보자인 경우에는 단계별 목차로 구성하고 좀 더 경험 있는 독자의 경우에는 주제별로 구성해서 사용자가 원하는 콘텐츠를 빠르게 찾을 수 있게 하는 것이 중요합니다.
명확성(Clarity)에 대한 정의: 한 문장을 한 번 읽어서 이해되도록 작성하는 것. 두 번 읽지 않도록 작성하는 것.
IBM에서 출판된 Developing Quality Technical Information에 나오는 "Clear information is information that users can understand the first time."이라는 문장을 발표자가 이해하고 정의한 것이라고 합니다. 테크니컬 라이터는 적어도 "명확성"에 대해 스스로 이해할 수 있도록 "명확"하게 내리고 있어야 한다고 이야기합니다.
실무에 적용하기 위해서는 개념을 잘 이해하고 적용 기준, 체크리스트를 만들어 잘 활용하는 것이 중요하다고 합니다.
구글 테크니컬 라이팅 과정(번역기로 번역하면 아주 잘 번역해 줍니다).
다만 몇 가지 국문에 맞게 적용하는 것이 필요합니다.
https://youtu.be/_nObyY6IZGw?si=IZ_OdU_vOFhe8llD
