[TW] Troubleshooting 가이드 톺아보기

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

[TW] API 문서 톺아보기

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

[TW] 퇴고의 기술

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

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

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

[KREW INSIDE] 지능을 연구하는 지능들의 이야기, INSIDE THE LAB

안녕하세요. 브랜드 & 마케팅팀 Camila와 Juno입니다. 저희 팀은 카카오엔터프라이즈의 우수한 AI 기술역량을 ‘널리, 그리고 제대로’ 알리자는 미션 하에, AI Lab 연구·개발 크루들과 함께 INSIDE THE LAB 영상 캠페인을 진행했습니다. “지능을 연구하는 지능들의 이야기"를 부제로 공개된 이번 영상은 크게 4개의 에피소드로 구성되어 있으며, 각 에피소드는 크루들의 실제 업무공간에서 이루어진 솔직담백 인터뷰, 그리고 각자의 연구·개발기를 자세히 소개하는 테크 프레젠테이션으로 이루어져있습니다. 음성합성부터 음성처리, 강화학습, 커머스를 위한 비전 기술까지 카카오엔터프라이즈 AI Lab의 최신 성과를 확인할 수 있는데요. 오늘 포스팅에서는 INSIDE THE LAB에서 소개된 크루들과 크루들..

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

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