[TW] 퇴고의 기술

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), Rayna(홍성빈) 입니다. 테크니컬 라이터로 일하다 보면 끊임없이 문서들을 마주하게 되는데요. 시험 종료를 알리는 종이 울릴 때까지 마지막 1분을 남겨놓고 혹시라도 실수한 게 없을까 하는 수험생의 마음으로, 저희도 기술문서 배포 버튼을 클릭하는 그 순간까지 끊임없이 ‘퇴고’라는 작업을 수행합니다. 세계적인 작가 헤밍웨이는 소설 『노인과 바다』를 200번 넘게 퇴고했다고 하는데요. 기술문서에서도 퇴고의 중요성은 간과할 수 없습니다. 여러 번 퇴고하고 시간을 투자한 문서일수록 가독성이 좋아지며 독자 친화적인 문서로 거듭나게 되는 것이죠. 하지만 글을 써보신 분들은 공감하시겠지만, 어떤 글(특히 익숙한 ..

[TW] 올바른 동사 사용 가이드

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), July(김정인)입니다. 오늘은 테크니컬 라이팅 4대 원칙 (명확성, 간결성, 정확성, 일관성) 중 하나인 명확성(Clarity)을 높이는 글쓰기 조건으로 올바른 동사 사용이라는 주제를 다뤄보려고 합니다. 테크니컬 라이팅 4대 원칙 포스팅에서도 언급했지만, 명확한 글이란 핵심어나 핵심 문장을 모호하게 사용하지 않고 독자가 기술 문서를 읽을 때 한 번에 이해하도록 작성한 글을 말하는데요. 명확한 글을 작성하기 위해서는 무엇보다 문장 성분들 간의 자연스러운 호응이 중요합니다. 특히 한국어는 영어와 다르게 주어를 매우 흔하게 생략하는 특성이 있기 때문에 주어가 생략된 문장에서 서술어를 잘못 사용하는 경우가..

[TW] 기술문서의 쉼표 사용 가이드라인

시작하며 안녕하세요. 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영)입니다. 쉼표는 글을 쓰고 읽는 사람 모두에게 친숙한 문장 부호인데요. 일상생활에서 '오늘의 쉼표'와 같은 관용 표현으로도 자주 사용되어 우리에게 친숙한 문장 부호이기도 합니다. 우리가 이메일을 쓰거나 문서를 작성할 때도 습관적으로 쉼표를 많이 사용하게 되는데요. 주로 긴 호흡의 문장에서 끊어 읽기를 하거나 단어 등을 열거할 때 쉼표를 사용하는 경향이 있습니다. 이렇게 매일 사용하고 있는 쉼표를 과연 제대로 사용하고 있을까요? 테크니컬라이팅 팀에서는 얼마 전 잘못된 쉼표 사용이나 무분별한 쉼표 사용 등을 주제로 논의를 했었는데요. 실제 저희가 작성한 기술문서를 분석해보니 작성자에 따라 쉼표 사용이 제각각이라는 것을 알 수..

[TW] Release Note 톺아보기

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영)입니다. 지금까지 테크니컬라이팅 팀에서는 테크니컬라이팅 관련 포스팅을 기고하고 있는데요. 이번 포스팅을 시작으로 다양한 기술문서에 대해 상세히 알아보는 톺아보기 시리즈를 새롭게 선보이게 되었습니다. 제목에 있는 “톺아보기”라는 단어를 보시고, 생소하기도 하고 오타는 아닐까 하는 의심이 드신 분들도 계셨을 텐데요. 우리말샘 사전에 따르면 “톺아보기”는 ‘샅샅이 톺아 나가면서 살피다’라고 명시가 되어있습니다. ‘틈이 있는 곳마다 모조리 더듬어 뒤지면서 찾다’라는 뜻의 ‘톺다’와 ‘보다’가 합쳐진 순우리말인데요. 기존 테크니컬라이팅 시리즈에서 테크니컬 라이터로서 글쓰기 팁과 노하우를 소개해드렸다면, 톺아보기 ..

[TW] 개요 작성의 중요성

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영)입니다. 이전 포스팅에서 목차의 중요성과 기술 문서 작성 5단계 등 테크니컬라이팅 기법을 설명드렸는데요. 오늘은 그 연장선으로 기술문서 본문 첫 페이지에 등장하는 개요에 대해 살펴보고, 개요의 역할과 작성 방법 등을 알아보겠습니다. 누군가를 처음 만날 때 듣게 되는 자기소개처럼 기술문서의 도입부에 위치한 ‘개요’는 해당 문서를 처음 펼쳐본 독자에게 전하는 문서의 자기소개라고 할 수 있습니다. 즉, 개요를 통해 독자는 해당 문서가 어떤 내용인지 대략적으로 파악할 수 있는데요. 훌륭한 1분의 자기소개가 면접의 당락을 가를 수 있듯이, 잘 정돈된 개요는 독자와 마주한 문서의 첫인상을 결정하는 동시에 해당 문서..

[TW] 개발자들을 위한 테크니컬 라이팅 10계명

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅팀의 Crystal(김유리)과 Sandy(차신영)입니다. 그 동안 테크니컬라이팅 팀에서는 테크니컬 라이팅 4대 원칙과 언어학 관점에서 기술문서 가독성 향상 전략 등 테크니컬 라이팅과 관련한 정석적인 주제를 다뤘었는데요. 며칠 전 개발자 한 분께서 "테크니컬 라이팅 교육을 받고 싶은데 시간은 없고.. 어떻게 하면 기술 문서를 잘 쓸 수 있을까요? 혹시 간단한 팁이 있을까요?" 라는 질문을 주셨습니다. 생각해보면 개발자들이 많은 시간을 들여 테크니컬 라이팅을 심도있게 공부하기는 현실상 쉽지 않은 게 사실인데요. 그래서 오늘은 수 많은 테크니컬 라이팅의 이론과 팁 중에서도 기술문서 작성에 관심이 있으신 개발자 분들이라면 꼭 알아야 할 10가지 팁을 간추려 소..