사용설명서 제작 시 중요한 요소는 사용 정보의 품질입니다. 이번 블로그에서는 매뉴얼 제작 기술에 관한 국제 표준인 IEC/IEEE 82079-1: 2019, 이에 대응하는 한국 표준인 KS C IEC 82079-1:2019 에 기반한, 정보의 품질을 높이는 7가지 주요 원칙을 소개합니다.
7가지 원칙:
• 완전성(completeness)
• 미니멀리즘(minimalism)
• 정확성(correctness)
• 간결성(conciseness)
• 일관성(consistency)
• 가해성(comprehensibility)
• 접근성(accessibility)
1. 완전성 Completeness
사용설명서는 사용자가 제품을 안전하고 효율적으로 사용할 수 있도록 필요한 모든 정보를 제공해야 합니다. 예를 들어, 제품 사용 시 발생할 수 있는 위험이나, 사용자가 반드시 알아야 할 절차들이 포함되어야 합니다. 특정 기능의 사용법을 설명할 때도 절차가 완료되었을 때, 사용자가 완료 여부를 확인할 수 있는 방법도 명시해야 합니다. 예를 들어, 화면이 대기 모드로 바뀌거나 경고음이 울리는 것처럼 말입니다.
[정보의 완전성 판단 예시]
• 제품 사용 중 발생할 수 있는 모든 위험이 설명되어 있는가?
• 제품의 모든 기능과 절차가 빠짐없이 안내되어 있는가?
• 대상 사용자가 필요한 모든 정보(식별 정보, 안전 정보, 수리 및 폐기 방법 등)가 포함되어 있는가?
• 판매 지역의 법적 규제 및 규정 준수에 대한 정보가 제공되었는가?
Information for use shall be complete. The completeness of information depends on the following being addressed: a) the risks of using the product; b) the tasks that the target audiences are intended or allowed to perform throughout the life cycle of the supported product; c) the target audiences’ need for information; and d) legal and contractual requirements. (IEC 82079-1. 5.3.2)
2. 미니멀리즘 Minimalism
사용설명서는 꼭 필요한 정보만을 포함해야 합니다. 불필요한 내용이 많으면 사용자가 중요한 정보를 놓칠 수 있습니다. 간혹 사용설명서에 마케팅 정보를 포함하거나 한 문서에 대상 독자가 다른 전문 서비스 정보, 예를 들면 설치는 전문 설치 기사가 수행하는 제품의 사용설명서에 설치 관련한 정보를 포함시켜 두거나 전문 서비스 센터로 가져가야 할 고장에 관한 상세한 수리 방법을 일반 사용자를 대상으로 하는 설명서에 포함시켜 두는 것이 불필요한 정보를 포함시킨 사례가 됩니다. 매뉴얼은 타겟 사용자를 단일화하여 작성하고 대상 사용자가 제품을 안전하고 효율적이며 효과적으로 사용하는데 필요한 핵심 정보만 수록하세요. 중요한 정보는 반복해서 제공될 수 있지만, 이는 안전 정보 등 필수적인 내용에 한정됩니다.
[미니멀리즘 판단 예시]
• 대상 사용자에게 필요한 내용만 수록되어 있는가?
• 설명이 간결하여 정보를 파악하기 용이한가?
• 중복되어 게시된 내용은 없는가?
Minimalism shall be applied. Minimalism is an approach to information for use that includes critical information and the least amount of other information needed to be complete. Critical information includes the safe use of the product, the security of the information created with the product, or the privacy of the information created by or stored with the product. (IEC 82079-1. 5.3.3)
3. 정확성 Correctness
설명된 정보는 정확해야 합니다. 조작 절차는 설명대로 수행하면 정확하게 작동되어야 하며, 안전에 관한 경고는 회피 방법에 맞추어 실행하면 안전하게 조작되어야 합니다. 또한 제품이 업데이트되거나 변경되면, 매뉴얼도 이에 맞춰 수정되어야 합니다.
[정보의 정확성 판단 예시]
• 수록된 정보가 정확한가?
• 수록된 주소나 사양 정보가 최신인가?
• 누락된 정보가 없는가?
Information for use shall be technically correct and contain the current information on the supported product to which the information for use relates. If the supported product is being modified, the need for changes in the information for use should be evaluated. (IEC 82079-1. 5.3.4)
4. 간결성 Conciseness
정보는 짧고 명확하게 전달되어야 합니다. 불필요한 세부 사항을 줄이고 핵심 내용을 간결하게 서술하는 것이 중요합니다. 복잡한 절차는 나누어서 설명하고, 불필요한 수식어는 제거합니다. 예를 들어 “매우 빠른”, “놀라운 기능” 같은 수식은 사용하지 않습니다. 사용 정보는 “one expression, one simple meaning”라는 원칙에 따라 짧은 문장 안에 간결하고 명확하고 단도직입적인 문구로 작성합니다.
[정보의 간결성 판단 예시]
• 문장이 짧고 명확한가?
• 텍스트에 불필요한 세부 정보가 포함되어 있지 않은가?
• 삽화에 불필요한 세부 정보가 포함되어 있지 않은가?
• 상호 참조로 중복 기술을 배제하고 간결함을 유지하고 있는가?
Information for use shall be concise with respect to format and media. Conciseness with respect to the content and presentation of the information means: a) succinct wording; b) text and illustrations without unnecessary details; and c) videos as short as relevant. (IEC 82079-1. 5.3.5)
5. 일관성 Consistency
사용설명서에 수록된 정보는 그 내용과 형식이 일관되어야 합니다. 내용의 일관성은 동일한 용어와 표현을 반복적으로 사용하고, 기호나 부호, 아이콘, 심볼의 형식도 일관되어야 합니다. 형식에 있어서 정보의 분류 및 배치가 일관성있어야 합니다. 레이아웃, 색상, 타이포그래피의 적용을 일관되게 하십시오. 삽화의 형식이나 캡션의 위치도 일관되어야 하며 여러 곳에서 도표가 등장한다면 도표의 표현 방법도 일관성있어야 합니다. 제품이나 각 부위를 지칭하는 명칭은 매뉴얼, 제품 포장, 고객 지원 및 홍보 마케팅 자료, 웹사이트를 통해서도 동일한 형식으로 일관성있게 사용되어야 합니다.
[정보의 일관성 판단 예시]
• 매뉴얼의 구성, 구조가 논리적이고 일관성 있는가?
• 섹션 명칭이나 헤딩 스타일은 일관성 있는가?
• 용어나 표현은 문서 전체에 걸쳐 일관성 있게 사용되고 있는가?
• 제품과 사용 정보는 정확하여 일관성을 추구하고 있는가?
• 단위나 기호, 안전 경고 라벨, 색상 등이 일관되게 사용되게 있는가?
• 문서 디자인의 형식은 일관성있게 적용되고 있는가?
• 매뉴얼과 관련된 외부 자료에서 동일한 사용 정보가 일관성 있게 사용되고 있는가?
Information for use shall be consistent with respect to the content, format and media. Consistency with respect to content means, for example, that the information is unambiguous and correct (e.g. consistent with the supported product). Consistency with respect to format and media means, for example, consistent terminology, units of measurement, structures and indications (i.e. headings, titles), symbols, warning messages, and use of colours. (IEC 82079-1. 5.3.6)
6. 이해 가능성 Comprehensibility
매뉴얼은 사용자에게 이해하기 쉬운 언어와 그래픽으로 구성되어야 합니다. 글자 크기, 문단 사이의 간격, 색상 사용이 정보를 이해하기 쉽도록 해야 합니다. 매뉴얼에 수록된 정보가 이해하기 쉬워야 하고 매뉴얼의 구성이 이해하기 쉬운 구조여서 원하는 정보를 찾기가 용이해야 합니다. 기능을 언제 어떻게 사용하면 되는지가 쉽게 파악이 되어야 하고 어떤 행동은 위험을 초래하는지 명확하게 파악되어야 합니다. 특히 응급 상황에서는 신속히 정보를 이해하는 것이 중요하기 때문에 위험 경고는 안전 표지나 그래픽을 활용해 직관적으로 정보를 전달하는 것이 좋습니다.
사용 정보의 이해 가능성을 높일 수 있도록 표준에서는 각 기능의 사용법 표현도 아래와 같은 형식을 제시하고 있습니다.
1. 설명 절차는 숫자를 사용하여 번호를 매기고 수행하는 순서대로 제시할 것
2. 각 절차에 관련된 경고나 주의 사항은 해당하는 설명 단계 앞에 제시할 것
3. 각 절차 단계는 단계마다 하나의 작업만 설명할 것
4. 설명 단계는 예상되는 결과나 시스템 응답을 표시할 것
5. 사용 중에 발생할 수 있는 오류가 있다면 오류를 식별할 수 있는 방법과 복구 절차에 대해 설명할 것
6. 길거나 복잡한 단계 설명은 나누어서 표시할 것
7. 단계를 생략할 수 있거나 단계 도중에 취소할 수 있다면 어떻게 하면 될지 표시할 것
8. 다른 정보를 참조해야 하거나 특별한 주의를 기울여야 하거나 오류가 많이 발생하는 단계가 있다면 알릴 것
9. 영어, 불어 등 명령형 문장이 존재하고 그런 문장이 문화적으로 용인되는 언어라면 설명 단계에서 명령형을 사용할 것
[정보의 이해가능성 판단 예시]
• 문장이 이해하기 쉬운가?
• 설명이 쉽게 이해되는가?
• 용어가 이해하기 쉬운가?
• 삽화가 이해하기 쉽고 정보 파악에 도움이 되는가?
• 안전 기호나 그래픽, 주의사항이 눈에 띄는가?
• 배경색과 글자색의 대비가 확실해서 정보를 식별하기 쉬운가 ?
• 사용 정보의 구성과 구조를 이해하기 쉬운가?
Information for use shall be comprehensible to the target audiences. This requires: a) comprehensible text and terminology; b) comprehensible illustrations, safety signs and graphical symbols; and c) comprehensible methods of navigation and use of media. (IEC 82079-1. 5.3.7)
7. 접근성 Accessibility
사용자는 언제 어디서나 매뉴얼에 접근할 수 있어야 합니다. 사용자가 온라인으로 접근하기 힘든 경우도 있으므로 인쇄본 매뉴얼을 제공하고 동시에 인터넷을 통해서도 매뉴얼을 볼 수 있도록 합니다. 사용 정보가 복잡하다면 짧은 참조용 자료, 스티커, QRG 등을 제공합니다. 인쇄된 매뉴얼이나 온라인 매뉴얼 모두 제품이 사용되는 수명 기간 동안 유지되어야 합니다. 공급자는 시각 장애나 청각 장애가 있는 대상 사용자 그룹도 사용 정보를 이용할 수 있도록 준비해야 합니다.
[정보 접근성 판단 예시]
• 인쇄본과 온라인 매뉴얼을 같이 제공하는가?
• 인쇄본의 내구성이 좋아서 제품의 수명 기간 동안 유지될 수 있는가?
• 장애인을 위한 지원 도구가 있는가?
• 활자 크기나 레이아웃이 적절해서 사용 정보를 확인하기 용이한가?
Information for use shall be accessible (e.g. technically available and legible) for the target audiences in the context of use and throughout the intended lifetime of the supported product. (IEC 82079-1. 5.3.8)
한샘글로벌의 경쟁력
한샘글로벌은 사용설명서에 관련한 국제 표준과 한국 표준 개발 작업을 지원하는 IEC TC 3 Documentation, Graphical Symbols and Representations of Technical information 전문위원회에서 활동하고 있습니다. 문서 개발에 관련한 국제 표준은 기업이 국경을 넘어 세계 시장으로 진출하고자 할 때 글로벌 기준을 충족하는 문서 개발의 지침이 됩니다. 국가마다, 지역마다, 자국의 시장을 보호하기 위한 규정과 규제가 많습니다. 국제 표준의 준수는 이 같은 규정과 규제를 충족시켜서 안전하고 효과적으로 시장에 진출하도록 지원합니다. 문서 개발에 국제 표준을 적용하여 안전하게 세계 시장의 문을 열어 가세요