[TW] 개요 작성의 중요성

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영)입니다. 이전 포스팅에서 목차의 중요성과 기술 문서 작성 5단계 등 테크니컬라이팅 기법을 설명드렸는데요. 오늘은 그 연장선으로 기술문서 본문 첫 페이지에 등장하는 개요에 대해 살펴보고, 개요의 역할과 작성 방법 등을 알아보겠습니다. 누군가를 처음 만날 때 듣게 되는 자기소개처럼 기술문서의 도입부에 위치한 ‘개요’는 해당 문서를 처음 펼쳐본 독자에게 전하는 문서의 자기소개라고 할 수 있습니다. 즉, 개요를 통해 독자는 해당 문서가 어떤 내용인지 대략적으로 파악할 수 있는데요. 훌륭한 1분의 자기소개가 면접의 당락을 가를 수 있듯이, 잘 정돈된 개요는 독자와 마주한 문서의 첫인상을 결정하는 동시에 해당 문서..

[TW] 개발자들을 위한 테크니컬 라이팅 10계명

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅팀의 Crystal(김유리)과 Sandy(차신영)입니다. 그 동안 테크니컬라이팅 팀에서는 테크니컬 라이팅 4대 원칙과 언어학 관점에서 기술문서 가독성 향상 전략 등 테크니컬 라이팅과 관련한 정석적인 주제를 다뤘었는데요. 며칠 전 개발자 한 분께서 "테크니컬 라이팅 교육을 받고 싶은데 시간은 없고.. 어떻게 하면 기술 문서를 잘 쓸 수 있을까요? 혹시 간단한 팁이 있을까요?" 라는 질문을 주셨습니다. 생각해보면 개발자들이 많은 시간을 들여 테크니컬 라이팅을 심도있게 공부하기는 현실상 쉽지 않은 게 사실인데요. 그래서 오늘은 수 많은 테크니컬 라이팅의 이론과 팁 중에서도 기술문서 작성에 관심이 있으신 개발자 분들이라면 꼭 알아야 할 10가지 팁을 간추려 소..

프레임워크의 선택, React vs Angular

시작하며 안녕하세요. 카카오엔터프라이즈 워크엔진셀에서 프론트엔드 개발을 담당하고 있는 데니스입니다. 저는 이번에 신규 프로젝트의 FE (Front-end) 개발을 혼자 진행하게 되었습니다. 혼자 개발을 하다 보면 자칫 외로운 싸움이 될 수 있는데, 혼자 개발하면서 고민한 부분들을 이렇게 정리하고 공유하면 재미있을 것 같다는 생각이 들어서 포스팅을 작성하게 되었습니다. 앞으로 제가 진행하고 있는 신규 프로젝트 개발 과정을 차례대로 소개할까 합니다. 혼자 프로젝트를 진행하면 기술 스택이나 여러 가지 컨벤션을 마음대로 정할 수 있다는 장점과 자유가 있지만, 이 프로젝트를 평생 혼자서만 개발하고 운영할 것은 아니기에 제가 선택한 것에 대한 명확한 이유가 있어야 하고 합리적인 기술 스택과 컨벤션을 정해야 한다고 ..

[TW] 목차의 중요성

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅팀의 Crystal(김유리)과 Sandy(차신영)입니다. 이번 테크니컬 라이팅 포스팅에서는 목차(Table of Contents)라는 주제를 다뤄보려고 합니다. 얼마 전에 저희 테크니컬라이팅팀에서 “기술 문서 작업 단계에서 가장 중요한 하나를 꼽는다면?” 이라는 질문에 대해 의견을 나눈 적이 있었는데요. 저희 모두 목차 구성으로 의견 일치를 본 만큼, 테크니컬 라이팅 기법에서 목차는 정말 중요한 주제가 아닐 수 없습니다. 본론으로 들어가기 전에 여러분이 지금 서점에서 특정 주제에 대한 책을 구매하려 한다고 가정해 보겠습니다. 이 상황에서 여러분들은 책의 어떤 부분을 가장 먼저 살펴보시나요? 아마 대부분의 경우 “목차”일 것입니다. 해당 목차에서 특정 페..

사오정 API - 음악 재생 발화는 내게 맡겨주세요. [기술편]

어렸을 적 즐겨보던 만화 중 ‘날아라 슈퍼보드'라는 만화가 있었습니다. 그 만화에는 무슨 말을 해도 잘 알아듣지 못하는 ‘사오정'이라는 캐릭터가 등장하는데요. 사오정은 가는 귀를 먹어 귀의 주름을 걷고 이야기를 듣지 않으면 이야기를 엉뚱하게 알아들어 많은 해프닝을 만들어 내기도 했습니다. 이렇게 만화 속 사오정처럼 카카오 i도 가끔 명령을 완벽히 알아듣지 못하는 경우가 있죠. 저희는 카카오 i가 무슨 말을 해도 잘 알아들을 수 있도록 “사오정 프로젝트”를 진행했습니다. 만화 속 사오정은 말귀를 못 알아듣는 캐릭터로 등장하지만, 사오정 프로젝트에서의 사오정은 카카오 i 발화의 대부분을 차지하는 음악 재생 발화의 오류를 획기적으로 줄여주는 고마운 캐릭터임을 밝히며 글을 시작하도록 하겠습니다. #사오정 프로젝..

[TW] 기술문서 쉽게 쓰기 지침

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