구글이 제안한 테크니컬 라이팅 방법

목차

1. 명확한 방향성을 위한 독자 파악
2. 단어를 사용할 때 주의사항
3. 문장을 쓸 때 고려해야 할 점
4. 알맞은 목록과 테이블 사용
5. 효과적인 문단 작성
6. 통일성 있는 편집

테크니컬 라이팅에 대한 중요성이 대두되면서 구글이 테크니컬 라이팅과 관련된 영문 강의 및 관련 영문 리소스를 제공했습니다. 이번 아티클은 구글이 제공한 자료를 기반으로 하며 한국어로 작성할 경우 고려해야 할 사항들을 추가함으로써 보다 쉽게 이해되도록 작성했습니다.

1. 명확한 방향성을 위한 독자 파악

올바른 테크니컬 라이팅을 위해서는 글쓰기에 앞서 독자를 파악하는 것이 중요합니다.
독자가 가진 기본 지식에 따라 용어 및 내용의 난이도를 조절해야 하며, 독자가 글을 읽는 목적에 따라 내용의 구성을 달리합니다. 또한 내용 작성 시 독자의 국적이나 문화에 따른 적절한 관용구와 속담을 사용해야 합니다.

아래 질문에 답하며 독자를 파악해 글의 방향성을 구체화하세요. 

1. 독자는 누구인가?
2. 독자의 목표는 무엇이며, 이 문서를 읽는 이유는 무엇인가?
3. 독자는 문서를 읽기 전에 이미 무엇을 알고 있는가?
4. 독자는 문서를 읽은 후 무엇을 알거나 할 수 있어야 하는가?

2. 단어를 사용할 때 주의사항

새로운 용어 정의하기

내용 상에 등장하는 새로운 용어 또는 친숙하지 않은 용어는 관련 링크를 덧붙이거나, 간단히 설명합니다.

두문자어(약어)를 사용하기

원래의 단어 길이가 길 경우 두문자어(약어)를 사용한다면 원형과 두문자어(약어) 중 한 가지로 통일해서 사용해야 합니다. 한 단어가 반복되는 횟수가 적을 경우는 축약하지 않고 원형을 사용하는 것이 독자가 이해하기 더 쉽습니다.

분명하게 지칭하기
앞서 나왔던 단어를 다시 언급하는 경우, 대명사와 명사를 적절히 활용해야 합니다.
하지만 앞에 나온 명사와 대명사가 다섯 단어 이상 떨어진 경우나 대명사가 너무 자주 나오는 경우에는 대명사가 앞에 언급된 내용 중 어떤 것을 가리키는지 불분명해지므로 유의해야 합니다.

3. 문장을 쓸 때 고려해야 할 점

알맞은 수동문과 능동문 사용하기
좋은 문장은 읽자마자 바로 이해가 됩니다. 특히 각 언어에 따라 다른 특성을 갖고 있기 때문에 번역이 필요한 경우라면 도착어의 문법에 따라 어순을 적절히 배치해야 합니다. 능동태를 사용해 독자가 한번에 이해가 될 수 있도록 씁니다. 

짧고 명확한 문장 쓰기
각 문단에서 전달하고자 하는 한 가지 핵심을 한 줄로 쓰고, 문단마다 한 줄로 쓴 핵심에서 벗어나지 않는 내용으로 구성합니다. 단문은 주어, 서술어, 목적어가 한번씩 들어가는 기본 형식에 따라 쓰며 주어를 생략하지 않음으로써 문장을 더 정확하고 자연스럽게 쓸 수 있습니다.

수식어를 최소한으로 사용하기
테크니컬 라이팅에서는 부사와 형용사 같은 수식어의 잦은 사용을 지양합니다. 대신 정확한 수치, 도표, 그래프 등을 활용해 구체적으로 설명해줍니다.

4. 알맞은 목록과 테이블 사용

알맞은 목록 기호 사용하기

각 목록의 특징에 알맞은 형식을 사용합니다. 목록 간의 순서가 무관하거나 큰 항목에 포함되는 세부 목록은 글머리 기호로는 숫자가 아닌 원, 다이아몬드꼴, 네모꼴 등의 도형 기호를 쓸 수 있습니다. 순서가 있는 내용일 경우 숫자를 이용해 번호를 매깁니다.

병렬 확인하기

글머리 기호를 사용하는 경우에는 각 항목의 문장 형식이나 상위 및 하위 개념이 병렬인지 확인합니다. 상위 문장이 단어로 끝날 경우는 하위 문장도 동일하게 단어로 끝맺어야 합니다.

5. 효과적인 문단 작성

흥미를 유발하는 첫 문단 쓰기
독자들은 첫 문단을 읽고 이 글을 계속 읽을지 말지를 결정합니다. 따라서 주제를 나타내는 문장 외에 의문형으로 첫 문장을 시작하면 독자의 관심을 끌 수 있습니다.

각 문단을 단일 주제만 나타내기
한 문단은 한 가지 주제만 설명해야 하므로 문단의 주제와 관련 없는 문장은 가감 없이 삭제합니다.

문단의 길이 조절하기
문단이 길어지면 독자는 흥미를 잃게 됩니다. 따라서 한 문단을 3~5개의 문장으로 구성하는 것이 적절합니다. 또한 한 단락이 너무 짧을 경우 문장의 맥락이 어긋날 수 있으므로 잘게 나뉜 문장을 한 문단으로 묶습니다.

의도 파악하기
각 문단은 독자에게 전달하고자 하는 내용과 독자가 그것을 알아야 하는 이유, 글을 통해 얻은 지식을 어떻게 사용할 수 있을지를 분명히 나타내야 합니다. 각 문단의 구성이 흐트러지는 경우 글 전반의 내용이 방향성을 잃게 됩니다.

글을 쓰는 데 어려움이 있다면 "내가 무슨 말을 하려는 거지?"라고 자문해보세요. 스스로에게 하는 대답이 문서에서 말해야 할 내용입니다.

6. 통일성 있는 편집

내용 작성 후에는 전체적인 스타일을 통일합니다. 문서의 스타일을 통일하기 위해서는 확정된 스타일 가이드가 필요합니다.

기존 가이드가 있다면 그에 따라 글의 스타일을 다듬고, 아직 통일성과 관련된 가이드가 없는 경우는 구글과 애플의 스타일 가이드를 참고해 가이드를 설정합니다.

• 구글 문서 스타일 가이드Google developer documentation style guide
• 애플 스타일 가이드Apple Style Guide
  
  

퇴고할 때 자신의 사용한 표현이나 어조에 대해 확신이 서지 않으면 동료 또는 전문가에게 도움을 요청하세요. 무엇보다 명확하고 직접적인 방법으로 유용한 정보를 전달하는 것이 가장 중요하기 때문에 제3자의 입장에서 이해하기 어려운 부분이 있을 경우 수정하는 것이 좋습니다.

테크니컬 라이팅의 전반적인 과정이 궁금하다면 초보자를 위한 테크니컬 라이팅 가이드를 참고하세요.