하나의 신제품이 출시된 뒤에는 기능, 디자인, 사양이 일부 변경된 파생 모델이 계속 이어집니다. 제품군과 주요 사용자는 같지만 화면 구성, 버튼 위치, 지원 기능, 부품 사양이 조금씩 달라지는 형태입니다.
사용설명서 제작도 이 주기를 그대로 따라갑니다. 초기에는 기존 매뉴얼을 복사해 필요한 부분만 수정하는 방식으로 대응할 수 있습니다. 그러나 모델 수가 늘어나면 증상이 나타납니다. 같은 기능인데 한 작업자가 맡은 모델과 다른 작업자가 맡은 모델에서 설명이 달라집니다. 한쪽 파생 모델에서 바로잡은 내용이 나란히 진행 중인 다른 모델에는 닿지 않습니다. 이전 사양이 아무도 다시 읽지 않은 절에 그대로 남습니다.
이때 필요한 것이 매뉴얼 표준화입니다.
매뉴얼 표준화는 제품군과 문서 종류에 맞는 공통 기준을 정해 두고, 그 기준대로 파생 모델의 매뉴얼을 제작할 수 있도록 문서 제작 방식을 정리하는 작업입니다.
표준화되어야 하는 7가지 항목
- 표준 목차와 문서 구조
- 용어, 문체, 표현 방식
- 경고문과 안전정보 형식
- 반복되는 기능 설명과 참조 문장
- 이미지, 표, 아이콘과 레이아웃 규칙
- 개정 이력과 변경 관리
- 번역과 검수 기준
1. 제품군과 문서 종류에 맞는 표준 목차 구조를 정한다
먼저 제품군별로 사용설명서의 표준 목차와 정보 배치 순서를 정해야 합니다. 예를 들어 일반적인 사용설명서는 다음과 같은 흐름으로 구성할 수 있습니다.
예시
안전정보 → 제품 소개 → 설치 및 준비 → 기본 사용 방법 → 기능 설명 → 점검 및 관리 → 문제 해결 → 제품 사양
사용자 흐름에 맞춘 기본 구조를 잡은 뒤에는 각 장에 들어갈 중제목과 소제목까지 내려가서 정리해 둡니다. 여기까지 표준화되어 있으면 파생 모델을 제작할 때 목차를 처음부터 다시 짤 필요가 없습니다. 새로 추가된 기능은 표준 목차에서 자기 자리를 찾아 들어가고, 빠진 기능은 해당 항목만 덜어냅니다.
헤딩의 표현 방식도 이때 함께 정합니다. “설치”로 쓸지 “설치하기”나 “설치하려면”으로 쓸지 같은 결정입니다. 작아 보이는 항목이지만 정해 두지 않으면 파생 제작 과정에서 헤딩을 교체할 때마다 표현 스타일이 바뀌고, 매뉴얼 전체의 일관성이 떨어집니다.
주의할 점이 있습니다. 하나의 구조를 모든 기술 문서에 적용하면 곧 무리가 옵니다. 같은 제품군이라도 사용설명서는 사용자의 조작 방법과 안전정보가 중심이지만, 설치 설명서는 설치 공간과 연결 조건, 조립 순서가 중심입니다. 정비 매뉴얼이라면 점검과 분해, 부품 교체, 오류 진단 정보가 앞으로 나옵니다. 문서 종류마다 읽는 사람이 다르고, 읽는 사람이 다르면 정보의 배열 순서도 달라집니다.
2. 용어, 문체, 표현 방식을 통일한다
같은 부품이나 기능이 문서마다 다른 이름으로 표시되면 사용자는 서로 다른 것으로 이해할 수 있습니다. 예를 들어 웨어러블 로봇의 신체 고정부를 다음과 같이 여러 이름으로 부를 수 있습니다.
예시
허리 벨트 / 고정 밴드 / 웨이스트 스트랩 / 허리 고정 스트랩
이들이 모두 같은 부품을 가리킨다면 공식 용어를 하나로 정해야 합니다. 같은 부품을 문서마다 다르게 부르기 시작하면 사용자가 혼란을 겪고, 문서 전체의 일관성도 무너집니다. 번역 단계에서는 같은 대상이 매번 새로운 문장으로 취급되면서 비용까지 올라갑니다.
문체도 통일해야 합니다. “전원 버튼을 누릅니다”, “전원 버튼을 눌러 주세요”, “전원 버튼을 누르십시오”는 의미가 비슷하지만 하나의 매뉴얼 안에서 섞이면 일관성이 깨집니다. 지시문은 ‘-하십시오’로 통일한다는 식으로 정해 두면 됩니다.
표현 방식 통일은 같은 종류의 정보를 같은 순서와 문장 구조로 설명하는 것입니다. 용어와 문체가 단어와 어미에 대한 결정이라면, 표현 방식은 문장 골격에 대한 결정입니다. 예를 들어 기능 설명의 도입부를 사용 상황, 기능, 사용 효과 순으로 쓴다고 정할 수 있습니다.
예시
경로 저장
이 기능은 로봇이 같은 장소를 반복해서 이동할 때 사용할 수 있습니다. 이 기능을 사용하면 이동 경로를 매번 다시 설정하지 않아도 됩니다.
형식이 고정되면 사용자는 두 번째 기능부터 어디만 보면 될지 알고 읽습니다.
3. 경고문과 안전정보 형식을 표준화한다
안전정보는 작성자의 재량에 맡길 수 없는 영역입니다. ANSI Z535.6과 같은 안전메시지 작성 지침을 참고하되, 해당 제품과 매뉴얼에 맞는 형식을 구체적으로 확정해 둬야 합니다.
특히 사용자 안전이 중요한 제품군에서는 위험의 명칭, 위험한 이유, 피하지 못했을 때의 결과, 회피 방법이 빠짐없이 들어가야 합니다. 규격이 요구하는 구성 요소이기 때문입니다.
예시
경고
전도 위험
포크를 올린 상태에서 급회전하면 지게차의 균형이 무너질 수 있습니다. 지게차가 전도되면 사망하거나 심각한 부상을 입을 수 있습니다. 이동할 때는 포크를 낮추고 천천히 회전하십시오.
구성 요소가 정해져 있어도 문서에 어떻게 배치할지는 조직이 정해야 합니다. 위 예시처럼 한 문단으로 이어 쓸 수도 있고, 위험과 원인, 결과, 예방으로 항목을 나눠 표시할 수도 있습니다. 표준화 관점에서 볼 것은 하나를 고른 뒤 같은 제품군의 매뉴얼 전체에 그 형식이 예외 없이 적용되는가입니다. 경고 등급과 신호어, 아이콘, 색상, 경고문의 위치도 이때 함께 확정합니다.
4. 반복되는 기능 설명과 참조 문장을 표준 콘텐츠로 만든다
여러 파생 모델에 반복해서 들어가는 기능 설명은 매번 새로 작성할 필요가 없습니다. 기능의 작동 방식과 사용 조건이 같다면 검토가 완료된 문장을 표준 콘텐츠로 관리하고 재사용할 수 있습니다.
예를 들어 여러 자동차 모델에 같은 자동 문 잠금 기능이 적용된다면 다음 문장을 공통으로 사용할 수 있습니다.
예시
차량이 일정 속도 이상으로 주행하면 모든 문이 자동으로 잠깁니다. 차량이 멈춘 뒤 시동을 끄면 문 잠금이 자동으로 해제됩니다.
파생 모델에서 작동 속도나 해제 조건만 다르다면 전체 설명을 다시 작성하지 않고 해당 조건만 변경하면 됩니다.
다른 내용을 안내하는 참조 문장도 표준화 대상입니다. 참조 문장은 단순해 보이지만 실무에서는 ‘참고하십시오’, ‘확인하십시오’, ‘자세한 내용은 다음을 보십시오’처럼 여러 형태로 갈라지기 쉽습니다. 참조 대상으로 페이지 번호를 넣을 수도 있고, 토픽의 헤딩을 넣을 수도 있습니다. 페이지 번호는 개정 과정에서 쉽게 밀리기 때문에, 헤딩을 쓰는 편이 안전한 경우가 많습니다. 어떤 표현을 선택하든 하나의 기준을 정해 일관되게 사용해야 작성과 번역, 검수가 쉬워집니다.
5. 이미지, 표, 아이콘과 레이아웃 제작 규칙을 정한다
이미지와 표, 아이콘에도 문장과 같은 수준의 규칙이 필요합니다. 사용자가 정보를 빠르게 이해하려면 시각 자료도 같은 기준으로 제작되어야 합니다.
테크니컬 일러스트는 기본 형식부터 정합니다. 제품 외관과 부품 위치를 설명하는 데에는 라인아트가 적합할 수 있고, 재질이나 실제 설치 상태를 보여줘야 한다면 사진이 낫습니다. 복잡한 내부 구조라면 3D 데이터에서 추출한 렌더링을 씁니다. 형식을 정한 뒤에는 기본 방향과 각도, 선의 굵기, 부품 번호 표시 방법, 캡션의 번호와 문장 형식까지 규칙으로 남깁니다.
표는 제목과 열 이름, 단위, 주석의 위치를 같은 형식으로 씁니다. 단위를 열 제목에 한 번만 표시할지 각 수치 뒤에 반복할지 같은, 사소해 보이는 결정이 여기 들어갑니다. 아이콘은 같은 의미에 항상 같은 모양을 씁니다. 참고, 금지, 필수 행동, 공구 필요를 나타내는 아이콘이 매뉴얼마다 달라지면 사용자는 그때마다 의미를 다시 해석하게 됩니다.
6. 개정 이력과 변경 관리 방식을 정립한다
표준 매뉴얼이 만들어지면 제작 지침서가 함께 만들어집니다. 파생 매뉴얼을 제작할 때 이 지침서와 샘플인 표준 매뉴얼을 참고하면서 작업할 수 있습니다. 제작 지침서에는 목차 구성의 원칙, 헤딩 스타일, 용어집, 문체, 표현 방식, 안전 메시지 표기 방식 등이 서술되어 있습니다.
원칙에 변경이 생기면 그 이력을 남겨야 합니다. 언제, 어떤 내용이, 왜 수정되었는지가 기록되어 있어야 이후 파생되는 매뉴얼에 제대로 반영됩니다. 지침서가 갱신되지 않은 채 파생 작업이 이어지면 작업자마다 다른 판단을 하게 되고, 표준 매뉴얼과 실제 문서가 조금씩 벌어집니다.
7. 번역과 검수 기준을 통일한다
다국어로 전개한다면 번역과 검수 기준도 표준화 대상입니다. 제품과 부품의 표준 용어, 숫자와 날짜, 국가별 단위 표기, 버튼과 메뉴의 UI 명칭, 경고문 번역 형식, 번역하지 않는 제품명과 기능명이 대표적인 항목입니다.
영어 UI의 Power Assist를 어떤 문서에서는 ‘동력 보조’, 다른 문서에서는 ‘힘 보조’, 또 다른 문서에서는 ‘파워 어시스트’로 옮기면 동일한 기능이 서로 다른 기능처럼 보입니다.
이런 원칙은 언어별 번역 스타일 가이드로 만들어 번역가와 검수자에게 배포합니다. 제품명이나 UI, 경고문, 문서 구조가 바뀌면 스타일 가이드도 같이 갱신합니다.
표준화가 자리 잡으면 달라지는 것
매뉴얼 표준화의 핵심은 제품군 전체에 적용할 기준을 만들고, 검토가 끝난 콘텐츠를 모델이 바뀌어도 계속 활용할 수 있게 하는 데 있습니다.
체계가 정착되면 작성과 편집 시간이 단축되고 모델 간 내용 불일치와 비일관성 문제가 줄어듭니다. 작성자가 누구냐에 따라 달라지던 품질 편차도 함께 좁혀집니다. 제품군 전체의 매뉴얼이 일관된 구조와 표현을 유지하면 브랜드 아이덴티티도 함께 강화됩니다.
다국어로 전개하는 조직이라면 효과의 크기가 달라집니다. 한 문장을 표준화한 결과가 언어 수만큼 곱해지기 때문입니다. 표준 문장이 번역 메모리에 축적되면서, 파생 모델과 언어 수가 늘어날수록 번역 비용의 차이가 벌어집니다.
매뉴얼을 몇 종 나란히 펼쳐놓고 목차와 용어, 경고문 형식을 비교해보면 지금 상태가 드러납니다. 문서가 서로 달라 보인다면 표준화는 이미 필요한 시점입니다.