brunch

연재 중 챗GPT로 효율적 영어쓰기 02화

라이킷 28 댓글

You can make anything
by writing

C.S.Lewis

계정을 잊어버리셨나요?

by ZeRO Nov 21. 2024

문서타입 - 매뉴얼

ChatGPT로 효율적 영어쓰기

문서 타입의 작성 방법에 대해 설명하기 전에, 앞에서 살짝 설명했던 각 문서 타입에 대해 다루고 있는 포인트에 대해 언급하겠습니다.

생성형 AI를 활용하여 영문작을 할 때는, 최종적으로 생성된 영어 문장이 적절한 구조와 표현으로 작성되었는지 사람이 확인하게 됩니다. 따라서 각 문서 타입의 특징적인 구조와 표현을 명확히 이해하는 것이 중요합니다. 생성형 AI로 번역을 하거나, 첨삭을 하거나, 문장을 생성하더라도 이 두 가지에 대한 이해가 필수적이며 따로 설명합니다.

☞예제

먼저 대상이 되는 문서 타입의 예제을 제시합니다. 구체적으로 어떤 문서인지 실제 예시를 통해 파악해 보세요.

☞ 문서의 주요 요소와 구조

각 문서 타입에는 자주 사용되는 중요한 요소들이 있으며, 그 요소들을 조합하여 작성되는 구조가 존재합니다. 예를 들어, API 레퍼런스의 경우, 먼저 클래스 등의 전체 이미지를 개요로 표시하고, 이후에 메서드 등의 세부사항을 설명합니다. 즉, 개요 ➔ 세부사항의 구조가 일반적입니다. 이러한 습관적인 구조에 따라 작성되어 있으면, 독자는 문서에서 혼동하지 않고 필요한 정보를 얻을 수 있습니다.

☞ 표현의 포인트

각 문서 타입에는 특징적으로 보이는 표현이 존재합니다. 예를 들어, 매뉴얼에서는 절차를 작성할 때 "Click the OK button."과 같이 Please가 없는 명령형이 사용됩니다. 특정 문서 타입에 일반적으로 사용되는 표현으로 작성되어 있으면, 독자는 이질감을 느끼지 않고 자연스럽게 읽어나갈 수 있습니다. 이러한 포인트를 설명합니다.

☞ 중요한 단어와 표현집

각 문서 타입에는 자주 사용되는 중요한 단어나 표현이 있습니다. 이러한 표현을 라이팅에 적용하면, 읽기에 자연스럽게 느껴지는 영어 문장이 될 것입니다. 여기서는 이러한 단어나 표현을 코퍼스 언어학의 방법으로 대규모 데이터에서 추출하여 설명합니다.

이번에는 사용자와 엔지니어가 필요한 정보를 참조할 때 사용하는 두 가지 문서 타입을 다룹니다. "매뉴얼"과 "API 레퍼런스"입니다.

⑴ 매뉴얼

매뉴얼은 소프트웨어나 디바이스의 사용법이나 조작 절차를 설명하는 문서입니다. 기업이나 조직에 따라 "가이드"라고도 부르기도 합니다.

매뉴얼 전체 한 권이 아니라 하더라도, 간단한 조작 절차를 설명해야 할 경우가 자주 있습니다. 이는 IT 엔지니어가 작성할 기회가 많은 문서 타입이라고 할 수 있습니다.

① 매뉴얼 샘플

아래의 예제는 가상 디바이스를 생성하는 절차를 설명한 매뉴얼입니다. 문장 중의 ①이나 ② 같은 번호는 이후에 설명할 포인트를 나타냅니다. 예제는 매뉴얼의 문장 구조 전체가 포함되어 있어 다소 길어졌습니다.

예제

참고 번역

제5장 가상 디바이스 관리

사용 중인 컴퓨터에서 시뮬레이션되는 가상 디바이스를 생성, 편집, 삭제할 수 있습니다.

- 가상 디바이스의 종류

- 가상 디바이스 생성

- 가상 디바이스 편집

- 가상 디바이스 삭제

- 가상 디바이스의 종류

가상 디바이스의 종류

여러 가지 종류의 가상 디바이스를 생성할 수 있습니다.

가상 디바이스를 생성할 때는 다음 중 하나를 선택합니다:

- 전화

- 태블릿

- 시계

- TV

가상 디바이스 생성

가상 디바이스를 생성하려면 다음 단계를 실행합니다:

1. 가상 디바이스 매니저를 엽니다.

2. 왼쪽 상단에서 [생성] → [신규 가상 디바이스]를 클릭합니다.

3. 생성하려는 디바이스를 디바이스 목록에서 선택합니다.

4. 기본 이름을 변경하려면, 새 이름을 입력합니다.

주의: 각 가상 디바이스에는 고유한 이름이 필요합니다.

5. [OK]를 클릭합니다.

6. 대시보드에 새로운 가상 디바이스가 표시됩니다.

가상 디바이스 편집

<중략>

가상 디바이스 삭제

<후략>

⑵ 문서의 주요 요소와 구성

먼저, 매뉴얼의 주요 요소와 구성을 살펴보겠습니다.

① 헤드라인(제목) (①, ④, ⑧)

매뉴얼은 소설처럼 처음부터 끝까지 순서대로 읽어 내려가는 것보다, 독자가 필요에 따라 참조하는 경우가 많을 것입니다. 따라서, 필요한 정보를 쉽게 찾을 수 있도록 적절한 헤드라인을 장이나 항목 등의 몇 가지 레벨에서 추가합니다. 예를 들어, ①은 장 전체의 헤드라인입니다. "Manage virtual devices"라고 되어 있어, 가상 디바이스의 관리 방법이 설명되고 있음을 알 수 있습니다. 또한, ④와 ⑧은 장 내에 있는 절 수준의 헤드라인입니다.

④의 "Types of virtual devices"에는 가상 디바이스의 종류가, ⑧의 "Create a virtual device"에는 가상 디바이스의 생성 방법이 설명되어 있습니다.

② 목차 (③)

이러한 헤드라인은 참조하기 쉽게 목차 형식으로 요약됩니다. ③은 장 내부의 여러 절 수준의 헤드라인을 목차로서 요약하고 있습니다. 가상 디바이스의 종류(Types), 생성(Create), 편집(Edit), 삭제(Delete) 등 4가지가 설명되어 있는 것을 쉽게 파악할 수 있습니다. 목차는 매뉴얼이 인쇄물이라면 서두에 배치되며, 웹 형식이라면 좌측 또는 우측 패인에 표시되거나 ③처럼 페이지의 첫 부분에 배치됩니다.

③ 도입문 (⑨)

헤드라인 다음에 절차의 도입문이 작성될 수 있습니다. ⑨이 이에 해당합니다. "가상 디바이스를 생성하려면, 다음의 스텝을 실행하세요"와 같이, 이어지는 절차가 무엇인지 설명하고 있습니다.

④ 절차와 스텝 (⑩)

도입문 다음에 절차의 내용이 작성됩니다. ⑩처럼 일반적으로 숫자가 서두에 있는 번호 매기기 목록으로 작성됩니다. 절차의 각 항목은 스텝이라 불립니다. 일반적으로 절차는 여러 스텝으로 구성됩니다.

⑤ 설명문 (⑤)

절차가 아닌 개념을 설명하는 항목이 배치될 수 있습니다. 이 경우, 절차가 아닌 설명문이 기록됩니다. 예를 들어 ⑤에서는 절차가 아닌 다양한 종류의 가상 디바이스를 생성할 수 있음을 설명하고 있습니다.

⑥ 주의사항 (⑬)

절차 중간이나 앞뒤에 주의사항이 추가될 수 있습니다. 주의가 필요한 경우, 필요에 따라 주의사항이 포함됩니다.

⑦ 주요 요소와 구조

매뉴얼의 주요 요소를 요약하면 다음과 같습니다.

헤드라인

목차 (페이지 내에서는 선택 사항)

도입문

절차

스텝

설명문

주의사항 (선택 사항)

구조를 도식화하면, 아래 그림과 같이 나타납니다. 이 구조는 하나의 장을 상정하고 있습니다. 다양한 위치에 선택적으로 배치할 수 있는 주의사항은 생략되어 있습니다.

참고로, 이 도식은 Railroad 도식이라고 불리며, 정규 표현식이나 JSON 등의 기술 문서에도 사용됩니다. 간단히 읽는 방법을 설명합니다.

선을 따라 왼쪽에서 오른쪽으로 항목을 읽기

선택 항목: 항목이 없는 선이 분기되는 경우 (예: "목차" 부분)

선택 항목: 선이 여러 개로 분기되는 경우 (예: 도입문과 설명문의 앞부분)

반복 항목: 선이 앞부분으로 되돌아오는 경우 (예: "설명문" 부분)

점선: 하나의 요약과 그 설명

⑶ 표현 포인트

매뉴얼에 사용되는 표현의 포인트는 다음과 같습니다.

① 독자는 you, 독자의 소유물은 your

매뉴얼의 독자는 "you"로 지시합니다. 예를 들어, 예제의 ②에는 "You can create..."라고 되어 있습니다. "A user can create..."로도 동일한 정보를 전달할 수 있지만, you를 사용하면 상대에게 직접 말을 거는 분위기를 전달할 수 있습니다.

또한, 독자의 소유물에는 "your"를 사용합니다. ⑮의 "in your dashboard"가 그 예입니다.

② 헤드라인은 작업형이라면 동사 원형

매뉴얼은 주로 조작 절차를 설명하기 때문에, 독자는 몇 가지 작업을 수행하게 됩니다. 기술 내용이 작업형일 경우, 기본적으로 견출지에는 동사를 사용합니다. 작업은 동사로 효과적으로 표현할 수 있기 때문입니다. 예를 들어, 예제의 ⑧에 있는 헤드라인에는 "Create a virtual device"라고 있으며, create(생성하다)라는 동사가 원형으로 사용됩니다. 동사가 ing형(Creating a virtual device)으로 사용되기도 하지만, 주요 IT 기업의 사례를 보면 현재는 간단히 원형을 사용하는 경우가 많습니다. 따라서, 헷갈릴 때는 원형으로 통일할 것을 권장합니다.

한편, 헤드라인이 작업형이 아니라 개념을 설명하는 개념형일 경우, 동사가 아닌 명사나 명사구를 사용합니다. ④의 "Types of virtual devices"가 이에 해당합니다. 이 외에도 "App overview"(앱의 개요)나 "Requirements"(요건) 같은 헤드라인이 그 예입니다.

참고로, 헤드라인 스타일에는 "센텐스 스타일"이 자주 사용됩니다. 센텐스 스타일에 대해서는 따로 설명합니다.

③ 도입문에는 following과 콜론

도입문은 뒤이어 나오는 절차나 리스트가 무엇인지 쉽게 이해할 수 있도록 작성됩니다. 이때 following이나 follow가 자주 사용됩니다. 다음에 설명하는 것처럼, 형용사, 명사, 동사의 세 가지 품사로 사용할 수 있으므로 주의가 필요합니다. 또한, 도입문 뒤에 절차나 리스트가 오는 경우, 일반적으로 콜론(:)이 놓입니다. 콜론은 리스트를 도입할 때 사용하는 구두점입니다.

☞ following (형용사)

"다음의" 또는 "아래의"라는 형용사입니다. ⑨의 "To create a virtual device, perform the following steps:"에서, steps라는 명사를 수식하고 있습니다. 즉, "다음의 스텝"이라는 의미가 됩니다.

☞ following (명사)

"다음 것들" 또는 "아래의 것들"이라는 명사입니다. ⑥의 "Choose one of the following when you create a virtual device:"가 그 예입니다. 주의해야 할 점은, 명사로 사용되는 following은 단수형으로 쓰이며, 복수형 followings로 하지 않는다는 점입니다. 예를 들어, "one of the following"처럼 표현됩니다. 주요 문서에서도 단수형으로 사용하며, 예를 들어 "The following are examples of URLs."로 작성합니다.

☞ follow (동사)

절차나 리스트 앞에 놓이는 도입문에서는 "as follows:" 형태로 자주 사용됩니다. "다음과 같이" 또는 "아래에 표시한 대로"라는 의미입니다. 예를 들어, "The available options are as follows:"(이용 가능한 옵션은 다음과 같습니다:)라는 문장이 있습니다. 주어가 단수든 복수든 상관없이 "as follows"의 형태를 사용합니다. 참고로, follow에는 "~을 따르다"라는 의미도 있습니다. 예를 들어, "To install the app, follow the steps below:"라는 문장이 그렇습니다. 같은 도입문에서 사용되므로 혼동하지 않도록 주의해 주세요.

이처럼, 절차나 리스트 앞에 놓이는 도입문에서는 following (follow)와 콜론을 조합하여 작성하는 것이 좋습니다.

☞ 절차는 번호 리스트로

이미 언급한 것처럼, 절차에서는 ⑩에 나와 있는 것처럼 번호 리스트를 사용합니다. 스텝 1, 스텝 2 순서로 작업을 진행하는 것입니다. 만약 절차 내에 별도의 절차(하위 절차)를 기술할 경우에는 소문자 알파벳(a, b, c, d…)를 사용할 수 있습니다.

항목의 나열 등, 순서가 관계없는 리스트에서는 ⑦과 같이 중간 점 리스트를 사용합니다.

☞ 지시문은 명령형으로

각 스텝에 작성된 지시문은 명령형을 사용합니다. 예를 들어 ⑩의 "Open the Virtual Device Manager."에서는 동사 open으로 문장이 시작됩니다. 한국어라면 "~해 주세요"와 같이 정중한 지시문이 될 부분이지만, 영어에서는 필요하지 않습니다. please를 생략한 명령형으로 작성합니다.

☞ 지시문에서는 장소, 조건, 목적을 먼저 제시

지시문에서는 장소, 조건, 목적을 먼저 제시합니다. 먼저 제시함으로써 독자에게 다음과 같은 이점이 있습니다.

장소: 어디서 작업해야 하는지를 먼저 파악할 수 있음

예) 예제의 ⑪에서 "At top left, …"

조건: 조건이나 상황에 맞지 않으면 작업을 수행하지 않음

갑자기 명령형으로 시작하면 불필요한 작업을 할 가능성이 있음

예) 예제의 ⑫에서 "If you want to change the default name, …"

목적: 지시가 무엇을 위한 것인지 명확히 이해할 수 있음

예) 예제의 ⑨에서 "To create a virtual device, …"

☞ 지시문에서 UI 요소는 볼드체

소프트웨어 관련 매뉴얼에서는 버튼을 누르거나 메뉴 항목을 선택하는 등 사용자 인터페이스(UI) 상의 요소를 설명하는 경우가 있습니다. 버튼과 같은 UI 요소는 ⑭의 "Click OK."처럼 볼드체로 표시합니다. 여기서 "OK"는 버튼에 표시된 레이블입니다.

한국어에서는 괄호로 표시하는 경우가 많아, 영어에서도 이중 인용부호(" ")나 대괄호([])를 사용하는 경우가 있지만, 주요 IT 기업의 사례를 보면 볼드체로 표시하는 것이 일반적입니다.

☞ 지시문에서 연속 작업은 ">"

무언가를 선택한 후, 다른 항목을 바로 선택하는 작업을 할 수 있습니다. 이러한 연속 작업은 ">"(큰 부호)를 사용합니다. 예제의 ⑪에서 "At top left, click Create > New virtual device."가 그 예입니다. 앞뒤의 UI 요소가 볼드체로 표시되어 있다면, **">"**를 그대로 두고 볼드체로 표기해도 무방합니다.

☞ 주의사항은 Note, Caution, Warning 등

작업 시의 위험을 알리거나 정보를 보충하기 위해 주의사항을 기재할 수 있습니다. 내용에 따라 적절한 견출지를 붙입니다. 예를 들어, 예제 ⑬에 있는 "Note: Each virtual device must have a unique name."가 이에 해당합니다. 헤드라인은 볼드체로 강조한 후 콜론을 붙이고, 그 뒤에 본문을 작성합니다. 콜론의 사용 방법에 대해서는 나중에 설명합니다.

헤드라인의 용어와 그 의미는 조직 내 문서에서 사전에 통일해 두는 것이 좋습니다. 참고로, Google의 개발자용 스타일 가이드에서 사용되는 용어를 아래 표에 소개합니다. 스타일 가이드는 문서의 작성 방식과 표기에 대한 기준을 정리한 것입니다. IT 업계에서는 특정 프로그래밍 언어를 대상으로 한 가이드도 작성되며, 문서와 프로그램 간의 일관성을 유지하여 원활한 커뮤니케이션을 목적으로 합니다.

또한, ISO 및 ANSI 규격에서 정의된 용어도 있습니다. 예를 들어, ISO 3864-2에서는 위험 정도에 따라 [CAUTION] (주의), [WARNING] (경고), [DANGER] (위험)이 정의되어 있습니다. 특히 인체에 위험이 미칠 가능성이 있는 기기나 장비의 매뉴얼을 작성할 때는 이러한 규격을 준수할지도 검토합니다.

⑷ 중요한 단어와 표현집

매뉴얼에서 자주 사용되는 중요한 단어와 표현을 소개합니다. 매뉴얼에서 중심이 되는 작업(UI 작업)의 설명에서는 동사가 중요해지므로, 먼저 자주 사용되는 동사를 다룹니다. 그 후에 "~할 수 있다"를 나타내는 생물 주어 문장 외에도 추측이나 참조 표현을 소개합니다.

① 입력의 동사

먼저, 문자를 입력하는 것과 관련된 동사입니다.

input에도 "입력하다"(타동사)의 의미가 있지만, 동사로 사용되는 경우는 드뭅니다. 사용될 때는 주로 명사로 쓰입니다. 동사의 "입력하다"로는 위의 enter나 type을 사용합시다.

② 선택의 동사

다음은 항목을 선택하는 것과 관련된 동사입니다.

"선택하다"라는 동사에는 choose와 select를 거의 교환하여 사용할 수 있지만, 텍스트나 체크박스의 선택에는 select를 사용합니다. 또한, select의 예2에서처럼 "무언가의 작업 대상(파일 등)을 선택하고, 명령(삭제 등)을 선택"하는 상황을 설명할 때 select와 choose를 조합하여 사용할 수 있으며, 전 단계의 작업 대상 선택에는 select를, 후 단계의 명령 선택에는 choose를 사용합니다.

③ 유효/무효, 온/오프의 동사

유효와 무효, 온과 오프의 전환에 관련된 동사입니다.

표현으로서 enable이나 disable은 다소 딱딱하고, turn on/off는 그보다 더 일상적인 표현에 가까워집니다. 따라서, 독자가 전문가인 경우에는 enable이나 disable을, 일반 사용자라면 turn on/off를 선택해도 좋을 것입니다.

⑤ 체크박스 조작의 동사

UI 요소 중에서도 체크박스(일반적으로 checkbox라고 함)의 조작에 관한 표현은, 영어권에서도 혼동이 많은 듯합니다. 먼저, 체크박스를 선택하거나 선택 해제할 때 사용하는 동사로는 다음과 같은 것들이 있습니다.

선택 및 선택 해제 동사는 모두 실제로 자주 사용됩니다. 따라서, 어떤 것을 선택해도 이질감은 없지만, 문서 내에서는 가급적 통일성을 유지하는 것이 좋습니다. 주요 IT 기업에서는 영어 스타일 가이드를 발행하고 있으며, Google과 Microsoft에서는 "select"와 "clear"를, Apple은 "select"와 "deselect"를 권장하고 있습니다. 이 지침을 참고해도 좋을 것입니다.

⑥ 디바이스 조작

다음은 디바이스 조작에 관련된 동사입니다. 마우스, 물리 키, 터치 화면으로 나누어 설명합니다.

마우스

물리적 키

터치화면

⑦ "할 수 있다"를 표현하는 무생물주어 문장구조

allow, enable, let 등의 동사를 사용하여 무생물 주어의 구조로 "당신은 ○○을 할 수 있습니다"를 표현합니다. 구조는 "<무생물 주어> allow/enable/let you (to) <동사>" 형태로, let에는 to가 없습니다. 다음은 allow와 let의 예시입니다.

예: The Screen Editor allows you to configure an app screen.

(Screen Editor를 사용하면 앱 화면을 구성할 수 있습니다.)

예: This dialog lets you create a project.

(이 대화 상자를 사용하면 프로젝트를 생성할 수 있습니다.)

그러나, "당신은 ○○할 수 있습니다"는 "You can <동사>" 형태가 일반적이며, 주요 IT 기업의 스타일 가이드에서도 이쪽이 권장됩니다. 위의 예시의 경우, 각각 "You can configure an app screen using the Screen Editor."와 "You can create a project using this dialog."로 바꿔 쓸 수 있습니다. 고민될 경우에는 "You can <동사>"를 사용합시다.