[TW] 퇴고의 기술

Krew Insight

[TW] 퇴고의 기술

celina.7 2021. 11. 25. 16:01

시작하며

안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), Rayna(홍성빈) 입니다.
테크니컬 라이터로 일하다 보면 끊임없이 문서들을 마주하게 되는데요. 시험 종료를 알리는 종이 울릴 때까지 마지막 1분을 남겨놓고 혹시라도 실수한 게 없을까 하는 수험생의 마음으로, 저희도 기술문서 배포 버튼을 클릭하는 그 순간까지 끊임없이 ‘퇴고’라는 작업을 수행합니다.

세계적인 작가 헤밍웨이는 소설 『노인과 바다』를 200번 넘게 퇴고했다고 하는데요. 기술문서에서도 퇴고의 중요성은 간과할 수 없습니다. 여러 번 퇴고하고 시간을 투자한 문서일수록 가독성이 좋아지며 독자 친화적인 문서로 거듭나게 되는 것이죠. 하지만 글을 써보신 분들은 공감하시겠지만, 어떤 글(특히 익숙한 글)을 반복적으로 읽고 수정하는 것은 결코 쉬운 일이 아닙니다. 여러 번 같은 글을 읽다 보면 객관적인 눈은 사라지고, 도대체 어떤 부분에 초점을 맞추고 글을 다시 읽어야 할지 감이 잡히지 않습니다.

저희 테크니컬라이팅 팀에서는 이런 퇴고의 어려움에 대해 인지하고, 효율적인 퇴고 방법에 대해 많은 논의와 자료 조사를 거쳐 저희만의 퇴고 프로세스를 수립했는데요. 오늘 포스팅 제목을 '퇴고의 기술'이라고 한 것도, 퇴고에는 분명히 기술과 요령이 필요하기 때문입니다. 그럼 지금부터 퇴고에 대해 자세히 살펴보고, 테크니컬라이팅 팀에서 수립한 퇴고 프로세스와 요령 등을 살펴보도록 하겠습니다 :)

죽은 글도 다시 살리는 퇴고

• 퇴고란?

국립국어원에 따르면 퇴고(推敲)란 '글을 지을 때 여러 번 생각하여 고치고 다듬음. 또는 그런 일'을 의미한다고 합니다. 즉, 퇴고는 글을 다시 한번 살피고 수정하는 글쓰기의 마무리 단계라고 할 수 있습니다. 퇴고(推敲)라는 단어 는 밀 퇴(推)와 두드릴 고(敲)의 한자로 구성되어 있는데요. 이는 당나라 한 시인이 시를 짓다가 한 구절에서 '밀다'라고 쓸지 '두드리다'라고 쓸지 고민했다는 이야기에서 유래되었다고 합니다. '밀다'와 '두드리다'의 단어 선택을 두고 한참을 고쳐 쓰고 고민했던 시인의 고뇌를 상상해보면, 퇴고가 결코 쉽지 않은 작업이었음을 짐작할 수 있습니다.

퇴고가 힘든 이유는 우리의 눈과 뇌가 글을 어떻게 이해하는지 살펴보면 알 수 있습니다. 우리가 글을 읽는 과정을 살펴보면, 먼저 눈으로 글자를 보고 뇌는 이 시각 정보를 활용하여 해당 글자가 어떤 의미인지 해석합니다. 이때 우리가 처음 보는 글이라면 내용을 파악하기 위해 한 글자, 한 글자에 집중하여 글을 읽게 됩니다. 하지만 내가 이미 여러 번 읽어 내용을 파악하고 있는 글인 경우는 어떨까요? 이 경우, 눈을 100% 사용하지 않아도 내용 파악이 가능하기 때문에 글을 대충 훑어보게 될 가능성이 큽니다. 바로 이 지점에서 우리는 글의 문제점을 파악하기 어렵게 되고, 효율적인 퇴고를 수행할 수 없게 됩니다. 퇴고의 도구와 요령 등을 숙지하고 있는 것이 필요한 이유이기도 하지요.

• 퇴고가 필요한 이유

퇴고는 독자들에게 쉽고, 명확하고, 정돈된 글을 전달하기 위해서 반드시 필요한 과정인데요. 여러분들은 자신이 작성한 글에 대해 퇴고를 하고 계신가요? 퇴고는 비단 테크니컬 라이팅 뿐만 아니라 이메일, 회의록, 발표자료 등 회사에서 쓰는 거의 모든 글쓰기 형태에 꼭 필요한 과정인데요. 아마 많은 분들이 이메일, 회의록, 발표 자료 등을 완성하고 대충 훑어보는 것이 '퇴고'라고 생각하실 수도 있지만, 퇴고는 대충 훑어보는 것 이상의 작업이 필요합니다. 대충 글을 수정하는 게 끝이 아니라, 글을 읽는 독자가 어떻게 하면 정확하고, 명확하게 나의 글을 이해할 수 있을까 고민하는 과정이 필요합니다.

저희가 최근 작업한 기술문서 초고를 예시로 들어보겠습니다.

어떠신가요? 괜찮다고 느껴지시는 분들도 있고, 어딘가 어색하거나 무슨 내용인지 이해가 잘 안되는 분들도 계실 것 같습니다. 다음은 이 글을 퇴고한 결과입니다.

벌써 시각적으로도 차이가 느껴지시죠? 계속해서 다르게 언급되었던 용어(봇, Bot, bot)도 통일하였고, 잘못된 외래어 표기와 맞춤법도 수정하였습니다. 또한 줄글로 작성했던 내용을 표로 나타내 가독성을 높였고, 불필요한 요소는 덜어내고 필요한 부분을 보완하니 초고보다 더 이해가 쉬워진 것 같습니다.

기술문서가 이러한 퇴고를 거치지 않고 배포된다면 어떻게 될까요? 오타, 일관성 없는 용어와 레이아웃, 링크 연결 오류 등 다수의 오류가 독자들에게 그대로 노출되겠지요. 그러면 문서의 신뢰도가 떨어지고 CS(Customer Service) 처리와 문서 수정에 불필요한 리소스가 투입됩니다. 따라서 꼼꼼한 퇴고를 통해 최대한 완벽한 상태의 문서를 독자들에게 전달하도록 노력해야 합니다.

테크니컬라이팅 팀에서 제안하는 퇴고 Tips

앞서 회사에서 쓰는 모든 글에 퇴고 과정을 필수적으로 적용해야 한다고 했는데요. 모든 글쓰기 과정의 마무리는 퇴고이며, 퇴고는 선택적 과정이 아닌 필수 과정임을 인지하는 것이 중요합니다. 그럼 어떻게 하면 효율적으로 퇴고를 수행할 수 있을까요? 저희 테크니컬라이팅 팀에서 적용하고 있는 퇴고 요령을 한번 살펴보겠습니다.

• 내 글 낯설게 하기

우리의 눈과 뇌는 이미 알고 있는 내용에 대해서는 글을 대충 훑어보는 경향이 있다고 말씀드렸는데요. 다음과 같은 방법으로 내 글을 최대한 처음 보는 것처럼 낯설게 할 수 있다면 퇴고를 보다 수월하게 진행할 수 있습니다.

• 피어 리뷰(Peer Review)

가장 효율적인 퇴고의 방법 중 하나는 다른 사람이 내 글을 읽고 피드백을 주는 것입니다. 독자마다 배경지식, 생각, 문서에 대한 이해도가 다르기 때문에 다양한 사람들에게 리뷰를 부탁한다면 문서의 부족한 부분을 찾는 것이 더 쉬워질 수 있습니다. 일반적으로 테크니컬 라이팅에서는 '동료가 문서를 리뷰해준다' 하여 '피어 리뷰(Peer Review)'라는 방법론이 존재하는데요. 테크니컬 라이터들도 서로 작업한 문서들을 대상으로 전체적인 콘텐츠, 기술적인 맥락, 오타, 맞춤법, 띄어쓰기 등에 초점을 맞춰 피어 리뷰를 진행하지만, 저희는 동료 테크니컬 라이터뿐만 아니라 개발자, 기획자 등 제 3자로 부터 문서를 리뷰받는 과정을 프로세스화 했습니다. 여러 예상 독자들이 각각 다른 관점에서 문서를 살펴봄으로써 다양한 독자들이 궁금해할 수 있는 사항들을 미리 파악하고, 이를 선제적으로 문서에 보완하기 위해서 인데요. 이때 피어 리뷰를 담당하는 개발자 또는 기획자는 해당 초안을 작성하지 않은 자로서, 전체적인 콘텐츠의 흐름과 기술적인 맥락을 리뷰하게 됩니다. 이런 피어 리뷰 프로세스가 안착하려면, 여러 구성원들의 적극적인 참여가 필수적인데요. 피어 리뷰가 선택적으로 필요할 때만 진행되는 것이 아니라, 유용한 문서로 거듭나기 위해서 반드시 필요한 절차임을 구성원들에게 이해시키고 공감을 얻는 것이 중요합니다.

• 체크리스트 활용

퇴고 과정에서는 공통적으로 확인해야 하는 항목들이 존재하는데요. 이를 체크리스트로 만들어 하나씩 검토한다면 퇴고를 효율적으로 진행할 수 있습니다. 기계가 아닌 이상 모든 항목들을 머릿속에 기억하기는 사실 상 불가능하므로, 최대한 상세하게 체크리스트를 작성하고 활용하는 것이 좋습니다. '링크'만 하더라도 본문에 언급한 문서의 링크 연결이 정확한지, 헤딩의 연결이 정확한지, 또는 링크 연결이 누락된 부분은 없는지 등 체크해야 할 사항을 상세히 적어두고 활용하는 것을 제안합니다. 리뷰어들이 체크리스트에 따라 일관된 방식으로 퇴고를 수행할 수 있도록, 체크리스트를 정기적으로 업데이트하고 관리하는 것도 잊지 말아야 할 것입니다.

• 가독성을 높이는 문장 수정 Tip

테크니컬 라이팅에서 퇴고의 목적은 특정 기술을 독자에게 명확하게 전달하는 것에 있기 때문에 퇴고 단계에서 문장의 가독성을 개선하면 보다 좋은 기술문서로 거듭날 수 있습니다. 그렇다면 기술문서에서 가독성은 어떻게 높일 수 있을까요? 저희 팀에서 실제 퇴고 단계에서 활용하고 있는 몇 가지 Tip을 살펴보겠습니다.

① 단문으로 정리하여 수정하기

먼저 제일 간단한 방법으로는 복문의 문장을 단문(주어 1개+동사 1개)으로 정리해보는 것입니다. 유시민 작가의 『유시민의 글쓰기 특강』이라는 책에서는 '복문은 꼭 필요한 경우에만 쓰고, 복문보다는 단문으로 글을 작성하라'라고 조언하고 있는데요. 복문에는 여러 문장들과 개념들이 존재할 수 있고, 특정 기술을 설명하는 기술문서에서 복문은 독자들을 혼란스럽게 할 수 있기 때문입니다. 복문보다 단문을 사용을 권장하는 것은 테크니컬 라이팅 4대 원칙 중 간결성(Conciseness) 원칙에 해당하는데요. 퇴고 단계에서 불필요한 복문은 없는지, 다시 한번 살펴봐야겠습니다.

② 불필요한 표현 삭제하기

기술문서에서는 간결하고 명확하게 독자에게 정보를 전달하는 것이 중요합니다. 따라서 퇴고를 할 때 불필요하거나 모호한 표현이 없나 살펴보는 것이 좋은데요. '~적', '~의', '~ 것', '~들'처럼 우리가 습관적으로 사용하는 불필요한 표현은 삭제해도 무관한 경우가 많습니다. 따라서 의미에 문제가 없다면 퇴고 단계에서 이런 불필요한 표현을 삭제해 보는 것은 어떨까요? :)

③ 논리적인 글로 탈바꿈하기

문서를 읽는 과정을 길을 걷는 과정에 비유한다면, 독자는 글을 읽으면서 머릿속에 길과 풍경을 떠올리며 한 걸음씩 앞으로 나아갈 것입니다. 그런데 그 앞에 갑자기 갈림길이 나타난다면 독자는 길을 잃고 방황하게 되겠지요. 따라서 퇴고 단계에서는 나의 의도대로 독자에게 하나의 길만을 안내하고 있는지 확인해야 하는데요. 이때 문장 단위와 목차 단위에서 논리성을 확인해야 합니다. 문장 단위의 경우, 중의적 표현과 지시어 사용에 유의해야 합니다. 특정 대상을 꾸며주는 단어는 그 대상과 최대한 가까이 배치하면 의미가 더 명확해져 여러 의미로 해석되는 것을 방지할 수 있습니다. 또한 그, 이, 저, 이것, 저것 등의 지시 대명사는 꼭 써야 하는 경우가 아니라면 삭제하고 직접 대상을 언급하여 설명하는 것이 좋습니다. 목차 단위에서는 목차를 보면서 글이 논리적으로 전개되는지, 각 목차에 적절한 내용들이 포함되어 있는지 확인합니다. 이전 포스팅 <목차의 중요성>에서 목차 구성에 대한 더 자세한 내용을 확인하실 수 있으니 참고하셔도 좋을 것 같습니다.

마치며

오늘 포스팅에서는 퇴고에 대해 살펴보고, 퇴고 단계에서 실제 활용할 수 있는 여러 Tip을 살펴보았습니다. 테크니컬 라이터 분들이나 문서 작성을 담당하는 분들께서는 문서 일정에 쫓겨 형식적인 퇴고를 했던 적이 있으실 텐데요. 아마 형식적인 퇴고로 돌아오는 건 '더 좋은 문장으로 다듬을 수 있었는데 그러지 못했던 아쉬움과 미련'이 아닐까 합니다. 헤밍웨이처럼 한 소설을 200번 넘게 퇴고를 하는 것은 현실적으로 어렵겠지만, 최소한 퇴고의 중요성과 퇴고에 활용할 수 있는 방법론을 인지하고 있다면 퇴고 단계가 훨씬 수월해질 수 있습니다. 대충 문서를 훑어보는 퇴고가 아닌, 퇴고에 필요한 체크리스트와 방법론을 실제 문장에 적용하여 고쳐보는 것은 어떨까요? 아마, 퇴고가 거듭될수록 초안과는 비교도 안 될 만큼 독자 친화적인 글이 탄생하게 될 것입니다. 그럼 다음에도 유용한 테크니컬 라이팅 포스팅으로 돌아오겠습니다. 감사합니다.

📍 테크니컬 라이팅 관련 글 더보기

✓ 올바른 동사 사용 가이드
✓ 기술문서의 쉼표 사용 가이드라인
✓ Release Note 톺아보기
✓ 개요 작성의 중요성
✓ 개발자들을 위한 테크니컬 라이팅 10계명
✓ 목차의 중요성
✓ 기술 문서 작성 5단계
✓ 테크니컬 라이팅 4대 원칙
✓ 기술 문서 쉽게 쓰기 지침
✓ 언어학 관점에서의 기술문서 가독성 향상 전략
✓ 카카오 i 기술문서 사이트 여정, 그리고 벌써 한 달
✓ Technical Writer에서 Technical Communicator로...
✓ [KREW INSIDE] AI 서비스의 기술 문서를 책임지는 사람들, 테크니컬 라이터