[TW] 올바른 줄임말 사용 가이드

시작하며 안녕하세요. 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), July(김정인)입니다. 한 동안 전 세계적으로 YOLO라는 단어가 인기였습니다. YOLO는 ‘You Only Live Once’의 줄임말로 ‘한 번뿐인 인생, 즐기면서 살자!’를 뜻합니다. 하지만 인공지능에 관심 있으신 분들은 ‘You Only Look Once’의 줄임말로 인식 분야에서 유명한 객체 검출 모델이 떠오르실 수도 있을 것 같습니다. 줄임말을 사용하면 긴 단어를 단 몇 자로 줄일 수 있다는 장점이 있는데요. 하지만 YOLO의 경우와 같이 독자의 배경 지식에 따라 달리 해석될 수도 있습니다. 만약 이 예시를 기술문서에 적용한다면 어떨까요? 기술문서에서 사용한 줄임말을 독자마다 다르게 이해한다면 극단적으로 ..

[TW] 스타일 가이드 톺아보기

시작하며 안녕하세요. 테크니컬라이팅파트 Crystal(김유리), Sandy(차신영)입니다. 저희가 그동안 테크니컬 라이팅 관련 아티클을 기고하면서 스타일 가이드에 대해 몇 번 언급을 드렸는데요. 아마 스타일 가이드를 빼놓고 테크니컬 라이팅을 이야기할 수 없었기 때문에 자연스럽게 여러 번 언급되지 않았나 싶습니다. 테크니컬 라이팅이 아닌, 콘텐츠나 문서를 작성하는 팀이라면 정립된 스타일 가이드를 하나쯤 가지고 있을 가능성이 큰데요. 스타일 가이드는 기업의 아이덴티티와 일관성을 지키기 위해 글쓰기 양식과 문서 스타일을 정립한 참조 문서로, '맞다' 또는 '틀리다'를 논하기 위한 절대적인 기준이라기보다는 작성자 간 또는 작성자와 독자 간 암묵적인 약속을 정리해 놓은 문서라고 이해하시면 될 것 같습니다. 혹시 ..

[TW] 헷갈리는 맞춤법과 외래어 표기법

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

[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번 넘게 퇴고했다고 하는데요. 기술문서에서도 퇴고의 중요성은 간과할 수 없습니다. 여러 번 퇴고하고 시간을 투자한 문서일수록 가독성이 좋아지며 독자 친화적인 문서로 거듭나게 되는 것이죠. 하지만 글을 써보신 분들은 공감하시겠지만, 어떤 글(특히 익숙한 ..