글로벌 시장에 출시되는 제품의 매뉴얼은 본문 작성에 앞서 핵심 용어를 먼저 선정하고 표준화할 필요가 있습니다. 특히 산업기계, 건설장비, 중장비, 의료기기처럼 사용자의 정확한 이해와 안전이 중요한 제품일수록 용어는 매뉴얼 품질의 출발점이 됩니다.
제품 매뉴얼을 새로 만들 때 가장 먼저 무엇을 해야 할까요?
목차를 설계하고 본문을 작성하는 일이 먼저라고 생각하기 쉽습니다. 그러나 여러 기능과 장치, 부품을 설명해야 하는 제품이라면 그보다 앞서 해야 할 일이 있습니다. 매뉴얼에서 반복적으로 사용할 핵심 용어를 정하는 것입니다.
매뉴얼은 사용자가 특정한 목적을 달성하기 위해 제품의 기능을 어떻게 사용해야 하는지를 설명하는 문서입니다. 사용 방법을 이해하려면 먼저 각 문장이 무엇을 가리키는지 정확히 알아야 합니다. 제품명, 부품명, 기능명, UI 명칭과 같은 핵심 용어는 사용자가 조작하거나 확인해야 할 대상을 식별하게 하며, 같은 대상은 문서 전체에서 같은 명칭으로 인식될 수 있어야 합니다.
따라서 매뉴얼 제작에서는 본문을 작성하기 전에 반복적으로 사용될 핵심 개념과 명칭을 먼저 선별하고 표준화하는 것이 중요합니다.
글로벌 전개를 전제로 하는 제품이라면 이 작업의 중요성은 더욱 커집니다. 최초 매뉴얼에서 정한 용어가 이후 파생 모델의 매뉴얼과 다국어 번역에도 계속 이어지기 때문입니다. 이러한 원칙은 매뉴얼 제작뿐 아니라 기술 문서 제작과 사용설명서 개발 전반에 동일하게 적용됩니다.
같은 기능은 같은 이름으로 되어 있어야 합니다
용어 표준화가 필요한 가장 직접적인 이유는 한 매뉴얼 안에서 사용자가 혼란 없이 제품을 이해하도록 하기 위해서입니다.
앞부분에서 학습한 기능이나 장치가 뒤쪽 절차에서는 다른 이름으로 등장한다면 사용자는 그것이 같은 대상을 말하는 것인지, 별도의 기능을 의미하는지 다시 판단해야 합니다.
같은 장치가 한 절에서는 정식 명칭으로 표시되고 다른 절에서는 약칭이나 현장 표현으로 바뀌어 사용된다면 작성자는 의미를 알고 있어도 처음 제품을 접하는 사용자는 그렇지 않을 수 있습니다.
산업기계나 의료기기처럼 사용 절차와 안전 정보가 중요한 제품에서는 이러한 차이를 단순한 문체상의 문제로 볼 수 없습니다. 사용자가 동일한 기능, 부품, 장치와 동작을 문서 전체에서 동일한 개념으로 인식할 수 있도록 하는 것이 매뉴얼 작성의 기본 조건입니다.
처음의 작은 차이는 문서가 늘어날수록 커집니다
한 문서 안에서 발생한 용어 불일치는 그 문서에서 끝나지 않습니다.
제품에는 후속 모델과 파생 모델이 추가되고 기존 매뉴얼을 기반으로 새로운 문서가 만들어집니다. 글로벌 출시 제품이라면 여기에 여러 언어의 번역본까지 만들어집니다.
소스 매뉴얼에서 하나의 기능을 두세 가지 표현으로 사용하고 있다면 번역가는 각각을 다른 개념으로 판단할 수도 있습니다. 언어별로 다시 여러 표현이 생기기 시작하면 이후 어느 것이 기준 용어인지 확인하는 작업도 어려워집니다.
결국 한 문서의 용어 불일치 → 파생 문서의 불일치 → 다국어 번역의 불일치로 문제가 확대됩니다.
따라서 파생 모델과 다국어 문서가 많아질수록 나중에 용어를 정리하는 것보다 최초 매뉴얼을 작성할 때부터 기준을 만드는 편이 훨씬 효율적입니다.
그래서 본문 작성 전에 용어집부터 만듭니다
매뉴얼 제작 실무자, 테크니컬 라이터가 먼저 해야 할 일은 문서에서 반복적으로 사용할 핵심 용어를 추려 표준용어를 정하고 용어집을 만드는 것입니다.
모든 단어를 관리할 필요는 없습니다. 우선적으로 살펴볼 대상은 다음과 같습니다.
기능명과 장치명, 주요 부품명, 조작 및 동작 용어, UI 메뉴와 버튼명, 상태 및 오류 관련 용어, 안전 관련 용어, 규격이나 법규에서 정의한 용어처럼 다른 표현이 사용될 경우 사용자 이해나 문서 일관성에 영향을 줄 수 있는 용어가 주요 대상입니다.
특히 동일한 대상을 이미 서로 다른 표현으로 사용하고 있다면 우선적으로 표준화할 필요가 있습니다. 한샘글로벌의 「표준용어 선정과 관리 실무 가이드」에서도 문서 내 또는 문서 간에 서로 다르게 표현되는 불일치 용어를 우선적인 표준화 대상으로 제시하고 있습니다.
이렇게 정한 용어는 단순히 목록으로 보관하는 것이 아니라 이후 매뉴얼 작성과 검토, 파생 문서 제작, 번역 및 QA에서 공통 기준으로 사용해야 합니다.
용어집을 만들기 시작하면 다음 질문이 생깁니다
용어 표준화의 필요성은 쉽게 이해할 수 있습니다. 어려운 것은 실제 작업입니다. 막상 시작하면 다음과 같은 질문과 마주하게 됩니다.
- 어떤 용어까지 표준화해야 할까?
- 자주 등장하는 단어라면 모두 등록해야 할까? 기술 문서 특성을 고려할 때 얼마만큼 등장해야 자주 등장한다고 볼 수 있나?
- 같은 의미의 후보가 여러 개라면 무엇을 표준어로 선택해야 할까?
- 사양서, UI, 장비 라벨과 현장에서 사용하는 표현이 다르면 어느 것을 따라야 할까?
- 사용하지 않아야 할 표현도 관리해야 할까?
- 새 기능이나 부품이 추가될 때 용어집은 누가 업데이트해야 할까?
- 글로벌 전개를 위해 다국어 용어집은 언제 만들어야 할까?
이때부터는 단순히 용어를 모으는 것이 아니라 선정하고, 판단하고, 등록하고, 사용하는 방법이 필요해집니다.
매뉴얼 용어 표준화는 이렇게 시작할 수 있습니다
전체 과정을 복잡하게 생각할 필요는 없습니다. 처음에는 다음 순서로 시작할 수 있습니다.
1. 표준화할 용어를 찾습니다.
반복 사용되는 핵심 용어, 이미 서로 다르게 사용되고 있는 용어, 안전 및 규격 관련 용어 등을 먼저 추립니다.
2. 어떤 표현을 표준어로 사용할지 결정합니다.
자료 상에 있는 명칭만 보는 것이 아니라 사용자 이해도, 실제 장비와 UI의 표기, 관련 규격, 업계에서 정착된 표현 등을 함께 검토합니다.
3. 용어집에 등록합니다.
표준어뿐 아니라 정의, 사용하지 않을 표현, 출처 등을 함께 기록하면 작성자와 리뷰어가 동일한 기준으로 판단할 수 있습니다. 초기에는 엑셀과 같은 간단한 형식으로 시작해도 충분합니다.
4. 실제 제작 과정에 적용합니다.
작성과 검토 과정에서 용어집을 기준으로 사용하고, 다국어 전개 시에는 언어별 용어를 먼저 확정해 CAT Tool의 Termbase와 연동할 수 있습니다.
5. 계속 관리합니다.
제품과 기능은 바뀝니다. 따라서 신규 용어의 등록뿐 아니라 기존 용어의 변경과 폐기 기준, 그리고 이를 결정할 담당 주체도 정해 두어야 합니다.
용어집보다 중요한 것은 판단 기준입니다
용어 표준화의 목적은 많은 단어를 용어집에 넣는 것이 아닙니다. 오히려 관리 대상이 지나치게 많아지면 작성자와 리뷰어가 용어집을 제대로 활용하기 어려워집니다. 실제로 중요한 것은 어떤 용어를 관리해야 하고, 어떤 용어는 제외해도 되는지를 판단하는 기준을 만드는 것입니다.
또한 여러 후보 표현이 있을 때 무엇을 우선할 것인지도 정해야 합니다. 법규나 규격에서 요구하는 표현, 실제 장비와 UI의 표기, 사내 표준어와 업계 관행이 서로 충돌할 수 있기 때문입니다.
결국 매뉴얼 용어 관리는 용어집 파일 하나를 만드는 작업이 아닙니다.
사용자가 제품을 이해하기 위해 반복해서 접하게 될 핵심 개념과 대상을 일관된 용어로 표현하고, 그 기준이 후속 문서와 다국어 매뉴얼에서도 유지되도록 관리하는 과정입니다.
매뉴얼 작성을 시작하기 전에 이 기준부터 만들어 두어야 하는 이유도 여기에 있습니다.
표준화할 용어를 어떻게 선정해야 하는지, 어떤 표현을 표준어로 결정해야 하는지, 충돌하는 용어에는 어떤 우선순위를 적용해야 하는지 등 구체적인 실무 방법은 한샘글로벌의 「기술 문서·매뉴얼 용어 관리 실무 가이드」에서 자세히 확인할 수 있습니다. 이 가이드는 표준화 대상 선정 기준부터 제외 기준, 표준어 결정 원칙, 등록 방법과 다국어 용어집 확정 절차까지 실제 문서 제작에 적용할 수 있는 판단 기준을 정리하고 있습니다.
매뉴얼 제작 전 용어 체계를 수립하거나 기존 기술 문서의 용어를 표준화해야 한다면 한샘글로벌에 문의해 주세요.