기술문서, 사용설명서, 제품 매뉴얼을 영문으로 작성하거나 번역할 때는 문법적 정확성만으로 충분하지 않습니다. 사용자가 이해하기 쉬운 문장, 일관된 용어와 사용자 인터페이스 문구, 재사용 가능한 문장 패턴, 명확한 안전·절차 구조를 갖춰야 번역과 다국어 제작 과정에서도 품질과 효율을 유지할 수 있습니다. 이 가이드는 이러한 기준을 제조사 문서팀이 바로 적용할 수 있도록 정리한 실무 자료입니다.
이 가이드의 목적과 활용 방법
이 가이드는 영문 기술문서와 제품 매뉴얼을 작성·번역하는 문서팀이 공통 기준으로 활용할 수 있도록 구성했습니다. 일반 영어 문법을 설명하는 자료가 아니라, 사용자가 이해하기 쉽고 내부적으로 일관되며 제품 파생과 다국어 현지화에 재사용하기 좋은 제품 문서를 만드는 데 초점을 둡니다.
기술문서, 사용설명서, 제품 매뉴얼을 처음부터 영어로 작성하는 경우에는 원문 작성 기준으로 사용할 수 있습니다. 국문 기술문서나 사용설명서를 영어로 번역하는 경우에는 번역 전에 원문의 모호성, 용어, 절차 순서를 정리하고, 번역된 영문이 같은 기준을 충족하는지 검토하는 지침으로 활용할 수 있습니다.
목차
왜 영문 원문 품질이 중요한가
제품 매뉴얼은 한 국가와 한 번의 출시를 위해 만드는 정적인 책자가 아닙니다. 하나의 영문 기술문서·매뉴얼·사용설명서는 여러 모델과 시장에 재사용되고, 웹 도움말로 변환되며, 사용자 인터페이스(UI) 문구와 정합성을 맞추고, 콘텐츠 관리 시스템(CMS)과 번역 메모리(TM)에 축적될 수 있습니다. 필요에 따라 기계번역(MT)이나 자동 번역 보조 도구를 거친 뒤 전문 번역가와 리뷰어가 검토할 수도 있습니다.
따라서 영문 원문의 품질은 문장 표현만의 문제가 아니라 매뉴얼 제작과 번역 전체의 효율과 위험 관리에 영향을 줍니다. 모호하고 일관되지 않은 원문은 번역 질의, 리뷰 반복, 용어 충돌, 번역 메모리 분절, 오역, 고객 문의와 서비스 지원 업무를 늘립니다. 반대로 명확하고 일관된 원문은 다국어 제작의 재사용률을 높이고 후속 공정의 수정 비용을 줄입니다.
영문 제품 문서의 네 가지 기본 원칙
- 사용자에게 명확함: 사용자가 무엇을 해야 하는지, 언제 해야 하는지, 어떤 결과를 기대해야 하는지 이해할 수 있어야 합니다.
- 문서 전반에서 일관됨: 작성자, 검토자, 개발자, 현지화 담당자 등 모든 관계자가 동일한 용어와 문장 패턴을 사용해야 합니다.
- 번역하기 쉬움: 번역가나 번역 도구가 숨은 의미를 추론하지 않아도 되도록 대상, 조건, 동작을 분명하게 구조화해야 합니다.
- 후속 문서에 재사용 가능함: 반복되는 동작과 경고는 같은 문장 패턴으로 작성하여 다른 모델이나 버전의 문서에서도 기존 콘텐츠와 번역 메모리를 쉽게 재사용할 수 있도록 해야 합니다.
사용자와 문서 목적을 먼저 정의하기
작성 전에 누가 이 문서를 사용하고 어떤 작업을 수행해야 하는지 먼저 정의합니다. 사용자 역할과 문서 목적이 다르면 필요한 정보의 범위와 설명 수준도 달라집니다. 설치, 사용, 유지보수, 서비스 등 목적이 다른 절차와 정보는 필요에 따라 구분하여 구성합니다. 또한 안전하고 정확하게 따라야 하는 지침에 마케팅 문구를 혼합하지 않습니다.
라이팅 예시
- 수정 전 The system can be commissioned after the appropriate team completes the internal validation process and confirms that the unit is ready.
- 수정 후 Before commissioning the system, verify that the unit has passed validation and is ready for operation.
설명: 수정 전 문장에는 다른 역할의 작업 절차가 포함되어 있습니다. 수정 후에는 해당 사용자가 확인할 조건과 수행할 동작만 명확하게 제시합니다.
- 사용자 역할을 명확히 합니다: 일반 사용자, 운영자, 설치자, 서비스 기술자, 관리자, 의료진, 보호자 등.
- 가능하면 하나의 문서는 하나의 주요 사용자층에 초점을 맞춥니다.
- 위험과 사용자 역할이 다른 경우 설정, 사용, 유지보수, 문제 해결, 서비스 콘텐츠를 구분합니다.
- 사용자, 딜러, 유통 파트너 또는 번역가가 이해하기 어려운 내부 프로젝트 용어는 사용하지 않습니다.
- 절차를 시작하기 전에 필요한 조건과 선행 작업을 명시합니다.
짧고 직접적이며 구조화된 문장 쓰기
짧은 문장은 모호성을 줄이고 번역과 검토를 쉽게 만듭니다. 지시문은 한 문장에 하나의 주요 동작이나 핵심 내용을 담고 가능한 짧게 작성합니다. 문장이 20단어를 넘으면 여러 조건이나 동작이 한 문장에 포함되어 있지 않은지 확인하고, 필요한 경우 문장을 나누거나 단계로 구분합니다.
라이팅 예시
- 수정 전 After the operator installs the filter and checks that the cover is securely attached, the system can be restarted by pressing the Start button for three seconds.
- 수정 후 1. Install the filter.
2. Make sure the cover is securely attached.
3. Press and hold Start for 3 seconds to restart the system.
설명: 긴 조건문을 사용자가 따라갈 수 있는 순서가 있는 단계로 나눕니다.
- 한 문장에는 하나의 주요 아이디어 또는 하나의 주요 동작만 담습니다.
- 긴 절차는 긴 문단보다 번호가 있는 단계로 나눕니다.
- 의미를 더하지 않는 “in order to,” “it is important to,” “make sure to” 같은 군더더기 표현은 제거합니다.
- 지시 대상이 불분명한 “it,” “this,” “they” 같은 대명사는 피합니다.
- 절차에서는 능동적이고 직접적인 문장을 사용합니다.
조건·위치·시점을 동작보다 먼저 제시하기
단계가 특정 화면, 조건, 위치 또는 시점에 따라 달라지는 경우 그 맥락을 동작보다 먼저 제시합니다. 사용자는 먼저 해당 지침이 자신의 상황에 적용되는지 판단한 다음 동작을 수행할 수 있습니다.
라이팅 예시
- 수정 전 Tap Reset on the Maintenance screen.
- 수정 후 On the Maintenance screen, tap Reset.
설명: 위치 정보가 동작 수행에 필요한 경우 위치를 먼저 제시합니다.
- 수정 전 Tighten the bolts after installing the bracket.
- 수정 후 After installing the bracket, tighten the bolts.
설명: 순서가 중요한 경우 시점이나 선행 조건을 동작보다 먼저 제시합니다.
중립적이고 도움이 되는 어조 사용하기
제품 매뉴얼은 전문적이고 직접적이며 도움이 되는 어조를 사용해야 합니다. 지나치게 친근하거나 감정적, 홍보성, 비난조로 들리지 않아야 합니다. 사용설명서는 오류, 안전 상황, 고객 지원 상황에서 사용되는 경우가 많기 때문에 어조도 정보 품질의 일부입니다.
라이팅 예시
- 수정 전 You did not close the cover correctly.
- 수정 후 The cover is not closed.
설명: 사용자를 비난하지 말고 현재 상태를 설명합니다.
- 문서의 규칙상 직접 호칭이 허용되는 경우 “you”를 사용할 수 있습니다.
- 오류를 설명할 때 사용자를 탓하기보다 상태를 중립적으로 설명합니다.
- 관용어, 농담, 속어, 문화권에 따라 해석이 달라지는 표현을 피합니다.
- “please”는 제한적으로 사용합니다. 모든 지시문에 반복하지 않습니다.
- 일반 절차나 경고에서 느낌표를 사용하지 않습니다.
동작 동사를 일관되게 사용하기
동작 동사는 사용자가 제품과 어떻게 상호작용해야 하는지를 정확히 알려 줍니다. 물리적 동작과 디지털 동작에 맞는 동사를 선택하고, 매뉴얼, 사용자 인터페이스, 빠른 시작 안내서, 문제 해결 콘텐츠 전반에 일관되게 적용합니다.
| 동사 | 사용 대상 | 영문 예문 |
|---|---|---|
| Press | 물리적 버튼, 스위치, 키 | Press the Power button. |
| Tap | 터치스크린 동작 | Tap Start. |
| Click | 마우스 동작 | Click Browse. |
| Select | 목록, 메뉴, 옵션에서 선택 | Select Manual mode. |
| Enter | 텍스트, 숫자, 값 입력 | Enter the serial number. |
| Remove | 부품 또는 항목 분리 | Remove the cover. |
| Install | 부품, 구성품, 소프트웨어 설치 | Install the filter. |
| Attach | 한 항목을 다른 항목에 부착 | Attach the hose to the inlet. |
| Disconnect | 케이블, 호스, 전원 연결 분리 | Disconnect the power cord. |
라이팅 예시
- 수정 전 Click the emergency stop button.
- 수정 후 Press the Emergency Stop button.
설명: 물리적 버튼이나 스위치에는 “Press”를 사용합니다.
용어와 사용자 인터페이스(UI) 문구 일치시키기
마케팅 문구에서는 표현의 다양성이 자연스러울 수 있지만 기술문서와 매뉴얼에서는 같은 개념을 여러 표현으로 바꾸어 쓰는 것이 위험을 만듭니다. 동일한 부품, 화면, 기능, 경고 수준, 측정 단위, 절차명에는 같은 용어를 반복해서 사용합니다.
라이팅 예시
- 수정 전 On the settings screen, tap the save option.
- 수정 후 On the System Settings screen, tap Save Settings.
설명: 매뉴얼에서 사용하는 화면명과 버튼명은 실제 UI 문구와 정확히 일치시킵니다.
- 작성 또는 번역을 시작하기 전에 표준 용어 목록을 만듭니다.
- 화면, 메뉴, 버튼, 필드, 옵션을 설명할 때 실제 UI 문구를 정확히 사용합니다.
- UI가 함께 변경되지 않는다면 매뉴얼에서 UI 문구를 임의로 바꾸어 쓰지 않습니다.
- 문서 규칙에서 정한 경우 UI 요소는 굵게 표시하는 등 일관된 서식을 사용합니다.
- UI 문구가 불명확하거나 잘못되어 있으면 매뉴얼에서만 수정하지 말고 원문 오류로 보고합니다.
번역 메모리와 콘텐츠 재사용을 고려해 쓰기
제조사는 모델, 시장, 옵션, 펌웨어 버전이 달라지거나 제품이 새로 출시될 때마다 매뉴얼을 반복적으로 업데이트합니다. 의미가 같아도 영문 문장이 조금씩 달라지면 번역 메모리(TM)의 재사용률이 낮아질 수 있습니다. 반복되는 의미에는 같은 문장 패턴을 사용하여 승인 번역의 재사용과 리뷰 효율을 높입니다.
라이팅 예시
- 수정 전 Tighten the screw until it is secure.
Fasten the screws firmly.
Securely tighten each screw. - 수정 후 Tighten the screws.
설명: 같은 동작에는 하나의 표준화된 문장 패턴을 사용합니다.
- 반복되는 동작에는 반복 가능한 문장 패턴을 사용합니다.
- 모델이 다르다는 이유만으로 동일한 지침을 다른 표현으로 다시 쓰지 않습니다.
- 모델명, 수치 등 변경되는 정보는 쉽게 식별할 수 있도록 관리합니다.
- 문장 중간의 불필요한 줄바꿈이 번역 단위를 깨지 않도록 주의합니다.
- 승인된 번역 변경 사항이 원문, 용어집, 스타일 가이드에 다시 반영되도록 관리합니다.
번역과 다국어 제작에 적합한 원문 만들기
번역 방식이 무엇이든 원문이 모호하면 정확한 결과를 얻기 어렵습니다. 사람이 번역하든 자동화된 번역 도구를 사용하든, 대상과 조건이 명확하고 반복 가능한 문장 구조를 갖추는 것이 우선입니다.
라이팅 예시
- 수정 전 If it does not work after doing this, check it again and try to run it.
- 수정 후 If the motor does not start, check the power connection. Then, press Start again.
설명: 번역가와 리뷰어가 의미를 추론하지 않아도 되도록 대상, 상태, 동작을 구체적으로 명시합니다.
- 안전 및 절차상 중요한 콘텐츠에는 통제되고 반복 가능한 표현을 사용합니다.
- 대상이 불분명한 “it,” “this,” “the above” 같은 숨은 참조를 피합니다.
- 경고, 참고, 결과, 동작을 가능한 한 분리된 정보 단위로 작성합니다.
- 하나의 문장에 여러 조건과 여러 동작을 결합하지 않습니다.
- 번역가와 리뷰어가 공통으로 사용할 수 있는 표준용어집을 제공합니다.
- 안전, 법률, 규제, 고위험 기술 콘텐츠는 반드시 사람이 검토합니다.
안전 정보와 절차 분리하기
안전 정보는 눈에 잘 띄고 모호하지 않아야 합니다. 위험 정보를 긴 절차 문장 속에 묻지 않습니다. 경고, 주의, 참고 정보는 사용자가 필요한 위치에서 확인할 수 있도록 배치하고, 신호어(signal word), 위험요인, 예상 결과, 회피 방법이 명확하도록 작성합니다.
라이팅 예시
- 수정 전 Remove the cover after turning off the machine because the internal parts may be hot and could cause burns.
- 수정 후 WARNING
Hot parts can cause burns.
Turn off the machine and wait 30 minutes before removing the cover.
설명: 위험과 행동을 분리하고, 위해를 피하는 방법을 명확히 제시합니다.
- 안전 경고와 마케팅 주장을 한 문장이나 한 블록에 섞지 않습니다.
- 경고를 일반 참고문이나 본문 안에 숨기지 않습니다.
- 제품 라벨, UI 메시지, 빠른 시작 안내서, 매뉴얼의 안전 문구가 서로 정합성을 유지하도록 합니다.
- 규제 대상 제품은 출시 전에 적용 가능한 표준, 규제 요구사항, 필수 경고 문구를 확인합니다.
미국식·영국식 영어 중 하나를 정해 유지하기
글로벌 제품 문서에서는 미국식 영어(US English) 또는 영국식 영어(UK English)처럼 사용할 영어 표기 규칙을 명확히 정하고 일관되게 적용합니다. 여러 규칙을 섞어 쓰지 않습니다. 국문에서 영문으로 번역하는 경우에도 번역 시작 전에 목표 영어 규칙을 정합니다.
미국식 영어: color, center, check the checkbox, program
영국식 영어: colour, centre, tick the tickbox, programme (소프트웨어 의미가 아닌 경우)
설명: 제품 전략, 규제 환경, 고객 요구에 따라 한 가지 기준을 선택하고 문서 전체에 일관되게 적용합니다.
서식·구두점·숫자 표기 규칙 정하기
서식 규칙은 가독성과 번역·유지관리를 지원해야 합니다. 장식적인 서식을 늘리는 것이 아니라, 기술문서와 사용설명서의 정보를 빠르게 찾고 일관되게 처리할 수 있도록 만드는 것이 목적입니다.
제목: 내용을 설명하는 제목을 사용합니다. “Installing the filter”, “Calibrating the sensor”처럼 작업 중심 제목을 우선합니다.
UI 요소: 화면명, 버튼, 메뉴, 필드, 옵션의 서식 규칙을 문서 전체에 일관되게 적용합니다.
약어: 약어 자체가 전체 명칭보다 더 익숙한 경우를 제외하고, 처음 사용할 때 전체 명칭을 먼저 쓰고 괄호 안에 약어를 제시합니다.
글머리표와 절차: 병렬 항목은 글머리표, 순서가 있는 동작은 번호가 있는 단계로 구성합니다.
구두점: 절차문에서는 세미콜론을 피하고 문장을 나눕니다. 느낌표는 UI 규칙상 필요한 경우에만 사용합니다.
숫자와 단위: 숫자, 단위, 허용오차, 토크값, 범위, 환산값을 일관된 형식으로 작성합니다. 번역 전에 값과 환산을 검증합니다. 수치 오류는 안전, 규제 준수, 제품 품질, 서비스 정확도에 영향을 줄 수 있습니다.
파일명과 확장자: 작업에 필요한 경우에만 정확한 파일명과 확장자를 명시합니다.
번역 전에 원문 검토하기
번역 전에 영문 원문 또는 번역 대상 원문을 검토하는 것은 다국어 재작업을 줄이는 가장 효과적인 방법 중 하나입니다. 같은 원문 문제가 여러 언어로 확산된 뒤 수정하지 말고 번역 전에 확인합니다.
- 사용자, 문서 범위, 문서 구조를 검토합니다.
- 문장 명확성, 단계 순서, 경고 위치를 확인합니다.
- 용어, UI 문구, 제품명, 측정 단위를 확인합니다.
- 반복되는 지침을 표준화하여 번역 메모리 재사용성을 높입니다.
- 안전, 법률, 규제, 고위험 기술 콘텐츠의 검토 책임자를 정합니다.
- 릴리스가 끝날 때마다 스타일 가이드, 용어집, 재사용 콘텐츠를 업데이트합니다.
영문 문장 개선 예시
아래 예시는 영문 기술문서와 제품 매뉴얼에서 자주 나타나는 문제를 어떤 방향으로 개선할 수 있는지 보여 줍니다.
라이팅 예시
- 수정 전 Press the emergency stop button located on the right side of the control panel in order to immediately stop all machine operations when an abnormal condition occurs.
- 수정 후 To stop the machine in an emergency, press the Emergency Stop button on the control panel.
설명: 목적을 먼저 제시한 뒤 동작을 안내합니다. 실제 제어장치 명칭을 사용하고, 사용자의 안전한 동작에 필요하지 않은 위치·조건 정보는 줄입니다.
- 수정 전 When the measurement seems to be wrong because the sensor was not attached well, attach it again and measure the patient one more time.
- 수정 후 If the measurement is inaccurate, reattach the sensor. Then, measure the patient again.
설명: 문제와 수정 동작을 구체적으로 명시합니다. 모호한 원인 설명을 피하고 반복 가능한 동작 순서를 사용합니다.
- 수정 전 It is recommended that the user should clean the filter regularly so that the product can continue to perform well.
- 수정 후 Clean the filter regularly to maintain product performance.
설명: 직접적인 지시문을 사용하고, 사용자 이점은 동작을 이해하는 데 필요한 경우에만 설명합니다.
- 수정 전 Before making the robot move, check that there are no people or objects around it because it can cause damage if it moves suddenly.
- 수정 후 Before operating the robot, make sure the operating area is clear. Unexpected movement can cause injury or damage.
설명: 안전 조건은 사용자가 확인할 수 있는 상태로 표현하고, 위험 결과를 명확히 합니다.
- 수정 전 If this fails because the network is not good, check it and do it again.
- 수정 후 If the upload fails, check the network connection. Then, upload the file again.
설명: 실패한 동작, 확인할 조건, 다시 수행할 동작을 명확히 제시합니다. “this,” “it,” “do it again” 같은 모호한 참조를 피합니다.
부록. 참고 자료
아래 공개 자료를 참고하여 기존 내부 스타일 가이드를 현재의 기술문서 작성, 글로벌 콘텐츠, 명확한 언어 사용 원칙과 맞도록 정리했습니다. 아래 자료는 고객사별 요구사항이나 적용 규제·표준을 대체하지 않습니다.
- Microsoft Writing Style Guide — Writing tips for global content 포함
- Google Developer Documentation Style Guide – Write for a global audience 포함
- Apple Style Guide
- ISO 24495-1:2023, Plain language — Part 1: Governing principles and guidelines
- IEC/IEEE 82079-1:2019, Preparation of information for use (instructions for use) of products — Part 1: Principles and general requirements