사용 정보의 수집, 분류, 배치는 매뉴얼 제작에서 테크니컬 라이터의 핵심 기량 중 하나입니다. 이러한 과정이 제대로 이루어진 매뉴얼은 정보의 완전성은 물론, 검색 편의성에도 큰 영향을 미칩니다.
정보 유형
사용 정보는 다음과 같은 미리 정의된 정보 유형에 따라 나눈 기능적 구조로 작성하도록 한다.
a) 개념 정보. 이 정보 유형에는 다음이 포함된다.
- 사용 정보 자체에 대한 정보
- 제품과 부품의 설명과 식별
- 조작부와 디스플레이에 대한 설명
- 공정 설명(사용 사례 또는 작동 개념)
- 안전 주의 문구
b) 설명 정보. 이 정보 유형에는 다음이 포함된다.
- 단계별 절차(예: 조립, 설치, 유지보수 작업 절차)
- 경고 메시지(절차의 일부로서)
c) 참고 정보. 이 정보 유형에는 다음이 포함된다.
- 제목 페이지 정보
- 법적으로 요구되는 정보
- 문제 해결
- 유지보수 일정
- 목차
- 용어집
- 색인
사용 정보의 정의
ㆍ제품을 사용하는 데 필요한 모든 정보
ㆍ대상 독자층을 먼저 식별
사용 정보란 IEC82079-1에서는 Information for Use (IFU)로 표시되어 있는데, 이는 제품을 사용하는 데 필요한 모든 정보를 의미합니다. IEC82079-1은 사용설명서 작성에 있어 중요한 가이드라인을 제공하는 국제 표준으로, 이를 따를 경우 제품을 올바르고 안전하게 사용할 수 있도록 도와주는 설명서를 만들 수 있습니다.
사용 정보는 제품의 기본적인 사용 방법, 기능 설명, 주의 사항, 문제 해결 및 안전 관련 정보를 포함합니다. ‘사용설명서 제작 기술 1: 구성하기‘를 참고하세요.
사용 정보는 제품의 유형과 대상 독자층에 따라 제공되는 정보의 양과 깊이가 달라질 수 있습니다. 따라서 사용 정보를 수집하고 분류하려면 반드시 대상 독자층을 먼저 식별해야 합니다. 대상 사용자 그룹에 기대되는 지식 및 경험, 사용 환경, 사용 목적에 따라서 제공해야 할 사용 정보의 양과 깊이, 적용해야 할 언어가 달라지기 때문입니다.
사용 정보의 범위
ㆍ의도된 모든 기능
ㆍ언팩부터 폐기까지
ㆍ안전 정보 필수
사용설명서에 수록되어야 하는 사용 정보의 범위에 대해서 IEC82079-1은 제품이 의도한 모든 기능이라고 명시하고 있습니다.
현실적으로, 제품이 가진 전체 기능을 모두 사용하는 사람은 드물고 대부분의 사람들이 주로 많이 사용하는 기능이 있습니다. 잘 팔리는 기능, 많이 사용되는 기능, 신제품에 탑재한 신기능 등을 효과적으로 전달하고자 다수의 제조사는 활용가이드의 형식으로 추가로 제공하기도 합니다.
그러나 정식 사용설명서는 사용자를 대상으로 의도되어 있는 모든 기능을 포함해야 하며 제품의 언팩, 설치, 그리고 수명이 다하는 순간까지 필요한 모든 기능, 더불어 사용자 안전에 관한 모든 정보가 수록되어야 합니다.
*intended use: exhaustive range of functions or foreseen applications defined and designed by the supplier of the product. Functions or applications not listed by the supplier are excluded from the intended use of the product. (IEC 82079-1, 조항3.21)
그래서 사용설명서에 수록될 정보는 제품 식별 정보 (모델명 같은 것), 제품 소개, 구성품, 의도된 모든 기능의 사용법, 폐기 방법까지 모두 범위에 해당됩니다. 즉 제품의 안전한 사용을 보장하는 데 필요한 모든 정보와 위험 요소를 줄일 수 있는 안전 정보, 또한 제품의 예상 수명과 사용 환경, 예상되는 문제 해결 방법 등도 포함해야 합니다.
불충분한 사용 정보는 제품결함으로 간주되어 제품을 공급하는 제조사는 제조물 책임법에 의한 책임을 지게 됩니다. 제대로 만들어진 사용설명서는 사용자가 제품을 충분히 활용할 수 있도록 지원할 뿐만 아니라 사용자에게 제품에 대해 충분히 알렸다는 점을 입증해 제조사의 책임 위험을 줄이고 이는 제조사에 대한 신뢰로 이어질 수 있습니다.
사용 정보의 수집
ㆍ개발 자료, 마케팅 자료, 개발자 인터뷰
ㆍ대상 제품
ㆍ서비스 부서에서 입수한 사용자 피드백
사용 정보는 다양한 출처에서 수집됩니다. 제품 개발자, 엔지니어, 마케팅 팀 등의 전문가들이 제공하는 기술 정보 외에도, 고객 서비스 부서에서 수집한 사용자 문의 사항과 피드백 역시 중요한 정보 출처가 됩니다. 이 과정에서 정확하고 최신의 정보를 유지하는 것이 핵심이며, 사용자 관점에서 필요한 정보가 빠짐없이 포함되도록 주의해야 합니다.
이때 제공되는 정보는 제품의 모든 사용 시나리오를 포괄할 수 있도록 해야 합니다. 예를 들면 오사용시 일어날 수 있는 이상 현상과 대응 방법까지, 예견할 수 있는 모든 사용 시나리오를 포괄해야 합니다. 이전 제품 매뉴얼이나 경쟁사 유사 제품 매뉴얼도 참고 자료로 유용합니다
이렇게 수집된 정보는 사용설명서의 토픽이 됩니다. 토픽은 하나의 주제를 다루는 정보 단위로, 한 토픽이 사용설명서의 대, 중, 소제목이 될 수도 있고 대, 중, 소제목으로 구성된 섹션이나 서브섹션이 될 수도 있습니다. 이 글에서는 이어지는 섹션을 이해하기 쉽게 목차를 구성하는 각 제목을 토픽이라고 칭하겠습니다.
* topic: coherent part of an information product with a heading that deals with a single subject (IEC 82079-1, 조항3.43)
사용 정보의 분석
ㆍ사용 목적과 빈도에 따른 우선 순위 분석
수집된 정보는 사용자 관점에서 분석되어야 하며, 실제로 제품을 사용하는 사람이 무엇 때문에 (어떤 user task를 수행하기 위하여) 어떤 정보를 필요로 하는지 평가해야 합니다. 분석을 통해 실제 사용자에게 필요한 정보로 선별하고 사용 목적, 사용 빈도, 사용 상황 등을 고려하여 정보의 중요도와 우선 순위를 정합니다. 이 과정에서 한 토픽의 정보량이 너무 많거나 부족하지 않도록 균형을 맞추는 것이 중요합니다.
사용 정보의 분류
ㆍ기능별, 사용 목적별, 문제 해결 중심으로 그룹핑
사용 정보의 분류는 다음 단계인 사용 정보 배치를 위한 사전 작업입니다. 동일하거나 유사한 목적으로 사용하는 기능을 함께 묶고, 사용 순서에 따라 전후로 나뉘는 토픽을 분류하며, 예상되는 작업 시나리오를 시간 순으로 정리합니다.
예를 들어, 사용 전 단계에 이루어져야 하는 설치나 설정 관련 토픽을 함께 모으고, 유사한 목적의 사용 기능을 그룹화하며, 시간 순서 상 전후 관계가 있는 기능을 순서대로 배치합니다. 예를 들어, 사진 편집 기능은 사진 촬영 후에 수행되므로 이러한 시간적 흐름을 고려해 분류합니다.
또한, 사용자가 우선적으로 사용할 가능성이 높은 기능이나 자주 사용하는 기능을 분류하고, 무엇이 심화 기능으로 간주될지에 대해서도 고려합니다.
사용 정보 분류에서는 사용자의 심리와 행동 패턴을 이해하는 것이 중요합니다. 특히 소비자 매뉴얼 제작을 주도하는 테크니컬 라이터에게는 필수적인 기술입니다. 이를 습득하기 위해서는 관찰과 정보 수집, 학습이 필요합니다. 제품을 사용하는 사람들의 행동 패턴을 관찰하고, 소비자 커뮤니티에서의 문답이나 서비스센터에 접수되는 문의 정보를 수집하며, 더 나아가 소비자 행동에 관한 연구 자료를 참고하는 것이 도움이 됩니다.
사용 정보의 배치
ㆍ사용자의 작업 흐름에 따른 배치 (시간순)
ㆍ사용 빈도에 따른 배치 (사용빈도순)
ㆍ실행 난이도에 따른 배치 (난이도순. 쉬운 방법 먼저 배치)
사용 정보의 배치 결과는 목차가 됩니다. IEC 82079-1에 따르면, 정보의 배치는 사용자가 필요한 정보를 쉽게 찾고 이해할 수 있도록 논리적이고 직관적이어야 합니다. 배치 원칙으로는 사용자의 작업 흐름을 따르는 배치, 자주 사용하는 기능의 우선 배치, 동일한 기능을 여러 가지 방법으로 실행할 수 있다면 가장 간단하고 빠른 방법을 먼저 배치하는 것이 있습니다.
정보의 배치는 일관된 논리적 구조를 유지해야 하며, 이는 사용자 경험을 크게 향상시킬 수 있습니다. 처음 제품을 사용하는 사용자와 이미 익숙한 사용자의 요구를 모두 충족하기 위해, 정보의 우선 순위를 명확히 하고 중요한 정보는 눈에 잘 띄는 위치에 배치해야 합니다. 또한, 정보 간의 자연스러운 연결성을 고려하여 사용자가 다음 단계로 쉽게 넘어갈 수 있도록 설계해야 합니다.
잘 만들어진 매뉴얼의 첫 번째 평가 기준은 검색성입니다. 사용자가 원하는 정보를 얼마나 쉽게 찾을 수 있는지가 중요한 평가 요소입니다. 이를 위해서는 정보의 분류와 배치가 적절해야 하며, 사용자 작업(Task)에 맞는 제목, 구성의 논리적 전개, 일관성, 그리고 사용자가 예측할 수 있는 배치 구조로 이루어져야 합니다. 이 글에서 다룬 사용 정보의 수집, 분석, 분류, 배치를 참고하여 검색성이 뛰어난 사용설명서를 제작하십시오.
한샘글로벌의 경쟁력
한샘글로벌의 매뉴얼 제작 서비스는 사용자 맞춤형 정보, 모바일에서 열람이 가능한 사용자 친화적인 웹매뉴얼 제작, 50개 이상의 언어로 현지화, AI친화적인 테크니컬 라이팅 기술로 사용설명서의 미래를 개척합니다. 구성과 기획, 라이팅, 디자인과 편집을 거쳐, 다국어 번역 및 퍼블리싱까지 모두 한곳에서 이루어지는 원스톱 개발 프로세스를 갖추어서 혁신적인 제작 기간, 전 세계 동시 출시가 가능합니다. 매뉴얼 제작에 관한 모든 문의는 한샘글로벌에 요청해 주세요.