기술문서 쉽게 쓰기 지침 #테크니컬라이터 #언어정책

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

테크니컬 라이팅 4대 원칙

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

언어학 관점에서의 기술문서 가독성 향상 전략 #기술문서 #테크니컬라이터 #TW

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

카카오엔터프라이즈 개발 인턴십 후기 #면접후기 #안드로이드_개발자 #주니어_개발자

시작하며 안녕하세요. 인턴십을 거쳐 카카오엔터프라이즈에 입사하여 비즈니스플랫폼개발실 클라이언트 개발팀에서 안드로이드 1셀에 근무하고 있는 Zero 입니다.🐥 저는 불과 얼마 전까지만 해도 취직을 꿈꾸는 평범한 대학생이었습니다. 다른 고학년 대학생들처럼 바쁘게 취업 준비를 하던 어느 날, 우연히 카카오엔터프라이즈의 인턴 전형을 처음 접하게 되었습니다. 당시 인턴 제도에 대해 생소하기도 했고, 관련 정보가 전무했던 터라 막연한 두려움이 있었습니다. 하지만 무엇보다도 원하던 직무였기 때문에 설렘 반 두려움 반으로 지원서를 제출했던 기억이 떠오르네요. 카카오엔터프라이즈에서는 이렇게 인턴제도를 활발히 운영 중이기 때문에 인턴 전형에 관심이 있는 미래의 카카오엔터프라이즈 Krew 분들이 많을 거라 생각됩니다. 여기..

[KREW INSIDE] AI 서비스의 기술 문서를 책임지는 사람들, 테크니컬 라이터

AI 서비스의 기술 문서를 책임지는 사람들, 카카오엔터프라이즈는 기술 문서의 중요성을 인지하고, 테크니컬 커뮤니케이션 조직을 신설하였습니다. 그리고 그 안에는 완성도 높은 기술 문서 작성부터 관리, 배포, 운영 및 사내 글쓰기 교육까지 모두 담당하는 이들이 있습니다. 바로 테크니컬 라이터인데요, 테크니컬 라이터라는 직무, 실제로 어떤 일을 담당하고 무슨 역량이 요구되는지, 비전은 어떤지 궁금하지 않으신가요? 개발자에서 10년 차 테크니컬 라이터로, 이제는 카카오엔터프라이즈 AI서비스플랫폼실의 테크니컬 커뮤니케이션셀을 책임지고 있는 Crystal.yull을 만나 보겠습니다. Q. 자기소개와 함께 테크니컬 커뮤니케이션셀에 대한 소개 부탁드려요 :) 안녕하세요. 저는 카카오엔터프라이즈의 테크니컬 커뮤니케이션 ..

신입 개발자의 좌충우돌 문제 해결기

시작하며 안녕하세요 저는 카카오엔터프라이즈 신입 개발자 harry 입니다. 3개월간의 인턴 과정을 마치고 전환되어, AI서비스플랫폼실 서버 개발팀 비즈플랫폼 파트 IAM 셀에서 근무하고 있습니다. 제가 현재 소속되어 있는 AI서비스플랫폼실 서버 개발팀은 테스트 코드의 중요성을 강조하는 팀입니다. 사이드 이펙트를 배포 전에 발견하고 견고한 코드를 작성하기 위해서 테스트 코드를 잘 작성하는 것은 개발자의 기본이라고 생각합니다. 그러나 저와 같은 신입 개발자 입장에서 Spring Framework는 여전히 어렵고, JUnit이라는 테스트 프레임워크는 낯설기만 한데다가 Kotlin이라는 언어는 생소하기까지 합니다. 그래서 테스트 코드를 잘 작성하는 일이 쉽지 않았으며, 지금도 여전히 다양한 케이스를 커버하는 테..