기술문서, 사용설명서, 제품 매뉴얼의 영문 문장과 표현이 명확하고 일관되게 작성되었는지 점검하기 위한 실무 체크리스트입니다. 영문 문서를 직접 작성하는 경우뿐 아니라 국문 문서를 영어로 번역하는 경우에도 활용할 수 있으며, 용어와 사용자 인터페이스(UI) 문구, 문장 구조, 동작 표현, 안전정보, 번역·현지화 준비도를 중심으로 확인합니다.
체크리스트 사용 방법
이 체크리스트는 기술문서·매뉴얼·사용설명서를 영문으로 작성하거나 또는 번역한 뒤 내용의 명확성, 표현과 용어의 일관성, 사용자 이해도와 번역·현지화 준비도를 점검할 때 사용합니다. 영문 원문 승인 전, 현지화 이관 전, 첫 다국어 검토 후에 활용하는 것이 좋습니다.
영문 문서를 직접 작성한 경우에는 최종 영문 원문을 점검합니다. 국문 문서를 영어로 번역하는 경우에는 번역 전에 국문 원문의 모호한 표현, 용어, 절차 순서를 먼저 확인하고, 번역 후 영문을 다시 점검합니다. 반복되는 문제가 발견되면 승인 용어집, 작성 스타일 가이드, 번역 메모리(TM)에 반영합니다.
각 항목에서 “예”, “아니요”, “해당 없음” 중 하나를 표시합니다. “아니요”가 나온 항목은 번역·현지화나 다국어 제작을 시작하기 전에 수정 항목으로 기록하고, 담당자와 완료 기한을 정합니다.
사용자와 콘텐츠 범위
| 번호 | 점검 항목 | 예 | 아니요 | 해당 없음 |
|---|---|---|---|---|
| 1 | 매뉴얼이 대상 독자, 실제 사용자 역할에 맞게 작성되어 있다. | ☐ | ☐ | ☐ |
| 2 | 서로 다른 사용자 역할(일반 사용자, 설치자, 서비스 기술자 등)을 위한 내용이 포함된 경우, 대상 독자별 정보와 작업 범위가 명확하게 구분되어 있다.. | ☐ | ☐ | ☐ |
| 3 | 문서 목적이 명확하다: 설치, 운전, 유지보수, 서비스, 문제 해결, 사용설명서(IFU) 등. | ☐ | ☐ | ☐ |
| 4 | 마케팅 표현이 지시문, 경고, 문제 해결 내용과 분리되어 있다. | ☐ | ☐ | ☐ |
| 5 | 절차 시작 전에 선행 조건, 필요한 도구, 접근 권한, 필요한 상태가 명시되어 있다. | ☐ | ☐ | ☐ |
| 6 | 안전정보가 쉽게 찾을 수 있는 위치에 있으며, 신호어·위험요인·예상 결과·회피 방법이 명확하게 구분되어 있다. | ☐ | ☐ | ☐ |
문장 명확성과 절차 구조
| 번호 | 점검 항목 | 예 | 아니요 | 해당 없음 |
|---|---|---|---|---|
| 7 | 대부분의 지시문이 짧고 능동적이며 직접적으로 작성되어 있다. | ☐ | ☐ | ☐ |
| 8 | 한 문장에 하나의 주요 아이디어 또는 하나의 주요 동작만 들어 있다. | ☐ | ☐ | ☐ |
| 9 | 긴 절차는 빽빽한 문단보다 번호가 있는 단계로 구성되어 있다. | ☐ | ☐ | ☐ |
| 10 | 필요한 경우 조건, 위치, 시점이 동작보다 먼저 제시되어 있다. | ☐ | ☐ | ☐ |
| 11 | “it”, “this”, “they”처럼 대상이 모호할 수 있는 대명사가 명확하게 정리되어 있다. | ☐ | ☐ | ☐ |
용어와 사용자 인터페이스 정합성
| 번호 | 점검 항목 | 예 | 아니요 | 해당 없음 |
|---|---|---|---|---|
| 12 | 같은 부품, 기능, 화면, 경고 수준에 같은 용어가 사용되어 있다. | ☐ | ☐ | ☐ |
| 13 | 승인된 제품명, 모델명, 기능명과 수치·단위가 일관되게 사용되어 있으며 기호, 소수점, 허용오차, 범위, 환산값도 확인되어 있다. | ☐ | ☐ | ☐ |
| 14 | 매뉴얼의 화면명·버튼명·표시 문구가 실제 사용자 인터페이스(UI)와 정확히 일치하며, 불일치는 임의로 바꾸지 않고 확인·보고되어 있다. | ☐ | ☐ | ☐ |
| 15 | 버튼, 메뉴, 입력란, 선택 항목에 일관된 서식 규칙이 적용되어 있다. | ☐ | ☐ | ☐ |
| 16 | 필요한 경우 약어와 축약어가 처음 나올 때 정의되어 있다. | ☐ | ☐ | ☐ |
동작 동사와 사용자 조작
| 번호 | 점검 항목 | 예 | 아니요 | 해당 없음 |
|---|---|---|---|---|
| 17 | 물리적 동작에 Press(누르기), Turn(돌리기), Connect(연결하기), Disconnect(분리하기), Install(설치하기), Remove(제거하기) 등 적절한 동사가 사용되어 있다. | ☐ | ☐ | ☐ |
| 18 | 디지털 동작에 Tap(누르기), Click(클릭하기), Select(선택하기), Enter(입력하기), Drag(끌기) 등 적절한 동사가 사용되어 있다. | ☐ | ☐ | ☐ |
| 19 | 미국식 영어(US English) 또는 영국식 영어(UK English) 중 선택한 표기 규칙이 문서 전체에 일관되게 적용되어 있다. | ☐ | ☐ | ☐ |
| 20 | 반복되는 절차에 일관된 문장 패턴이 사용되어 있다. | ☐ | ☐ | ☐ |
| 21 | 오류·안내 문구가 사용자를 비난하지 않고 중립적으로 상태와 필요한 조치를 설명한다. | ☐ | ☐ | ☐ |
현지화와 번역 메모리 준비도
| 번호 | 점검 항목 | 예 | 아니요 | 해당 없음 |
|---|---|---|---|---|
| 22 | 관용어, 속어, 유머, 문화권에 따라 해석이 달라지는 표현이 제거되어 있다. | ☐ | ☐ | ☐ |
| 23 | 불필요한 군더더기와 중복 표현이 제거되어 있다. | ☐ | ☐ | ☐ |
| 24 | 반복되는 지침이 표준화되어 번역 메모리(TM)의 재사용성을 높일 수 있다. | ☐ | ☐ | ☐ |
| 25 | 모델명, 치수, 단위, 수치 등 변경 가능한 정보가 쉽게 식별되도록 되어 있다. | ☐ | ☐ | ☐ |
번역·다국어 제작 준비도와 검토
| 번호 | 점검 항목 | 예 | 아니요 | 해당 없음 |
|---|---|---|---|---|
| 26 | 번역가나 자동 번역 도구가 숨은 맥락을 추론하지 않아도 될 만큼 원문의 대상·조건·동작이 명확하다. | ☐ | ☐ | ☐ |
| 27 | 경고, 참고, 결과, 절차 단계가 서로 구분된 정보 단위로 작성되어 있다. | ☐ | ☐ | ☐ |
| 28 | 승인 용어를 번역가와 기계번역(MT) 또는 인공지능(AI) 번역 도구에 제공할 수 있다. | ☐ | ☐ | ☐ |
| 29 | 안전, 법률, 규제, 고위험 기술 콘텐츠에는 번역 방식과 관계없이 사람의 전문 검토가 배정되어 있다. | ☐ | ☐ | ☐ |
| 30 | 검토 후 수정 사항이 원문, 용어집, 작성 스타일 가이드, 번역 메모리(TM)에 다시 반영된다. | ☐ | ☐ | ☐ |
수정이 필요한 문장 예시
아래 예시는 영문 문서에서 자주 나타나는 문제 표현을 보여 줍니다. 수정 전·수정 후 문장을 비교하여 각 점검 원칙이 실제 문장에 어떻게 적용되는지 확인할 수 있습니다. 영문 예문은 비교를 위해 그대로 유지합니다.
라이팅 예시
- 수정 전 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.
적용 원칙: 대상, 조건, 다음 동작을 구체적으로 명시합니다.
- 수정 전 The operator should make sure that the device is completely turned off before replacing the battery.
- 수정 후 Before replacing the battery, make sure the device is turned off.
적용 원칙: 불필요한 단어를 줄이고 조건을 동작보다 먼저 제시합니다.
- 수정 전 Click the emergency stop button.
- 수정 후 Press the Emergency Stop button.
적용 원칙: 물리적 동작과 디지털 동작에 맞는 동사를 사용합니다.
- 수정 전 Replace the filter after checking the pressure.
- 수정 후 If the pressure is below 0.2 MPa, replace the filter.
적용 원칙: 판단 기준이 되는 조건을 명확하게 제시합니다.
- 수정 전 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.
적용 원칙: 위험 정보와 행동을 분리하고, 위해를 피하는 방법을 명확히 제시합니다.
- 수정 전 Attach the hose to the outlet.
Connect the tube to the discharge port. - 수정 후 Connect the hose to the outlet.
적용 원칙: 하나의 개념에는 하나의 승인 용어를 사용합니다.
점검 결과 요약
| 구분 | 점검 결과 |
|---|---|
| 예 | ______ / 30 |
| 아니요 | ______ / 30 |
| 해당 없음 | ______ / 30 |
| 전체 준비도 | □ 현지화 진행 가능 □ 원문 수정 필요 □ 기술 검토 필요 |
점수 해석 가이드
| 점검 결과 | 해석 | 권장 조치 |
|---|---|---|
| 27–30개 “예” | 현지화 진행 가능 | 현지화 이관을 진행합니다. |
| 21–26개 “예” | 원문 정리 권장 | 다국어 배포 전에 “아니요” 항목을 수정합니다. |
| 0–20개 “예” | 원문 수정 필요 | 번역·다국어 제작 전에 원문을 수정합니다. |
| 안전·법률·규제·수치 및 단위 항목에 “아니요” | 별도 기술 검토 필요 | 총점과 관계없이 해당 항목을 검토합니다. |
| “해당 없음”이 5개 초과 | 적용 범위 재확인 | 이 체크리스트가 해당 문서 유형에 적합한지 확인합니다. |
참고: 위 점수 구간은 실무 점검을 위한 기준이며, 규제나 표준에서 정한 합격 기준은 아닙니다.
참고 자료
- 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