1-6. Lists and tables
Google Technical Writing Course - 1
이전까지 문법이나 어휘를 비롯한 문장 그 자체에 집중했다면
이번부터는 보다 시각적인 기술들에 대해 다룬다.
목차는 아래와 같다.
Choose the correct type of list
Technical Writing에서 주로 사용하는 리스트의 종류에는 아래 3가지가 있다.
Bulleted lists
Numbered lists
Embedded lists
bulleted lists와 numbered lists의 차이는 순서가 없느냐, 있느냐다.
즉 bulleted lists는 그 순서를 변경했을 때 의미상 변화가 없으나, numbered lists는 순서를 바꾸면 의미가 달라진다.
embedded list, 또는 run-in list는 한 문장 안에 항목들을 나열한 것으로, 흔히 볼 수 있는 콤마로 연결된 형태이다.
The llamacatcher API enables callers to create and query llamas, analyze alpacas, delete vicunas, and track dromedaries.
당연히 시각적 측면에서 bulleted, numbered lists보다 효과가 떨어질 수 밖에 없고, 위 문장을 아래 예시와 같이 바꾸면 훨씬 한눈에 잘 들어온다.
The llamacatcher API enables callers to do the following:
Create and query llamas.
Analyze alpacas.
Delete vicunas.
Track dromedaries.
Exercise
Today at work, I have to code three unit tests, write a design document, and review Janet's latest document. After work, I have to wash my car without using any water and then dry it without using any towels.
리스트화 한 부분은 동일했으나, 그 앞의 문구가 달랐다.
나는 단순히 원문을 옮겼다면, 모범답안에서는 must를 사용해 길이를 줄였다.
Today at work, I have to do the follow things:
→ (모범답안) I must do the following at work today:
Code three unit tests.
Write a design document.
Review Janet's latest document.
After work, I have to do the follows step by step:
→ (모범답안) After work, I must do the following:
1. Wash my car without using any water.
2. Dry it without using any towels.
Keep list items parallel
어떻게 하면 효과적인 좋은 리스트를 작성할 수 있을까?
그 답은 통일성 - 즉 항목들 간의 일관성을 유지하는 것으로, 아래 요소들을 고려해보아야 한다.
문법(Grammar) : 같은 품사를 사용할 것. (ex: 모두 동사이거나, 모두 명사이거나 등)
범주(Logical category) : 같은 범주의 개념일 것.
대소문자 (Capitalization) : 대소문자 규칙 통일. (ex: 모두 대문자로 시작 혹은 모두 소문자로 시작)
구두점 (Punctuation) : 쉼표, 마침표, 세미콜론 등을 일관되게 사용.
참고로 잘못 작성된 리스트는 위 기준 중 최소 1개 이상을 충족하지 못한다.
또한 독자는 리스트의 첫 번째 항목을 보고 해당 리스트의 패턴을 파악하며, 나열된 항목들이 동일한 패턴으로 작성되어 있을 거라 무의식적으로 예상하게 된다.
Exercise
The red dots represent sick trees.
Immature trees are represented by the blue dots.
The green dots represent healthy trees.
해당 리스트는 nonparallel하다.
첫 번째와 세 번째 항목은 능동태인 반면, 두 번째 항목은 수동태이기 때문이다.
Start numbered list items with imperative verbs
numbered lists의 경우 명령문으로 작성할 것.
바로 Exercise로 넘어간다.
Exercise
내 답을 먼저 화살표 뒤에 표기하고, 모범답안이 다를 경우 뒤에 빨간색으로 덧붙였다.
1. Stop Frambus → 뒤에 마침표(.) 추가.
2. The key configuration file is /etc/frambus. Open this file with an ASCII text editor.
→ Open the key configuration file (/etc/frambus) with an ASCII text editor.
→ Open the key configuration file, /etc/frambus, with an ASCII text editor.
3. In this file, you will see a parameter named Carambola, which is currently set to the default value (32). Change this value to 64.
→ Change Carambola value from 32(default) to 64.
→ Change the Carambola parameter from its default value (32) to 64.
4. When you are finished setting this parameter, save and close the configuration file
→ Save and close the configurtaion file.
5. now, start Frambus again.
→ 소문자 n을 대문자 N으로 변경.
Punctuate items appropriately
제목은 구두점 사용에 대한 것이지만, 대소문자 사용 가이드도 함께 다루고 있다.
(챗GPT한테 물어보니 문서 스타일 가이드에서는 이 둘을 묶어서 다루는 경우가 많다고 한다. 두 항목 모두 문장 전체의 형식성 통일성과 관련되기 때문이다.)
- 몇 가지 예외를 제외하고는 리스트의 각 항목은 대문자로 시작할 것.
- 리스트 항목이 문장이면 마침표로 끝맺을 것.
Create useful tables
글로 된 단락과 표가 있을 때, 우리의 눈은 자연스럽게 표를 먼저 향하게 된다.
그만큼 시각적 효과가 좋은 도구인 만큼, 잘 활용하도록 하자.
표를 만들 때는 아래 사항들을 주의해야 한다.
각 열에 맞는 열 제목(header)를 사용할 것 - 독자가 각 열의 내용을 직접 추측할 필요가 없도록 할 것.
하나의 셀에 너무 많은 텍스트를 담지 말 것 - 가급적 두 문장 이상 넘어가지 않도록 할 것.
각 열의 통일성을 최대한 지킬 것.
그리고 모바일 상에서는 표의 모양이 PC와 다르게 렌더링될 수 있는 점도 유의해야 한다.
Introduce each list and table
리스트나 표를 사용할 때, 어떤 내용에 대한 것인지 간단하게 알려주라는 것.
이 때 소개하는 문장은 마침표보다는 콜론을 사용해서 끝맺도록 한다.
그리고 following이라는 단어를 사용할 것을 권장한다. 이는 다음에 나오는 표나 리스트에서 정보를 얻을 수 있음을 알려주고, 자연스럽게 독자의 시선이 다음으로 넘어가도록 유도한다.
예시는 아래와 같다.
- The following list identifies key performance parameters:
- Take the following steps to install the Frambus package:
- The following table summarizes our product's features against our key competitors' features:
Exercise
아래 표를 설명하는 문장 작성하기.
내가 작성한 문장은 아래와 같다.
The following table summarizes information about 3 types of languages:
모범답안은 아래와 같다.
- The following table contains a few key facts about some popular programming languages:
- The following table identifies the inventor, year of invention, and key feature of three popular programming languages:
출처 : https://developers.google.com/tech-writing/one/lists-and-tables
