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

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

[TW] 목차의 중요성

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅팀의 Crystal(김유리)과 Sandy(차신영)입니다. 이번 테크니컬 라이팅 포스팅에서는 목차(Table of Contents)라는 주제를 다뤄보려고 합니다. 얼마 전에 저희 테크니컬라이팅팀에서 “기술 문서 작업 단계에서 가장 중요한 하나를 꼽는다면?” 이라는 질문에 대해 의견을 나눈 적이 있었는데요. 저희 모두 목차 구성으로 의견 일치를 본 만큼, 테크니컬 라이팅 기법에서 목차는 정말 중요한 주제가 아닐 수 없습니다. 본론으로 들어가기 전에 여러분이 지금 서점에서 특정 주제에 대한 책을 구매하려 한다고 가정해 보겠습니다. 이 상황에서 여러분들은 책의 어떤 부분을 가장 먼저 살펴보시나요? 아마 대부분의 경우 “목차”일 것입니다. 해당 목차에서 특정 페..

[TW] 기술문서 쉽게 쓰기 지침

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영)입니다. 오늘은 ‘기술문서 쉽게 쓰기 지침’이라는 주제로 포스팅을 해 보려고 하는데요. 먼저 기술문서의 한 단락을 살펴보도록 하겠습니다. 어떠신가요? 일단 ‘역시 기술문서라서 어렵네’라는 생각을 하시는 분들이 많으실 텐데요. 다행히도 위 문장은 이번 주제를 함축적으로 설명하기 위해 가상으로 작성해 본 예시입니다. 사실 한국어의 경우 과거부터 한자어를 다수 포함한 만연체 문장이 널리 쓰였고, 최근까지도 각종 문서에서 외국어 번역체가 무분별하게 사용되고 있는 현실에 비추어 볼 때, 한국어에는 아직도 비직관적인 언어 습관이 많이 쓰이고 있는 것 같습니다. 오히려 과거에는 만연체나 번역투 문장이 더 트렌디하게 ..

[TW] 테크니컬 라이팅 4대 원칙

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅팀의 Crystal(김유리)과 Sandy(차신영)입니다. 오늘은 테크니컬 라이팅에서 일반적으로 쓰이는 테크니컬 라이팅 4대 원칙을 소개해 드리고자 합니다. 앞선 포스팅에서 이메일 작성을 포함한 회사 내에서 작성하는 모든 문서는 기술문서에 해당하며, 이 문서를 작성하는 이들은 일종의 테크니컬 라이팅을 하고 있다고 설명드렸는데요. 따라서 회사 내에서 문서나 이메일을 작성 시 테크니컬 라이팅의 대원칙을 숙지하고 이를 활용하면 글쓰기에 큰 도움이 될 것입니다. 본격적으로 테크니컬 라이팅 4대 원칙을 설명하기 전에, 미국의 언론인이자 퓰리처상의 창시자인 조셉 퓰리처의 명언을 하나 소개하고 싶은데요. 테크니컬 라이팅 4대 원칙에 대해 설명하다가 갑자기 조셉 퓰리처..

[TW] 언어학 관점에서의 기술문서 가독성 향상 전략

시작하며 안녕하세요. 그동안 테크니컬라이팅팀에서는 테크니컬 라이팅의 소개, 글쓰기 전략 등에 대한 내용을 다뤘었는데요. 오늘은 조금 특별하게 테크니컬 라이팅 관점이 아닌 ‘언어학 관점에서의 기술문서 가독성 향상 전략'이라는 주제를 준비했습니다. 기술문서에서 가독성은 해당 문서의 사용성을 판가름할 뿐만 아니라, 더 나아가 특정 제품이나 기능의 비즈니스 목표를 달성하는데도 중추적인 역할을 하는데요. 그렇다면 가독성 좋은 글을 작성하기 위해서는 어떻게 글을 써야 할까요? 저희는 ‘가독성’이라는 주제와 관련하여 서적이나 논문들을 많이 찾아보는 편인데요. 얼마 전에 접했던 "한국의 이공계는 글쓰기가 두렵다"라는 책에서는 글쓰기 기법으로 다음과 같은 글쓰기 전략을 세부적으로 제시하고 있어 인상 깊었습니다. 이 책에..

EMNLP 2020 - 다국어 번역 논문 2편을 소개합니다

시작하며 카카오엔터프라이즈 AI Lab(이하 AI Lab)이 낸 3편의 논문이 EMNLP(Empirical Methods in Natural Language Processing)에 게재 승인됐습니다. 자연어처리에서 경험적 방법론을 다루는 이 학회는 ACL(Association for Computational Linguistics), NAACL(NORTH American Chapter of the ACL)과 함께 전산언어학 분야에서는 인지도가 높습니다. 올해에는 총 3,677편의 논문 중 754편이 통과됐습니다. 이번 글에서는 EMNLP에 게재된 논문 중, 신경망 기반 다국어 기계 번역 모델(multilingual neural machine translation, MNNT)에 관한 최신 기법을 다룬 2편의..