technical writing22
-
올바른 조사 사용 가이드
시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영)입니다. 좋은 기술 문서를 만들기 위해서는 테크니컬 라이팅 4대 원칙인 명확성, 정확성, 간결성, 일관성을 지켜 문서를 작성해야 합니다. 기술 문서는 독자와 필자 간의 정보 비대칭성에서 출발한 정보 전달 글쓰기이며, 이 같은 유형의 글에서는 독자의 눈높이에서 정보를 정확하게 전달하는 것이 중요한데요. 테크니컬 라이팅 4대 원칙이 모두 중요하지만, 이 중에서 정확한 정보 전달 측면에서 가장 중요한 원칙은 독자가 문서를 읽을 때 내용의 모호함 없이 한 번에 이해하도록 하는 '명확성'입니다. 글을 모호하게 만드는 데는 다양한 요인이 있지만, 그중에서도 조사의 오류로 글의 명확성을 해치는 경우가 가장 많은 것 ..
Krew Talk 2022. 4. 27. -
올바른 문장 부호 사용 가이드
시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영)입니다. 다양한 글을 쓰거나 읽다 보면 문장 부호를 자주 접하게 되실 텐데요. 이런 문장 부호 사용 방법에 대해 다들 잘 알고 있다고 생각하고, 아마 무심하게 지나가시는 분들이 많을 것이라 생각합니다. 저희 테크니컬라이팅 팀에서도 처음에는 당연히 잘 알고 있다고 굳게 믿었던 문장 부호들이 문서에서 명확하게 사용되지 않고, 무분별하게 남용되거나 사용에 대한 혼란을 겪고 있는 모습을 발견하게 되었습니다. 이러한 문제를 해결하기 위해 문장 부호에 대한 가이드라인을 정립하고 준수해 보니 내부적으로 문장 간의 관계나 문장 내의 논리 구조가 명확해지고, 이로 인해 글쓴이의 의도가 명확하게 전달되었음을 느낄 수 있었..
Krew Talk 2022. 4. 12. -
올바른 띄어쓰기 사용 가이드
시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), Rayna(홍성빈)입니다. 이전 포스팅에서 헷갈리는 맞춤법과 외래어 표기법에 대해 소개해 드린 적이 있는데요. 오늘은 국문 띄어쓰기에 대해 이야기를 해보려 합니다. 지난 한글날에 발행된 기사에 따르면 성인남녀의 60%가 한글 표기에 어려움을 느끼고 있다고 응답을 했는데요, 한글 표기 중에서도 맞춤법과 띄어쓰기가 가장 어렵다는 의견이 많았습니다. 특히 띄어쓰기는 다른 언어에 비해 한글에서 유독 어렵다고 평가받는데, 다른 언어들의 띄어쓰기를 살펴보면 그 이유를 알 수 있습니다. 예를 들어, 영어는 모든 단어마다 띄어쓰기를 하면 되고, 일본어와 중국어에서는 아예 띄어쓰기를 하지 않습니다. 그에 반해 우리말..
Krew Talk 2022. 3. 30. -
올바른 줄임말 사용 가이드
시작하며 안녕하세요. 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), July(김정인)입니다. 한 동안 전 세계적으로 YOLO라는 단어가 인기였습니다. YOLO는 ‘You Only Live Once’의 줄임말로 ‘한 번뿐인 인생, 즐기면서 살자!’를 뜻합니다. 하지만 인공지능에 관심 있으신 분들은 ‘You Only Look Once’의 줄임말로 인식 분야에서 유명한 객체 검출 모델이 떠오르실 수도 있을 것 같습니다. 줄임말을 사용하면 긴 단어를 단 몇 자로 줄일 수 있다는 장점이 있는데요. 하지만 YOLO의 경우와 같이 독자의 배경 지식에 따라 달리 해석될 수도 있습니다. 만약 이 예시를 기술문서에 적용한다면 어떨까요? 기술문서에서 사용한 줄임말을 독자마다 다르게 이해한다면 극단적으로 ..
Krew Talk 2022. 3. 3. -
스타일 가이드 톺아보기
시작하며 안녕하세요. 테크니컬라이팅파트 Crystal(김유리), Sandy(차신영)입니다. 저희가 그동안 테크니컬 라이팅 관련 아티클을 기고하면서 스타일 가이드에 대해 몇 번 언급을 드렸는데요. 아마 스타일 가이드를 빼놓고 테크니컬 라이팅을 이야기할 수 없었기 때문에 자연스럽게 여러 번 언급되지 않았나 싶습니다. 테크니컬 라이팅이 아닌, 콘텐츠나 문서를 작성하는 팀이라면 정립된 스타일 가이드를 하나쯤 가지고 있을 가능성이 큰데요. 스타일 가이드는 기업의 아이덴티티와 일관성을 지키기 위해 글쓰기 양식과 문서 스타일을 정립한 참조 문서로, '맞다' 또는 '틀리다'를 논하기 위한 절대적인 기준이라기보다는 작성자 간 또는 작성자와 독자 간 암묵적인 약속을 정리해 놓은 문서라고 이해하시면 될 것 같습니다. 혹시 ..
Krew Talk 2022. 2. 9. -
헷갈리는 맞춤법과 외래어 표기법
시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), Rayna(홍성빈)입니다. 요즘은 메신저나 SNS 등을 통한 소통이 활발해지면서 기본적인 맞춤법에 소홀해지는 경우를 많이 보게 됩니다. “맞춤법이 그렇게 중요한가?”라고 생각하기 쉽지만, 맞춤법 실수가 이성 간의 호감도나 취업에서의 합격 당락까지 좌우한다는 조사를 심심치 않게 접하게 됩니다. 기술문서를 작성하는 경우를 제외하고라도, 우아한 회사생활을 영위하기 위해 올바른 맞춤법의 사용은 중요합니다. 그럼 우리가 회사에서 흔히 나누는 메신저 대화에서 한번 틀린 맞춤법을 찾아볼까요? 이 짧은 대화에서 고쳐야 할 맞춤법이 10개에 달했는데요. 모든 맞춤법을 정확하게 사용하는 것은 어렵지만, 일상생활에서 자..
Krew Talk 2022. 1. 27.