-
작성된 문서 Rewriting하기, 퇴고, 문장의 가독성을 높이는 방법Technical Writing 2022. 2. 8. 21:36
Google Developers에서 진행하는 Free technical writing courses 4번째 정리 포스팅입니다. 마지막 포스팅에서는 실습 중간에 짧게 토론(?)을 했던 Rewriting과 Find tune에 대해서 정리하고 내 의견을 덧붙여보려고 합니다.
How is rewriting different from writing?
writing과 rewriting의 차이를 간단하게 말하자면 writing은 콘텐츠를 작성하는 것이고 rewritng은 작성한 콘텐츠의 구조를 재 정렬해서 깔끔하게 작성하는 것입니다. rewriting을 우리말로 직역하면 재작성인데 재작성을 '퇴고'라고 번역을 해야 할까요?
여기서 말하는 퇴고란 초안을 바탕으로 작성된 글을 수정,보완,정리 하는 작업을 뜻합니다.
문서를 작성할 때 처음 작성한 초안이 바로 배포되는 경우는 거의 없습니다. 처음 작성한 글을 다시 읽어보면 문맥에 맞지 않는 문장도 보이고 오타도 많이 보입니다. 처음 작성한 문서를 읽어보면서 단어를 변경하거나 글의 순서를 변경하며 재작성을 합니다.
작성된 초안을 다시 작성하는 팁이 있다면?
- 계속해서 한 문서를 반복해서 재작성하기보다는 잠시 시간을 가지고 작업하는 것이 중요합니다.
- 여유가 된다면 다른 사람에게 부탁해서 검토를 요청하면 수정사항이 아주 많-이 보입니다.
- 기술문서를 작성할 때 이 기술을 처음 접하는 사람을 대상으로 작성하는 경우가 많습니다. 그럴 때는 내가 이 기술을 처음 접하는 사람이 되어서 문서를 다시 읽어보고 고칩니다.
- 소리 내서 글을 읽어보거나 프린트해서 글을 읽어봅니다.
위 사항들을 모두 요약하자면 작성된 문서를 읽을 때 환기가 필요하다는 것입니다. 똑같은 계속 같은 문서만 바라보다 보면 익숙해져서 사소한 오타도 눈에 들어오지 않고 내용이 잘 이해가 된다고 생각할 수 있습니다
위 방법 중 가장 좋은 방법은 독자에게 피드백을 받는 방법이지만 실제로 독자에게 피드백 받는게 어려울 경우에는 동료들에게 문서 리뷰를 요청합니다. 작성한 문서에 대해 기술에 대해서 잘 알고 계신 수석 엔지니어분들에게 리뷰를 요청드리면 많은 피드백을 받고 그들의 관점에서 다시 생각해볼 수 있습니다. 하지만 다른 사람에게 피드백을 받으려면 시간도 많이 들고 동료들의 적극적인 참여가 필수적입니다.
퇴고를 꼼꼼하게 하는 것이 결국 좋은 글을 만들 수 있습니다. 실제로 소프트웨어 사용자 가이드 문서를 작성할 때 이 문서만 보고 사용자가 원하는 작업을 할 수 있나?를 생각하면서 퇴고를 반복했습니다. 가독성을 위해 줄글로만 작성되어있는 문단을 리스트로 작성하기도 하고 표로 표현하기도 하고 또는 그 반대로 다시 고치기도했습니다. 혹은 중복된 내용으로 작성된 문장은 삭제하고 하나로 통일하거나 설명이 부족한 부분은 다시 구체적으로 작성했습니다.
고객에게 보여지는 글은 결국 회사의 얼굴이라고 생각합니다. 중요한 문서에 오타가 있다고 생각한다면😭 (아무리 맞춤법 검사기를 돌려도 배포되고 난 후에 오타가 발견되는 경우는 미스테리입니다.)
Find tune
토론 과정에서 Find tune이라는 용어가 나왔습니다. Find tune을 직역하자면 '미세조정'입니다. 가독성을 높이기 위해 문장을 수정하는 것을 의미하는 것이 아닐까 싶습니다.
작성된 글 가독성 높이기
가독성을 높이기 위한 방법은 아마 문서를 많이 작성하는 사람들은 다들 이론적으로는 알고있겠지만, 초안을 작성하면서 바로 적용하기는 쉽지 않다고 생각합니다. 작성된 글을 다시 한번 읽어보고 조금씩 문장을 수정해나가면서 간단하고 명확하게 작성해보세요. 여기서는 간단한 예시 몇가지를 살펴 보고자 합니다.
1. 짧고 간결하게 문장 작성하기
한 문장에는 하나의 주제만 작성하도록 합니다. 가급적이면 한 문장에 한 개의 주어, 한 개의 동사만 사용해서 작성합니다.
(X) 일반적으로 광계측기에서 시료 측정 시 표면에 초점을 맞추어 측정하게 되는데 이 경우 표면에서 반사되는 반사파와 박막 내부에서 반사되는 반사파의 경로차가 발생합니다.
(O) 일반적으로 광계측기에서 시료 측정 시 표면에 초점을 맞추어 측정합니다. 이 때 표면에서 반사되는 반사파와 박막 내부에서 반사되는 반사파간에 경로차가 발생합니다.2. 불필요한 요소 제거하기
~것, ~에 대해 처럼 과도하게 남용되는 불필요한 조사를 제거합니다. 적절하게 사용하는 것은 좋지만 문장을 읽다보면 반복해서 자주 사용되는 조사가 있습니다. 조사를 삭제해도 의미가 크게 달라지지 않는다면 불필요한 조사를 삭제해 문장의 길이를 짧게 만들 수 있습니다.
(X) 귀하의 계정이 3개월 연체된 것으로 확인되었습니다.
(O) 귀하의 계정이 3개월 연체되었습니다.
(X) 이 문서에서는 프로그램 설치 방법에 대해 설명합니다.
(O) 이 문서에서는 프로그램 설치 방법을 설명합니다.3. 문서의 스타일, 라이팅톤 통일하기
가끔 회사 문서를 보면 여러 사람이 작성을 하고 취합했는지 종결어미가 통일되지 않은 문서들이 종종 보입니다. 예를 들어 '~합니다.'로 작성을 했다가 '~한다', '~하십시오.', '~함' 이런 식으로 어미가 바뀝니다. 종결 어미는 문장의 유형이나 톤을 결정하기 때문에 통일시켜 주는 것이 좋습니다.
넓은 의미로 말하자면 '라이팅톤'을 통일하는 것입니다. 서비스를 제공하는 회사들은 고유의 브랜드 톤을 가지고 있습니다. 스마트폰을 켜고 애플리케이션에서 보내는 푸쉬 메시지, 경고창, 홍보성 메일을 보면 각 브랜드마다 라이팅톤이 다릅니다.
토스의 예시를 하나 가져와봤습니다. 아래와 같이 송금을 완료한 메시지를 아래와 같이 다양하게 라이팅해보고 라이팅톤을 고려해 일관성 있게 메시지를 내보냅니다.
1,000,000원 송금을 완료했어요
1,000,000원을 송금합니다
1,000,000원 송금
1,000,000원을 송금했어요1,000,000원을 송금하다 라는 간단한 문장도 다양한 라이팅톤을 가질 수 있습니다. 제조업계에서는 마케팅 자료가 아닌 이상 대부분의 기술문서는 '~한다.', '~합니다.'로 작성되지만 일관성 있는 문장의 톤과 문서의 스타일을 유지하는 것은 중요합니다. 제목의 폰트 크기나 글꼴, 단락 사이의 간격 등 문서 스타일을 통일하면 읽는 사람에게 편안함을 줍니다.
라이팅톤, 문서의 스타일 관련해서는 다룰 내용이 많아 자세하게 포스팅해 볼 예정입니다.
포스팅하는 글도 작성한 후에 다시한번 읽어보고 수정하려고 하고 있지만 시간이 없기에 오타나 어색한 문맥이 있을 수도 있습니다.😅 문서를 리뷰하고 수정하다 보면 어느새 파일명이 수정_최종수정본_진짜 최종이 되어버리곤합니다.
참고 자료
https://brunch.co.kr/@thinkaboutlove/396
'Technical Writing' 카테고리의 다른 글
Technical writing One - 간결하게 문장 작성하기 (0) 2022.02.15 Technical Writing One - 기술문서 명확하게 문장 작성하기 (0) 2022.02.11 Google Developers에서 진행하는 Free technical writing courses-3 (2) 2022.02.03 Google Developers에서 진행하는 Free technical writing courses-2 (0) 2022.01.19 Technical Writing One - 능동태와 수동태 (1) 2022.01.13