헷갈리는 맞춤법과 외래어 표기법 #기술문서 #테크니컬라이팅 #테크니컬라이터 #올바른_글쓰기

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅파트의 Crystal(김유리), Sandy(차신영), Rayna(홍성빈)입니다. 요즘은 메신저나 SNS 등을 통한 소통이 활발해지면서 기본적인 맞춤법에 소홀해지는 경우를 많이 보게 됩니다. “맞춤법이 그렇게 중요한가?”라고 생각하기 쉽지만, 맞춤법 실수가 이성 간의 호감도나 취업에서의 합격 당락까지 좌우한다는 조사를 심심치 않게 접하게 됩니다. 기술문서를 작성하는 경우를 제외하고라도, 우아한 회사생활을 영위하기 위해 올바른 맞춤법의 사용은 중요합니다. 그럼 우리가 회사에서 흔히 나누는 메신저 대화에서 한번 틀린 맞춤법을 찾아볼까요? 이 짧은 대화에서 고쳐야 할 맞춤법이 10개에 달했는데요. 모든 맞춤법을 정확하게 사용하는 것은 어렵지만, 일상생활에서 자..

시니어 개발자의 카카오엔터프라이즈 500일의 기록

시작하며 2020년 6월에 입사하여 약 500일, 1년 반을 카카오엔터프라이즈에서 근무하고 있는 커넥트라이브팀의 Green입니다. 저는 만 20년을 개발자 및 스타트업 대표로 지내왔습니다. 그동안 주로 B2B 솔루션이나 플랫폼을 개발하는 시장에 있다 보니 SI 회사나 외국계 기업 혹은 대형 통신사 등은 섭렵(?)해왔지만 카카오 같은 B2C 회사는 선망의 대상일 뿐 거의 갈 생각도 못 했습니다. 그런 와중에 카카오의 자회사 중 B2B 시장을 전문으로 하는 카카오엔터프라이즈 소식을 듣고 큰 관심이 갔습니다. 과연 척박한 B2B 시장에서 카카오엔터프라이즈는 어떤 회사로 성장할까? 마치 카카오뱅크가 금융 시장에 적지 않은 파란을 일으켰듯 카카오엔터프라이즈도 제가 주로 몸담고 있던 B2B 시장에 의미 있는 변화를..

Troubleshooting 가이드 톺아보기 #기술문서 #테크니컬라이팅 #테크니컬라이터

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅파트의 Crystal(김유리), Sandy(차신영), Rayna(홍성빈)입니다. 얼마 전 개발자 한 분이 다급하게 찾아오셔서 저희에게 도움을 요청하신 적이 있습니다. 사정을 들어보니 최근 여러 고객사에서 "404 오류가 났는데 어떻게 해야 하나요?", "Access unavailable 오류 났어요!", "오류 코드 정리된 게 있나요?" 등의 문의에 답변을 하다 보니 정작 본인의 개발 일정에 차질이 생겼다는 것이었는데요. 특정 문의에 동일한 답변을 계속해야 할 뿐만 아니라 동일한 내용에 대해 두 명의 개발자가 각각 문서를 작성하는 일도 생겼다고 합니다. 이럴 때 오류 상황과 해결 방법을 모아 정리해둔 문서가 있었다면 CS를 처리하는 리소스를 훨씬 줄일 ..

API 문서 톺아보기 #기술문서 #테크니컬라이팅 #테크니컬라이터

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅파트의 Crystal(김유리), Sandy(차신영), July(김정인)입니다. 테크니컬라이팅파트에서는 Kakao i 기술문서 사이트에 카카오엔터프라이즈가 개발하고 있는 다양한 기술들을 문서를 통해 전달하고 있는데요. 오늘은 Release Note 톺아보기에 이어 두 번째 시리즈로 API 문서를 샅샅이 톺아보도록 하겠습니다 :) API(Application Programming Interface)는 '서버와 클라이언트가 데이터를 주고 받을 수 있도록 도움을 주는 매개체'라고 정의할 수 있습니다. API를 사용하기 위해서 사용자는 서버와 클라이언트 사이에 존재하는 몇 가지 약속을 따라야는데요. 메시지의 데이터 형식은 무엇이고, 글자수 제한이 있다면 몇 자인..

퇴고의 기술 #기술문서_작성법#개발자_글쓰기 #테크니컬라이터

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

올바른 동사 사용 가이드 #기술문서_작성법#개발자_글쓰기 #테크니컬라이터

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