[TW] 테크니컬 라이터와 Git

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영), Brina(이나영)입니다. 최근 IT 기업의 테크니컬 라이터 영입 공고에서 Git과 Markdown 활용 역량을 우대하는 경우를 많이 볼 수 있습니다. 이러한 추세에는 전광석화처럼 발전하는 IT 기술과 테크니컬 라이터가 단순한 문서 작성자가 아니라는 전제가 깔려있는 것 같습니다. 상대적으로 기술과 제품의 혁신 속도가 더뎠던 과거에는 독자에게 정보를 전달하기 위해 종이나 PDF 매뉴얼을 많이 사용했습니다. 지금도 업계 특성에 따라 종이나 PDF 매뉴얼을 사용하는 곳도 있습니다. 하지만 IT 기업의 경우, 한 번 배포하면 수정할 수 없는 문서 형태는 정보 업데이트 관점에서 적절하지 않은데요. 따라서 IT..

[TW] 테크니컬 라이터의 글쓰기 윤리

시작하며 안녕하세요. 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), Haim(이해영)입니다. 오늘은 테크니컬 라이터로서 지켜야 할 글쓰기 윤리를 이야기해보고자 합니다. 혹시 NASA 챌린저호 폭발 사고를 아시나요? 1986년 미국의 왕복우주선 챌린저호가 모두의 기대 속에 발사대를 떠난 지 73초 만에 폭발하고, 탑승객 7명이 모두 사망해 미국 사회에 충격을 주었던 사고입니다. 조사 끝에 사고 원인은 작은 부속품에 불과했던 고무패킹(오링, O-ring)이 추위에 얼어붙어 제 기능을 하지 못했던 것으로 밝혀졌습니다. 이 외에 드러난 사실 하나가 바로 오링 봉인(O-ring seal) 관련 문서의 문제점이었습니다. 당시 NASA 엔지니어가 작성한 문서에서 오링에 대한 내용은 중간에 위치해 ..

[TW] 기술문서에 올바른 우리글 사용하기

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영), Lua(박수빈)입니다. 어느덧 2022년의 가을입니다. 22년 새해를 맞이한 게 엊그제 같은데 벌써 10월이네요. 구름 한 점 없는 맑은 가을 하늘, 천고마비의 계절인 10월 하면 우리에겐 10월 9일 한글날이 떠오르겠죠? 다들 아시겠지만, 한글날은 한글의 탄생을 기념하며 우리 한글의 우수성을 기리기 위한 기념일입니다. 저희 테크니컬라이팅 팀에서도 제576돌 한글날을 기념하여 우리 한글을 바르게 잘 사용하고 있는지 한번 알아봤습니다. 분명 저희 테크니컬라이팅 팀에서도 여러 번의 퇴고 과정을 거쳐 어느 정도 완벽하다고 생각하고 가이드를 배포했는데, 그 당시에는 보이지 않던 '모든 사용자들' 또는 '발신..

[TW] 올바른 단문과 복문 작성 가이드

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), Rayna(홍성빈)입니다. 글을 쓰다 보면 자연스럽게 더 좋은 문장을 쓰고 싶다는 생각이 듭니다. 테크니컬라이팅 팀에서도 읽기 쉽고, 정보를 명확하게 전달하는 문장을 쓰기 위해 다양한 글쓰기 방법에 대해 조사하여 Tech &에 공유하고 있는데요. 오늘은 문장의 종류인 단문과 복문에 대한 이야기를 해보려고 합니다. 단문과 복문은 한 문장에 포함되어 있는 주어와 서술어의 수에 따라 구분됩니다. 주어와 서술어가 하나씩 있는 문장은 단문, 주어와 서술어가 두 개 이상 들어있는 문장은 복문이라고 합니다. 전문가들은 논리적인 글을 쓸 때 복문보다는 단문으로 글을 쓸 것을 권장하고 있습니다. 단문이 복문에 비해 ..

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

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리)과 Sandy(차신영)입니다. 좋은 기술 문서를 만들기 위해서는 테크니컬 라이팅 4대 원칙인 명확성, 정확성, 간결성, 일관성을 지켜 문서를 작성해야 합니다. 기술 문서는 독자와 필자 간의 정보 비대칭성에서 출발한 정보 전달 글쓰기이며, 이 같은 유형의 글에서는 독자의 눈높이에서 정보를 정확하게 전달하는 것이 중요한데요. 테크니컬 라이팅 4대 원칙이 모두 중요하지만, 이 중에서 정확한 정보 전달 측면에서 가장 중요한 원칙은 독자가 문서를 읽을 때 내용의 모호함 없이 한 번에 이해하도록 하는 '명확성'입니다. 글을 모호하게 만드는 데는 다양한 요인이 있지만, 그중에서도 조사의 오류로 글의 명확성을 해치는 경우가 가장 많은 것 ..

[TW] 올바른 문장 부호 사용 가이드

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영)입니다. 다양한 글을 쓰거나 읽다 보면 문장 부호를 자주 접하게 되실 텐데요. 이런 문장 부호 사용 방법에 대해 다들 잘 알고 있다고 생각하고, 아마 무심하게 지나가시는 분들이 많을 것이라 생각합니다. 저희 테크니컬라이팅 팀에서도 처음에는 당연히 잘 알고 있다고 굳게 믿었던 문장 부호들이 문서에서 명확하게 사용되지 않고, 무분별하게 남용되거나 사용에 대한 혼란을 겪고 있는 모습을 발견하게 되었습니다. 이러한 문제를 해결하기 위해 문장 부호에 대한 가이드라인을 정립하고 준수해 보니 내부적으로 문장 간의 관계나 문장 내의 논리 구조가 명확해지고, 이로 인해 글쓴이의 의도가 명확하게 전달되었음을 느낄 수 있었..