사용설명서/매뉴얼 제작의 핵심 요소

국내외 시장에 판매할 상품이나 서비스가 있다면 반드시 사용자를 위한 매뉴얼, 사용설명서가 제작되어 소비자에게 함께 제공되어야 합니다. 사용설명서를 조직 내부에서 자체적으로 제작하려면 매뉴얼을 제작할 수 있는 인프라가 갖춰져야 합니다. 매뉴얼 제작을 위한 인프라, 제대로 갖춰야 할 핵심 요소에 대해서 소개하려고 합니다. 특히 해외 시장을 겨냥한 상품이나 서비스가 있다는 가정하에 필요한 핵심 요소에 집중해서 설명하겠습니다.

1. 인적 자원

매뉴얼 제작을 위해서는 다양한 직군의 사람들이 필요합니다. 가장 핵심적인 기술, 필수 인력을 살펴 볼까요.

테크니컬 라이터
매뉴얼 콘텐츠를 구성하고 작성하는 핵심 인재입니다. 대상 사용자층이 특정되면, 사용자 요구 사항을 파악하면서, 사용 정보를 수집하고, 목적하는 종류의 사용자 문서를 작성합니다. 사용자 문서에는 설치설명서, 수리설명서, 사용설명서, 퀵가이드, 온라인 핼프, Q&A 시트, 라벨, 다양한 종류가 포함됩니다. 목적하는 문서의 특징에 맞추어 사용 정보를 수집하고 복잡한 기술적 개념을 대상 사용자층이 쉽게 이해할 수 있는 사용자 언어로 설명하는 기술을 가지고 있습니다.

우수한 테크니컬 라이터의 육성과 유지는, 기업이 사용자를 위한 적절한 매뉴얼을 만들어낼 수 있는지 없는지가 좌우될 만큼 중요하고, 대체하기가 결코 쉽지 않은 인적 자원입니다.

DTP 전문가
매뉴얼은 결국, 인쇄된 문서이든 디지털 문서이든, 문서 형태로 소비자에게 전달됩니다. 사용자들이 쉽게 정보를 구분하고 검색하고 사용할 수 있도록 하려면 문서의 레이아웃과 색상 설계, 타이포그래피, 이미지와 텍스트가 사용자의 가독성, 정보의 시인성을 높여주는 형식으로 구성되어야 있어야 합니다. 문서 편집 디자인 도구인 Adobe Indesign, FrameMaker, Illustrator, Photoshop 등 다양한 DTP 소프트웨어를 사용하는 기술도 필요합니다. 출판 및 인쇄에 대한 지식도 보유하고 있습니다.

디자이너
기술적인 개념이나 복잡한 사용법을 사용자에게 쉽게 전달하는 방법 중에 시각적 도구의 활용은 중요합니다. 이런 기술을 제공할 수 있는 대표적인 인적 자원이 테크니컬 일러스트레이터, 그래픽 디자이너, UX 디자이너입니다. 이들은 기술적 컨셉을 명확하고 이해하기 쉬운 이미지로 만들 수 있고 웹 매뉴얼로도 제작하는 경우 화면의 유저 인터페이스를 사용자가 정보를 쉽게 열람할 수 있는 형식으로 디자인할 수 있는 사람입니다. 디자이너들은 홍보 마케팅 조직이나 디자인 전문 회사에서도 많이 볼 수 있지만 매뉴얼에 필요한 그래픽에 특화된 사람들은 많지 않습니다.

번역 관리자
매뉴얼이 여러 국가 언어로 번역되어야 하는 경우, 번역 회사를 이용할 수 있지만 그와 별도로 회사 내부에 번역 관리자가 있는 것이 문서의 일관성과 품질 유지, 빠른 변경과 제작 시간에 대응할 수 있는 생산성 관리에 차별화를 가져올 수 있습니다. 매뉴얼은 개발되는 과정의 특성 상, 여러 언어 버전으로 번역된 뒤에도 지속되는 변경이 많기 때문에 적절하게 대응하면서 현지화된 언어 버전에 변경 내용을 적용되도록 관리해야 하기 때문입니다. 또한 지속적으로 유사 제품이 출시되는 경우 이전에 출시된 제품과 콘텐츠의 상당수가 유사한 번역물이 많기 때문에 수정이 필요한 부분만 핀셋 적용해서 비용과 시간을 줄이려면 번역 관리자의 역할이 더욱 중요해집니다.

현지화 관리자
번역 관리자가 언어 번역 관리에 집중한다면 현지화 관리자는 각 국가 언어 버전 별로 납품될 수 있도록 총괄 관리해야 하는 사람입니다. 이들은 언어 번역이 끝나서 번역된 매뉴얼 텍스트가 입수된 뒤 각 언어별로 편집하고, 동시에 각 언어별로 적용되어야 하는 국가별 규제사항이 제대로 적용되어 있도록 관리합니다. 각 언어 버전에 맞추어 현지화된 UI 용어가 제대로 적용되어 있는지 확인해야 하고 언어별로 히스토리를 기록 관리해서 다음 버전에 대비할 수 있도록 합니다.

2. 제작 가이드

판매할 상품과 서비스를 가진 다수의 기업이 매뉴얼 제작 지침을 제대로 확립하지 않고 있는 사례가 많습니다. 매뉴얼 제작 지침은 매뉴얼 개발을 위한 인적 자원의 확보 못지 않게 중요합니다.

매뉴얼 제작 가이드는 목적에 따라 다양한 종류가 있는데 이 모든 가이드의 목적은 문서의 일관성, 품질, 효율성을 보장하는 데 중요한 역할을 합니다. 매뉴얼 제작 가이드 중에서 대표적으로 중요한 몇가지를 사례로 들자면 다음과 같습니다:

스타일 가이드: 사용하는 용어, 문체, 문법 및 표기법 등을 규정하여 일관된 언어 사용을 보장합니다.

콘텐츠 가이드: 매뉴얼의 주요 섹션과 하위 섹션의 구조와 각 섹션에 배치될 내용의 원칙을 규정해 둬야 합니다. 즉 목차 구성의 원칙을 기술하는 것이지요. 콘텐츠 가이드는 스타일 가이드에 포함시킬 수도 있습니다.

그래픽 가이드: 이미지, 다이어그램, 아이콘의 사용 방법과 스타일을 정의하고 해상도, 크기, 색상 사용 등 이미지 품질 기준을 규정해 둡니다.

템플릿 가이드:  매뉴얼 작성시 사용할 표준 템플릿을 제작해 둡니다. 페이지 레이아웃, 머리글 및 바닥글, 페이지 번호 등 문서 포맷을 규정해 둬야 합니다. 여러 언어로 현지화되는 경우 언어별로 템플릿 가이드를 제작해 두면 빠른 제작이 가능합니다.

품질 관리 가이드: 문서 작성 후 검토 절차, 승인 절차를 규정해 둡니다. 무엇을 오류로 잡을 것인지 정의하고 식별하고 수정하는 방법을 정립합니다. 문서가 충족해야 할 품질 목표를 설정해 두어야 지속적으로 이를 충족하고 개선해 갈 수 있는 방법을 검토할 수 있게 됩니다.

번역 및 현지화 가이드: 여러 언어로 현지화되는 경우 번역 지침이 수립되어야 하고 일관된 번역을 위한 표준 용어집과 번역 메모리 사용 지침을 만들어서 번역 회사에 제공해야 합니다.

그밖에도, 기업의 목표와 원칙에 따라 장애인을 위한 접근성 가이드, 다양성, 형평성, 포용성의 국제 기준을 충족시키는 DEI (Diversity, Equity, and Inclusion) 가이드를 병행해서 운영하기도 합니다.

3. 표준화된 절차

매뉴얼 제작 절차를 표준화시키면 생산성 향상과 품질 관리, 효율성 증대에 큰 영향을 끼칩니다. 각 단계별로 할 일이 규정되고 각 단계별로 책임을 명확히 하여 작업의 투명성을 높이고 문제 발생시 신속하게 대응할 수 있게 됩니다.

표준화된 절차서에는 제작 단계별로 해야 할 일의 범위를 정해 두어야 하고, 목적과 방법론이 구체적으로 명시되어야 합니다. 각 단계별로 담당해야 할 역할과 책임이 정의되고 매뉴얼 제작 전체 프로세스가 단계별로 상세히 설명되어야 합니다.

표준 절차를 잘 수립하게 되면 개개인의 역량에 따라 작업 생산성이나 품질이 차이가 난다던지, 또는 선임 작업자가 이동하거나 퇴사한 뒤 작업에 혼선이 생기거나 변화가 생기는 일을 방지할 수 있게 됩니다. 더불어, 품질 관리 국제 표준인 ISO 9001인증을 취득하려면 이 같은 표준화된 절차서와 개선을 위한 기록 관리가 제출되어야 합니다.

4. 기술 및 도구

매뉴얼 제작을 위해서는 각 공정마다 다양한 기술과 툴이 필요합니다. 문서 작성을 위한 편집 소프트웨어, 일러스트와 그래픽을 위한 디자인 툴 외에도 콘텐츠 재활용, 번역 재활용, 협업 및 버전 관리를 위한 다양한 관리 툴이 필요합니다. 인쇄물과 웹매뉴얼을 동시 퍼블리싱할 수 있는 솔루션과 그밖에 제작 과정에서 일어나는 다양한 에러를 검색할 수 있는 툴도 필요합니다.

시판되고 있는 상용툴도 많고 직접 개발해서 사용하는 것도 가능합니다. 제작 과정에서 발생하는 오류를 잡기 위한 툴은 직접 개발하는 것이 낫고, 편집 소프트웨어, 그래픽 도구들, 번역 및 콘텐츠 재활용 툴은 상용툴 안에서 선택하는 것이 낫습니다.

5. 준비 자료

인적 자원이 갖춰지고, 인프라가 갖춰지고, 표준화된 제작 절차가 수립되어 있다면 기본적인 인프라는 갖춰진 것입니다. 매뉴얼 제작을 시작할 수 있는 모든 준비가 완료되었습니다. 이제 매 회차, 매뉴얼이 제작되어야 할 때 마다 매뉴얼을 제작할 수 있는 준비 자료를 갖춰서 인적 자원팀에 넘겨 주면 됩니다.

매뉴얼 제작을 위한 준비 자료는 대상 사용자에게 전달해야 할 정보가 포함된 다양한 종류의 개발 관련 문서나 기기입니다. 무엇보다 실 제품이 준비되면 더욱 좋습니다. 실 제품이 완료되기 전이라면 유사하게 조작해 볼 수 있는 데모 제품이나 사진, 영상도 매뉴얼 개발자들에게 큰 도움이 됩니다.

제품 사양서, 개발 문서, 기술 도면, 마케팅 자료, 표준 및 규격 문서, 설치 지침, 트레이닝 자료, 경쟁 제품 분석 보고서, 고객 지원팀이 사용하는 FAQ 문제 해결 가이드, 사용자 인터뷰 등 다양한 자료들은 매뉴얼 제작자가 제품을 정확하게 이해하고 사용자에게 명확하고 유용한 정보를 제공하는데 큰 도움이 됩니다. 이 같은 자료가 준비되어야 비로소 매뉴얼 개발자들은 작업을 시작할 수 있습니다.

끝내면서

기업 안에 이 모든 인프라가 갖춰지지 않은 경우 외부 전문 서비스를 이용하는 방법도 있습니다. 한샘글로벌은 글로벌 제조사의 매뉴얼 개발 및 현지화 파트너로 34년의 경험과 지식을 갖추고 있습니다. 소비자 제품군, 기업 솔루션, 자동차, 첨단 반도체 장비 매뉴얼까지 다양한 상품군을 제작할 수 있으며 인쇄매뉴얼, 웹매뉴얼, 기기 내장형 매뉴얼 등 다양한 매체에서 구현할 수 있습니다. 한샘글로벌 매뉴얼 쇼릴 보기.