제품에 매뉴얼이 있는데도 고객센터에는 같은 질문이 반복해서 들어옵니다. 매뉴얼에 해당 정보가 없어서가 아니라 사용자가 문제를 찾아가는 방식과 문서가 작성된 방식이 서로 다르기 때문입니다. 이 가이드는 그 차이를 좁히는 작성 방법을 구조, 용어, 문장, 제목, 재사용, 품질관리, 다국어 확장의 7가지 기준으로 정리하고 각 기준마다 고쳐 쓰기 예시를 함께 실었습니다. 마지막 장에서는 이 기준을 사람의 검수만으로 지킬 수 있는 한계와 그 해법을 다룹니다.
이 가이드에서 다루는 7가지 기준
- 사용자가 읽는 문서 구조
- 쉬운 용어 변환
- 행동 중심 문장
- 고객 문의를 줄이는 제목 구성
- 맥락 없이 독립적으로 읽히는 문장
- 담당자별 품질 편차를 줄이는 작성 기준
- 번역과 다국어 확장을 고려한 작성
1. 사용자가 읽는 문서 구조
대부분의 매뉴얼은 제품 기능 순서대로 목차를 구성합니다. 제품 사양이 앞에 오고 부품 이름이 뒤따르고 오류 코드가 맨 뒤에 붙는 방식입니다. 그런데 사용자는 이 목록을 처음부터 훑어보지 않고 지금 자신이 겪고 있는 상황을 기준으로 들어올 자리를 찾습니다. 그래서 개별 제목의 문구를 다듬기 전에 문서 전체를 어떤 단위로 묶고 어떤 순서로 배열할 것인지부터 정해야 합니다.
BEFORE
제품 기능 순서로 배열한 목차
- 제품 사양
- 각 부분의 명칭
- 설치 방법
- 기본 조작
- 필터 사양
- 센서 설정 방법
- 오류 코드 안내
- 서비스 안내
제품의 구조 순서대로 배열한 경우입니다. 제품에서 냄새가 난다고 느껴 매뉴얼을 펼친 사용자는 이 목록에서 어디를 눌러야 할지 알 수 없습니다.
AFTER
사용자의 상황 순서로 묶은 목차
- 설치하고 처음 켜기
- 놓을 자리 정하기
- 필터 비닐을 벗기고 끼우기
- 앱에 제품 등록하기
- 쓰다가 막혔을 때
- 청정도 표시가 계속 빨간색이에요
- 공기청정기에서 냄새가 나요
- 앱에서 제품이 검색되지 않아요
- 계속 쓰기 위해 관리하기
- 필터를 갈아야 하는 시점 확인하기
- 본체와 센서 청소하기
- 그래도 해결되지 않으면
- 오류 코드로 원인 찾기
- 서비스 접수하기
사용자가 제품을 사용하는 시간 순서로 구조를 세우고, 그 안에 실제 상황을 넣었습니다. 문의가 가장 많은 묶음이 두 번째 자리에 옵니다.
작성 기준
- 목차를 기능 단위로 나누지 말고 사용자의 상황과 문제 단위로 묶는다
- 사용자가 제품을 만나는 시간 순서(설치 → 사용 → 관리 → 문제 해결)를 큰 뼈대로 삼는다
- 문의 빈도가 높은 묶음을 문서 앞쪽에 배치한다
- 하나의 문서 또는 섹션에는 하나의 문제만 담는다
- 가장 흔한 원인을 다루는 항목을 그 묶음의 첫 자리에 놓는다. 위 예시의 ‘필터 비닐을 벗기고 끼우기’가 그렇다
2. 쉬운 용어 변환
전문 용어는 문서를 작성하는 담당자에게는 익숙하지만 사용자에게는 문서를 읽기 시작하는 지점에서 만나는 장벽이 됩니다. 용어 자체를 문서에서 없앨 수 없는 경우에는 그 용어가 처음 등장하는 시점에 쉬운 표현을 함께 제공해야 합니다. 이때 쉬운 표현을 앞에 쓰고 원래 용어를 괄호에 넣는 순서를 지켜야 사용자가 내용을 먼저 이해하고 용어를 확인하게 됩니다.
BEFORE
- 펌웨어를 최신 버전으로 업데이트하세요.
- SSID를 선택한 후 WPA2 인증을 진행하세요.
- BLE 페어링에 실패하면 AP 모드로 전환하세요.
- 초기 구동 시 캘리브레이션이 수행됩니다.
- 잔여 필터 수명을 확인하세요.
AFTER
- 기기 내부 소프트웨어(펌웨어)를 최신 버전으로 업데이트하세요.
- 와이파이 이름(SSID)을 고르고 비밀번호를 입력하세요.
- 블루투스 연결에 실패하면 와이파이 직접 연결 모드(AP 모드)로 바꾸세요.
- 제품을 처음 켜면 센서가 스스로 기준값을 잡습니다. 작업이 수행되는 동안 약 1분간 제품을 움직이지 마세요.
- 필터를 앞으로 며칠 더 쓸 수 있는지 확인하세요.
작성 기준
- 전문 용어와 약어는 처음 등장할 때 쉬운 설명을 함께 쓴다. 쉬운 표현을 앞에, 원래 용어를 괄호에 넣는다
- 쉬운 말로 정확히 바꿀 수 없는 용어는 억지로 풀지 않는다. 잘못된 풀이는 아예 없는 것보다 나쁘다
- 회사 내부에서만 쓰는 용어(제품 코드명, 개발 단계 명칭)는 사용자용 문서에서 지운다
- 조직 전체가 참고하는 용어집을 만들고, 같은 기능을 문서마다 다른 이름으로 부르지 않는다
- 사용자가 이미 아는 말로 바꿀 수 있으면 용어를 아예 쓰지 않는다. 위 예시의 ‘잔여 필터 수명’처럼 풀어 쓰는 편이 나은 경우가 많다
3. 행동 중심 문장
매뉴얼의 절차 문장은 제품의 상태를 서술하는 것이 아니라 사용자가 지금 무엇을 해야 하는지를 먼저 알려주어야 합니다. 그리고 사용자는 자신이 그 동작을 제대로 수행했는지 확인할 수 있어야 다음 스텝으로 넘어갑니다. 그래서 절차 문장에는 사용자가 취할 행동과 그 행동의 결과가 함께 들어가야 합니다.
BEFORE
- 전원 버튼은 제품 뒷면 하단에 위치해 있습니다.
- 필터 교체 후 설정 메뉴에서 초기화가 가능합니다.
- 등록이 완료되면 다음 단계로 이동됩니다.
- 물탱크 미장착으로 인해 동작하지 않음.
- [동의]를 누르세요.
- 제품은 다양한 환경에서 사용할 수 있으며, 설치 위치에 따라 성능이 달라질 수 있습니다. 아래 내용을 참고하세요.
AFTER
- 제품 뒷면 아래쪽의 전원 버튼을 누르세요.
- 필터를 갈아 끼운 다음 설정 메뉴에서 [필터 사용 시간 초기화]를 누르세요.
- 제품을 등록하고 [다음]을 누르세요.
- 물탱크를 끝까지 밀어 넣으세요. ‘딸깍’ 소리가 나면 제대로 끼워진 것입니다.
- [동의]를 누르세요. 앱 화면에 제품 이름이 나타나면 등록이 끝난 것입니다.
- 필터를 꺼내 앞뒤를 확인하세요. 비닐 포장이 씌워져 있으면 벗긴 다음 다시 끼우세요. 그래도 빨간색이면 아래 순서대로 센서를 청소하세요.
작성 기준
- 문장을 동사로 시작하거나 행동을 문장 앞쪽에 배치한다
- 수동태와 명사형 종결(‘~되어 있습니다’, ‘~함’) 대신 명령형 종결 (‘~하세요’) 형태를 쓴다
- 한 문장에는 하나의 행동만 담는다
- 섹션 첫 문장에서 바로 해결 행동을 제시한다. 배경 설명은 뒤로 보내거나 뺀다
- 행동 뒤에 예상되는 결과를 짧게 덧붙여 사용자가 성공 여부를 스스로 확인하게 한다
- 사용자를 탓하는 표현을 쓰지 않는다. ‘잘못 조작한 경우’가 아니라 ‘버튼이 눌리지 않았을 수 있습니다’로 쓴다
4. 고객 문의를 줄이는 제목 구성
제목이 하는 역할은 사용자가 검색으로 자신이 알고 싶은 토픽에 접근하게 하는 것입니다. 그리고 목차에서 이 문서가 내가 필요로 하는 작업 항목을 나열하고 있는지 알 수 있게 합니다. 기능명으로 제목을 작성하면 사용자가 필요로 하는 작업인지 아닌지는 해당 토픽을 열어 봐야 압니다. 그래서 사용자의 목적을 담은 형식의 제목이 필요합니다. 다만 사용자가 검색창에 입력하는 단어는 제목에 그대로 남겨야 합니다.
BEFORE
- 네트워크 설정
- 필터 관리
- 오류 코드 안내
- 소음 관련 안내
- 절전 모드 사용 방법
AFTER
- 앱에서 제품이 검색되지 않아요
- 필터를 새로 갈았는데 교체 알림이 계속 떠요
- 화면에 E2가 표시돼요
- 청소 중 ‘드르륵’ 소음이 날 때
- 절전 모드로 안 쓸 때 전기 아끼기
작성 기준
- 사용자가 검색할 단어(기능명, 오류 코드, 부품 이름)를 제목 안에 반드시 남긴다
- 그 단어에 증상이나 상황을 붙여 이 문서가 무엇을 해결하는지 밝힌다
- 제목은 한 줄을 넘기지 않는다. 오류 메시지 전문을 제목에 그대로 옮기지 않는다
- 반복 문의가 많은 주제일수록 제목을 더 잘게 나눈다
- 제목만 보고도 이 문서가 내 문제를 다루는지 판단할 수 있어야 한다
사용자의 언어는 어디서 가져오는가
제목에 쓸 단어를 회의실에서 만들어내면 안 됩니다. 사용자가 이미 남긴 기록에서 그대로 가져옵니다.
- 고객센터 상담 티켓의 첫 문장. 사용자가 문제를 어떻게 부르는지가 그대로 적혀 있다
- 자사 홈페이지와 앱의 검색 로그. 검색했는데 결과가 없었던 질의가 최우선 대상이다
- A/S 접수 내역과 서비스 기사의 현장 기록. 사용자가 자가 해결에 실패한 지점이 남아 있다
- 챗봇과 상담 봇의 대화 로그. 사용자가 처음 입력한 문장을 그대로 볼 수 있다
- 앱스토어와 온라인 쇼핑몰 리뷰. 부정 리뷰에는 실패한 절차의 이름이 담겨 있다
- 온라인 커뮤니티와 SNS의 제품 관련 게시글과 댓글
- 검색어 자동완성과 검색광고 키워드 데이터
5. 맥락 없이 독립적으로 읽히는 문장
하나의 원천 문장을 카드뉴스의 한 컷으로도 쓰고 영상의 자막으로도 쓰려면 그 문장이 앞뒤 맥락 없이 그 자체로 이해되어야 합니다. 앞 문장이나 이전 스텝에 기대어 의미가 완성되는 문장은 다른 형식으로 옮길 때마다 다시 작성해야 합니다. 그래서 매뉴얼을 작성하는 시점에 이미 재사용을 전제한 문장 단위가 필요합니다.
BEFORE
위에서 설명한 대로 앱 설치를 마쳤다면, 이제 아래와 같이 제품을 등록합니다. 이때 앞서 확인한 와이파이 정보가 필요하며, 연결이 되지 않을 경우 이전 단계를 다시 확인하세요.
‘위에서 설명한 대로’, ‘앞서 확인한’, ‘이전 단계’에 의존합니다. 이 문단을 카드뉴스 한 컷으로 잘라내면 뜻이 통하지 않습니다. 영상 자막으로도 쓸 수 없습니다. FAQ 답변에 붙여 넣으면 사용자가 앞 내용을 찾으러 되돌아갑니다.
AFTER
- 앱을 열고 [기기 추가]를 누르세요.
- 목록에서 제품 이름을 고르세요.
- 와이파이 이름을 고르고 비밀번호를 입력하세요.
- [연결하기]를 누르세요. 제품에서 알림음이 울리면 연결이 끝난 것입니다.
네 문장이 각각 독립적으로 읽힙니다. 카드뉴스 4컷, 영상 4개 장면, FAQ 답변, 챗봇 응답에 그대로 들어갑니다. 문장을 다시 쓰는 작업이 사라집니다.
작성 기준
- 각 문장 또는 스텝은 앞뒤 맥락 없이 단독으로 읽어도 의미가 통해야 한다
- 긴 절차는 하나의 문단으로 쓰지 말고 번호가 매겨진 짧은 스텝으로 나눈다
- 하나의 스텝이 하나의 화면(영상 컷, 카드뉴스 슬라이드)에 대응하도록 분량을 맞춘다
- ‘위에서’, ‘앞서’, ‘아래와 같이’, ‘이전 단계’ 같은 위치 지시어를 절차 문장에 쓰지 않는다
▲ 같은 원천 문장 4개에서 파생한 모바일 매뉴얼과 카드뉴스 (예시용 가상 제품)
▲ 요금 납부 확인서 발급 방법에 대한 모바일용 매뉴얼과 카드뉴스 (예시용 가상 제품)
6. 담당자별 품질 편차를 줄이는 작성 기준
작성자가 바뀔 때마다 문장의 톤과 용어 표기가 달라지면 사용자는 같은 제품의 매뉴얼인데도 문서마다 다른 인상을 받습니다. 이 편차는 개인의 글쓰기 역량에 기대는 방식으로는 줄어들지 않습니다. 그래서 작성자가 누구인지와 관계없이 같은 판단을 내리게 하는 기준 문서 4종이 필요합니다.
① 문장 작성 가이드
- 하나의 절차 스텝은 한 문장으로 쓰고, 한 문장에 행동을 두 개 이상 담지 않는다
- 반복되는 공통 절차는 공통 문장 파일에 등록하고 모든 매뉴얼이 같은 문장을 쓴다
- 우리말로 풀어 쓸 수 있는 영문은 우리말로 쓰고, 불필요한 영문 표기를 지양한다
- 안전 경고와 반드시 지켜야 할 절차에는 ‘~해 주세요’를 쓰지 않는다. ‘~하세요’ 또는 ‘~하지 마세요’로 단정한다
- 화면에 표시되는 문구는 대괄호로 감싸 그대로 옮긴다. 예: [기기 추가]
② 용어 가이드
- 제품과 기능마다 공식 명칭 하나만 정하고, 나머지 표현은 금지어로 등록한다
- 공식: 전원 버튼 / 금지: 파워 버튼, 전원 키, 온오프 버튼
- 공식: 필터 교체 알림 / 금지: 필터 알람, 필터 경고, 교체 표시
- 관공서 문체와 기술 문서 문체를 금지어 목록으로 관리한다
금지 표현
- 상이한 경우가 있습니다
- 오류 발생 시
- 해당 버튼을 누르십시오
- 교체를 진행하시기 바랍니다
- 동작이 불가합니다
- 장착 여부를 확인 요망
권장 표현
- 다를 수 있습니다
- 오류가 생기면
- [시작] 버튼을 누르세요
- 필터를 교체하세요
- 작동하지 않습니다
- 물탱크가 끼워져 있는지 확인하세요
③ 브랜드 가이드
- 10대부터 60대 이상까지 누구나 따라 할 수 있는 수준으로 쓴다. 중학생이 읽고 절차를 완수할 수 있어야 한다
- 전체 구조를 사용자의 사용 목적 순서로 배열한다. 제품 사양을 앞세우지 않는다
- 사용자를 탓하는 표현을 쓰지 않는다
- 제품이 하지 못하는 일은 숨기지 말고 명확히 알린다. 감춘 제약은 그대로 문의가 된다
④ QA 체크리스트 (발행 전 검수)
- 화면에 표시되는 문구와 매뉴얼의 문구가 글자 단위로 일치하는가
- 버튼 이름 표기 규칙(대괄호)이 문서 전체에 일관되게 적용되었는가
- 한 문장에 두 개 이상의 행동이 들어 있지 않은가
- 용어집에 없는 새 용어가 사용되지 않았는가
- 금지 표현 목록에 있는 단어가 남아 있지 않은가
- 안전 경고가 해당 절차보다 앞에 배치되었는가
- 그림과 스크린샷이 최신 화면과 일치하는가
- ‘위에서’, ‘앞서’, ‘아래와 같이’, ‘이전 단계’ 같은 위치 지시어가 절차 문장에 남아 있지 않은가
- 맞춤법, 띄어쓰기, 오탈자 오류가 없는가
이 4종 세트를 표준 템플릿으로 만들어 두면 신규 작성자도 빠르게 같은 품질 수준에 도달하고, 검수 시간도 함께 줄어듭니다.
7. 번역과 다국어 확장을 고려한 작성
제품을 해외 시장에 출시한다면 매뉴얼은 반드시 번역 과정을 거치게 되고, 이때 원문 한 문장이 번역의 비용과 품질을 그대로 결정합니다. 앞에서 다룬 여섯 가지 기준은 국내 사용자를 위한 규칙이면서 동시에 번역 원가를 낮추는 규칙이기도 합니다. 다만 번역 단계에서는 손댈 수 없고 원문을 작성하는 시점에만 지킬 수 있는 항목이 몇 가지 더 있습니다.
BEFORE
- 이것을 누른 후 잠시 기다리면 완료됩니다.
- 설치가 끝나면 등록을 진행하시고, 문제가 있을 경우 재시도하십시오.
- 그림 안에 ‘전원 버튼’이라는 한글 글자를 넣는다.
- 제품이 정상적으로 동작하지 않는 경우 고객센터로 연락 주시기 바랍니다.
AFTER
- [시작] 버튼을 누르세요. 약 30초 후 화면에 ‘완료’가 표시됩니다.
- 설치를 마친 다음 [기기 등록]을 누르세요. 등록에 실패하면 [다시 시도]를 누르세요.
- 그림 안에는 번호만 넣고, 설명은 본문에 텍스트로 쓴다.
- 제품이 작동하지 않으면 고객센터로 연락하세요.
작성 기준
- 지시대명사(‘이것’, ‘그것’, ‘해당’) 대신 대상의 이름을 그대로 반복한다. 그렇지 않으면 번역가는 무엇을 가리키는지 추측을 해야 한다
- 한국어에서 습관적으로 생략하는 주어와 목적어를 절차 문장에서는 살린다
- 한 문장 한 행동 원칙을 지킨다. 한 문장에 두 행동이 섞이면 언어마다 다르게 갈라진다
- 하나의 개념에는 하나의 용어만 쓴다. 표기가 흔들리면 번역 메모리가 재사용되지 않고 언어 수만큼 비용이 늘어난다
- 그림 안에 글자를 넣지 않는다. 글자를 넣으면 언어 수만큼 그림을 다시 만들어야 한다
- 관용구, 속담, 문화 의존 표현, 말장난을 쓰지 않는다
- 레이아웃에 여백을 둔다. 독일어와 러시아어는 같은 내용이 한국어보다 30% 이상 길어진다
- 조건문은 ‘만약 ~라면, ~하세요’ 순서로 고정한다
같은 문장을 반복해서 쓰면 번역은 한 번만 하면 됩니다
공통 문장을 등록하고 모든 매뉴얼이 같은 문장을 쓰면, 그 문장은 언어당 한 번만 번역됩니다. 여러 언어로 확장하는 기업에서는 이 원칙 하나가 번역 비용 전체를 좌우합니다. 문장을 자산으로 관리하는 일은 국내 매뉴얼 품질 개선인 동시에 글로벌 출시 준비입니다.
기준을 사람 손으로 지킬 수 있는 한계
여기까지 다룬 7가지 기준은 그 자체로 어려운 내용이 아니고 문서 한 건에 적용하는 일은 누구나 할 수 있습니다. 문제는 규모입니다.
제품 20종, 매뉴얼 100페이지, 12개 언어, 작성자 3명. 이 조건에서 용어 하나가 흔들렸는지, 금지 표현이 남았는지, 한 문장에 행동이 두 개 들어갔는지를 사람의 눈으로 전수 검사할 수는 없습니다. 개정이 반복될수록 편차는 다시 벌어집니다. 기준을 문서로 만들어 배포하는 것만으로는 품질이 유지되지 않는 이유가 여기 있습니다.
해법은 기준을 기계가 판정하게 만드는 것입니다. 아래 항목은 사람이 아니라 도구가 검출해야 하는 항목입니다.
사람의 검수로 지켜지는가
- 용어 표기 불일치
문서 1건은 가능. 문서 수십 건과 12개 언어에서는 불가능 - 금지 표현 잔존
검수자마다 다르게 판단. 자동 검출이 정확 - 복합 지시문(한 문장 두 행동)
긴 문서에서 반드시 누락 발생 - 화면 문구와 매뉴얼 문구 불일치
UI가 바뀔 때마다 전수 대조는 사실상 불가능 - 공통 문장 미사용
사람은 비슷한 문장이 이미 있는지 기억하지 못함 - 문장 길이 초과, 스텝 분량 초과
기계가 즉시 판정 가능 - 번역 메모리 재사용 저하
원문 표기 흔들림을 사람이 추적할 수 없음
한샘글로벌의 접근
한샘글로벌은 1990년 설립된 한국 최초의 테크니컬라이팅 전문 기업으로, 매뉴얼 개발과 100개 이상 언어의 현지화를 수행하고 있습니다. 매뉴얼 개발 프로세스에 특화된 ISO 9001을 비롯해 ISO 17100, ISO 18587, ISO 27001 인증을 보유하고 있으며, 2026년 CSA Research가 발표한 글로벌 언어·콘텐츠 서비스 기업 순위에서 37위에 올랐습니다. 이 기준을 문서로 배포하는 데 그치지 않고, 60여 종의 자동 QA 도구로 기준 준수 여부를 기계가 판정하게 만듭니다.
- 언어 기준과 용어집을 고객사 제품군에 맞게 설계한다
- 공통 문장을 자산으로 등록해 매뉴얼, 카드뉴스, 영상, FAQ, 챗봇이 같은 문장을 쓰게 한다
- 자동 QA 도구로 용어 불일치, 금지 표현, 복합 지시문, 화면 문구 불일치를 발행 전에 검출한다