Become a Certified Technical Writer-라이팅 연습하기

blog main banner

현존하는 TC조직중 가장 규모가 큰, 독일 tekom에서 제공하는 테크니컬 라이터를 위한 국제 교육 프로그램 TCTrainNet이 제공하는 Professional Course를 이수하면 tekom이 인증하는 international technical communicator 시험을 치를 자격이 생깁니다. (https://www.technical-writing-training-and-certification.com/)

Scripted by
Guinea
MD Div.

이 시험은 TrainNet Professional Course 교육을 통해 습득한 지식을 바르게 이해하고 있는지를 확인하는 오럴테스트와 주어진 사용정보문서를 분석하여 지시에 맞게 재구성하고 라이팅하는 필기시험으로 이루어져 있습니다.

한샘에서는, 국내에서는 최초로, 그리고 2020년 4월 현재까지는 유일하게, 두 사람이 시험에 응시하여 First level technical writer 인증을 취득하고 있습니다.

이 과정을 통해 접한 TCTrainNet의 라이팅 테스트 필기시험지는 라이터에게는 교육자료로 상당히 유용해 보였다고 해요. 그래서 최근 우리 콘텐츠개발팀 라이터들은 국제적인 TC인증을 취득하는 시험 분위기로 TCTrainNet 라이팅 테스트 필기시험지 뽀개기 시간을 가졌습니다.

읽기 싫은 설명글을 환골탈태 시켜보자!

라이팅 테스트는 여백(white space) 하나 없이 빡빡하게 작성된 줄 글을 사용자가 읽기 쉽고, 따라가기 쉬운 정보로 리라이팅하는 것이었습니다.

사용자가 어디서부터 따라 해야 할 지 감이 오지 않는 장황한 설명으로 정말 읽고 싶지 않은 글임을 한 눈에도 알 수 있습니다.

한 문장 한 문장이 너무 길어 사용자가 과제를 수행하는 도중 헷갈릴 것입니다. 게다가 과제는 모터 교체 방법이라, 위험한 상황이 발생할 수도 있네요. 이런 설명일수록 더더욱 간결하고 정확한 문장으로 명시되어야 합니다.

쉽게 읽을 수 있도록 길게 설명된 문장들은 짧은 문장들로 나누는 작업(Breaking up long sentences)이 필요해 보입니다. 또한 꼭 필요하지 않은 표시된 구절을 삭제하는 작업(Omitting needless words)도 필요해 보입니다.

팀의 다른 라이터들과 협력하여 이 재미없는 글을 읽기 쉽도록 재구성했습니다.

제목 넣기

제목은 목차에서 검색 기능을 제공하는 매뉴얼 구성의 중요 요소 중 하나입니다. 성격에 따라 정보를 구분하고, 그 정보를 대표하는 제목을 만들어 넣었습니다.

원본에는 ‘낡은 모터 분리하기’와 ‘새로운 모터 설치하기’ 정보가 제시되어 있어, 두 제목(1.1.1 Disassembling the old motor와 1.1.2 Assembling a new motor)으로 나누어 설명하였습니다.

도입부 넣기

본격 내용 시작 전, 해당 제목 아래의 내용은 어떤 내용일 것인지 설명하는 도입부를 삽입하면, 사용자가 어떤 과제를 수행하기 위한 행동을 설명하는 것인지 더 쉽게 이해할 수 있습니다. 따라서 제목 다음에 도입부를 삽입하여 사용자에게 앞으로 어떤 내용을 설명할 지 안내하도록 개선했습니다.

안전 정보 넣기

도입부 다음으로는 모터가 뜨거우니 주의하라는 안전 문구와 스티커가 붙여진 모터의 사진을 배치하여 해당 과제 수행 전 주의해야 할 사항 안전정보에 대해 언급하였습니다. 사용자의 안전과 관련된 중요한 정보이기 때문에 앞에 배치하였습니다.

안전 정보는 ANSI Z535.6-2011 표준에 의거하여, 위험(Danger), 경고(Warning), 주의(Caution)를 정확하게 구분해서 안내하고, 올바른 기호(symbol)과 워딩(wording)으로 작성해야 합니다.

스텝 작성하기

이제 본격적인 모터 교체 방법을 개선하겠습니다.

우선 동작해야 하는 순서대로 번호로 나열하고, 굳이 언급하지 않아도 되는 동작은 삭제하였습니다.

원본에서는 의미가 동일한 여러 표현을 사용하였는데(unscrew, screwing back) 같은 동작에 대해서는 일관된 동사(나사를 푸는 동작은 unscrew, 나사를 조이는 동작은 screw만 사용)를 사용하였습니다. 또, 사용자가 수행해야 하는 동작을 정확하게 인지할 수 있도록 모든 스텝을 동사로 시작하도록 작성하였습니다.

마지막으로, 사용자가 너무 많은 스텝 때문에 피로를 느끼지 않고, 설명을 잘 따라올 수 있도록 한 스텝은 사용자의 한 가지 액션만 요구하는 짧은 문장으로 만들고, 한 제목 하위의 스텝은 9개 이하로 구성하였습니다.

스텝 사이 노트와 상호 참조 넣기

각 스텝이 진행되는 동안 참고해야 하는 사항들은 작업 처음에 한꺼번에 알려주는 것보다, 각 스텝에서 각각 넣는 것이 효과적입니다. 그래서 스텝 사이에 노트를 추가했고, 노트로 모두 설명할 수 없는 정보는 해당 부분을 찾아 볼 수 있도록 페이지를 안내하는 상호 참조 방식으로 추가했습니다.

디자인 요소 사용하기

적절한 글꼴 종류를 선택하고, 정보간의 텍스트 크기를 조절해서 텍스트가 명확히 구분되도록 하였습니다. 또한 적절한 여백, 행간, 들여쓰기도 사용하여 글의 가독성을 높였습니다.

텍스트 이해에 도움을 주는 사진, 일러스트, 심볼 등을 충분히 활용하였습니다.

위에서 언급된 매뉴얼 작성 방법을 적용하여, 아래와 같이 재구성된 결과물을 얻었습니다.

이번 스터디는 매뉴얼 구성 요소들을 하나씩 직접 적용하여, 리라이팅을 해보는 재미있는 스터디였습니다. 매뉴얼 구성 요소들을 하나씩 적용할 때마다 매뉴얼이 개선되는 것이 눈에 보여서 뿌듯했습니다.

실제 TCTrainNet 라이팅 테스트를 진행해도 잘 통과할 수 있겠다는 자신감도 들었습니다.

그리고, 같은 일을 하고 있는 라이터들과 의견을 주고 받으며, 실제 우리가 하는 일의 궁극적인 방향(=사용자가 읽기 쉬운 매뉴얼을 만드는 방향)을 같이 얘기 나눌 수 있어 유익한 시간이었습니다.

LIST

  • Hansem Story

    중국 우한팀의 오피스 이전

    중국 우한팀의 오피스 이전

    5. 8, 2019

  • Hansem Story

    2019 World IT show 컨퍼런스 참관기 1

    2019 World IT show 컨퍼런스 참관기 1

    5. 3, 2019

  • Posts

    Developing Quality Technical Information_2. 사용자 중심으로 잘 만들어졌는가

    Developing Quality Technical Information_2. 사용자 중심으로 잘 만들어졌는가

    4. 30, 2019