사용설명서, 사용자 매뉴얼을 개발하려면 먼저 여러 인적 자원과 표준화된 작업 공정, 제작 인프라가 갖춰져야 합니다. 사용설명서/매뉴얼 제작의 핵심 요소에 관해 소개한 기사를 참고하세요. 이 글에서는 제작에 관한 인프라적인 요소와 별개로, 내용 만들기, 즉 한 권의 사용설명서를 제작하기 위해서 필요한 여러가지 기술 중에서 매뉴얼에 수록되어야 할 항목들에 관한 기본 정보를 담고 있습니다.
[사용설명서의 구성]
ㆍ목차
ㆍ제품 소개
ㆍ안전 주의
ㆍ설치 방법
ㆍ사용 방법
ㆍ문제 해결
ㆍ유지 보수
ㆍ제품 사양
ㆍ보증 정보
1. 목차
목차는 사용설명서의 전반적인 구조를 시각적으로 나타내어 사용자가 매뉴얼에 수록된 주요 내용을 빠르게 파악하고 원하는 사용 정보를 탐색할 수 있도록 지원합니다.
목차가 가진 이 같은 네비게이션 기능을 고려하면 목차는 명확한 계층 구조를 가지고 논리적인 흐름을 따라 구성하여, 사용자가 원하는 정보의 위치를 쉽게 예측하고 빠르게 접근할 수 있도록 해야 합니다.
목차의 항목, 즉 각 항목의 제목글의 스타일은 매뉴얼의 검색성과 접근성을 크게 향상시키는 도구입니다. 제품의 종류나 대상 사용자층에 따라 목차의 제목 스타일은 사용자 중심 (User-oriented Heading)의 액션 헤딩(Action Heading) 방식이나 기기 중심의 헤딩 (Function-oriented Heading) 방식으로 구성될 수 있습니다. 어떤 경우든지, 각 제목은 해당 기능을 명확하게 나타내며, 제목글만 보고도 그 아래 포함된 내용을 쉽게 연상할 수 있어야 합니다. 이를 위해 제목은 간결하면서도 직관적이고 일관성 있게 작성되어야 합니다.
알아두기
사용자 중심의 헤딩 vs 기능 중심의 헤딩 User-oriented heading, Task-oriented heading vs Machine-oriented heading, Function-oriented heading
사용자 니즈를 설명하는 제목글 (예시: 물체에 근접하여 촬영하기)과 기기 또는 기능 중심의 제목글 (예시: 줌 촬영)을 말합니다.
액션 헤딩 Action heading, Verb heading
명령형 동사를 사용하여 사용자가 무엇을 해야 하는지 안내하는 제목글. 예시: OO 촬영하기, 등록하기 등. Action heading에 대비되는 Topic heading (한 단어 또는 짧은 명사구문으로 된 헤딩) Question heading (질문형 헤딩)이 있습니다.
2. 제품 소개 (Introduction)
제품의 기본 개요, 주요 기능 및 특징, 사용설명서의 목적을 간략하게 설명합니다. 가능한 기술적인 용어는 자제하고, 제품의 구성과 구조를 한 눈에 파악할 수 있도록 제작합니다. 이 섹션에는 다양한 시각적 보조장치, 테크니컬 일러스트와 개념도 등을 삽입하는 것이 효과적입니다.
3. 안전 주의 정보 (Safety Precautions)
제품 사용 중 주의해야 할 안전 수칙을 명확히 전달합니다. 위험 요소, 주의 사항, 금지 사항 등을 포함하여 사용자 안전을 최우선으로 고려합니다. 정상적인 작동 범위 내에서 발생 가능한, 또는 예측 가능한 모든 위험을 명확하게 표시해야 합니다.
안전 경고의 레벨인 Danger, Warning, Caution, Notice의 분류 및 표현, Safety Alert 심볼의 표기 방법, 안전메시지의 구성은 모두 ISO 3864-1, ISO 7010, IEC 82079-1 국제 표준의 안전표시 지침에 맞추어 작업합니다.
제품이 판매 지역의 법규나 규정을 준수하고 있음을 설명서에 표시해야 하는 제품도 많습니다. 전기적 안전 규정, 전자파 위험 등에 대해 규정을 준수하고 판매 지역의 인증을 받았음을 알리는 정보도 포함시킵니다.
안전 메시지의 정확한 분류, 표현, 위치는 사용자 안전과 직결되는 중요 항목으로 특히 해외 판매되는 제품의 경우 대상 국가, 지역의 법규정과 밀접하게 관련됩니다. 만일 북미로 수출되는 제품이라면 ANSI Z535-6 Product Safety Information In Product Manual을 참고하여 안전한 사용설명서를 제작하는데 만전을 기해야 합니다. 보다 상세한 정보는 매뉴얼 제작 기술: 사용자 안전 표시 기사를 참조하십시오.
4. 설치 방법 (Installation Instructions)
제품의 설치 절차와 초기 설정 등의 정보를 단계별로 상세하게 설명합니다. 언팩부터 설치 완료까지 필요한 도구나 준비물, 설치 환경, 설치시 유의사항 등을 포함합니다. IEC 가이드라인에서 언급하고 있는 설치 정보 사례는 설치 전 준비물, 설치할 환경에 대한 제한, 설치할 장소에 대한 제한, 공급 전원에 대한 지시, 설치 배선에 대한 지시, 설치 방법, 조립 방법, 고정 방법, 설치 시 안전에 대한 지시, 예상되는 설치 오류에 대한 주의, 배기 구멍/벽면에 대한 지시, 설치 부속품의 취급 방법, 그밖의 기기와의 접속 방법 등 해당되는 사항은 모두 포함할 것을 요청하고 있습니다.
설치편의 구성은 사용자 안전을 고려하여 비전기적 부품 먼저 설치, 이어서 전기적 부위 연결, 쉬운 설치 먼저, 이어서 복잡한 설치 등, 논리적으로 전개해야 합니다. 각 단계마다 필요한 이미지를 삽입하여 사용자들이 혼동 없이 설치할 수 있도록 돕습니다. 전문 용어의 사용을 피하고 단계별 번호를 붙여 순차적으로 진행하도록 합니다.
5. 사용 방법 (Operation Instructions)
제품의 사용 방법을 단계별로 설명합니다. 주요 기능의 설명과 함께, 다양한 사용 환경에서의 활용 방법도 포함됩니다. 기능이 많은 경우라면 기본적인 기능 먼저, 심화 기능 나중 순서로 분류 배치해야 합니다. 사용자의 행동을 예측하여 작업 순서에 맞춘 사용 정보 배치, 또는 사용 목적 별로 기능을 모아서 사용 방법을 설명합니다.
각 기능의 사용법은 단계별로 자세한 설명을 제공하고, 중요한 사항은 강조 표시를 통해 눈에 잘 띄게 합니다. 각 단계는 사용자 입장에서 쉽게 따라 할 수 있도록 시각적 자료나 스크린샷을 함께 제공합니다. 각 단계에서 예상되는 오류나 위험은 해당 스텝에서 정보를 확인할 수 있도록 합니다.
6. 문제 해결 (Troubleshooting)
사용 중 발생할 수 있는 문제 상황과 그 해결 방법을 제공해야 합니다. 일반적인 오류, 경고 메시지, 해결 방법 등을 포함합니다. 문제 상황을 구체적으로 설명하고, 가능한 여러 해결 방법을 명시합니다. 사용자가 신속하게 문제를 해결할 수 있도록 단계별로 작성하고, 이미지나 도표를 사용해 설명을 보충합니다.
사용설명서의 필요성을 인식하지 못하는 대부분의 사람들이 사용설명서를 필요로 하는 순간이 제품에 이상이 생겼을 때이고 문제 해결 편에서 고장의 원인과 대처 방법을 파악하고 싶어 합니다. 사용설명서가 부족하다, 도움이 되지 않는다고 느끼는 순간은 문제 해결 편을 통해 필요한 정보를 찾지 못했을 때 입니다.
그러므로 문제 해결 편에서는 사용 중에 발생할 수 있는 모든 오류가 나열되어야 하며, 각각의 오류에 대해서 증상과 원인, 그리고 사용자가 수행할 수 있는 대처 방법이 정확하게 수록되어야 합니다.
7. 유지 보수 및 관리 (Maintenance and Care)
제품의 관리 및 유지 보수 방법을 안내합니다. 정기적인 점검 항목, 청소 방법, 부품 교체 주기 등을 포함합니다. 유지 보수는 사용자들이 쉽게 이해하고 실행할 수 있는 방식으로 설명합니다. 필요한 도구와 과정, 주의 사항을 명확하게 표기하여 안전한 관리가 가능하도록 합니다. 최근 친환경 제품과 관련한 요구가 높아지고 있는 만큼, 제품의 환경 친화적인 요소나 재활용 방법에 대한 정보를 포함할 수 있습니다.
8. 제품 사양 (Specifications)
제품의 기술 사양, 전원 요구 사항, 크기, 무게 등 중요한 데이터를 제공합니다. 기술적 정보는 표로 구성하여 한눈에 보기 쉽게 하고, 단위와 용어는 명확하게 표기합니다.
9. 보증 및 서비스 정보 (Warranty and Service Information)
제품의 보증 기간, 서비스 절차, 고객 서비스 연락처를 안내합니다. 보증 조건과 절차는 간결하고 명확하게 설명하며, 고객 서비스 관련 정보는 사용자가 쉽게 접근할 수 있도록 명시합니다.
한샘글로벌의 경쟁력
한샘글로벌의 매뉴얼 제작 서비스는 사용자 맞춤형 정보, 모바일에서 열람이 가능한 사용자 친화적인 웹 매뉴얼 제작, 50개 이상의 언어로 현지화, AI친화적인 테크니컬 라이팅 기술로 사용설명서의 미래를 개척합니다. 구성과 기획, 라이팅, 디자인과 편집을 거쳐, 다국어 번역 및 퍼블리싱까지 모두 한곳에서 이루어지는 원스톱 개발 프로세스를 갖추어서 혁신적인 제작 기간, 전 세계 동시 출시가 가능합니다. 매뉴얼 제작에 관한 모든 문의는 한샘글로벌에 요청해 주세요.