언어학 관점에서의 기술문서 가독성 향상 전략 #기술문서 #테크니컬라이터 #TW

시작하며 안녕하세요. 그동안 테크니컬커뮤니케이션 팀에서는 테크니컬 라이팅의 소개, 글쓰기 전략 등에 대한 내용을 다뤘었는데요. 오늘은 조금 특별하게 테크니컬 라이팅 관점이 아닌 ‘언어학 관점에서의 기술문서 가독성 향상 전략'이라는 주제를 준비했습니다. 기술문서에서 가독성은 해당 문서의 사용성을 판가름할 뿐만 아니라, 더 나아가 특정 제품이나 기능의 비즈니스 목표를 달성하는데도 중추적인 역할을 하는데요. 그렇다면 가독성 좋은 글을 작성하기 위해서는 어떻게 글을 써야 할까요? 저희는 ‘가독성’이라는 주제와 관련하여 서적이나 논문들을 많이 찾아보는 편인데요. 얼마 전에 접했던 "한국의 이공계는 글쓰기가 두렵다"라는 책에서는 글쓰기 기법으로 다음과 같은 글쓰기 전략을 세부적으로 제시하고 있어 인상 깊었습니다. ..

카카오 i 기술문서 사이트 여정, 그리고 벌써 한 달

시작하며 안녕하세요. 어느덧 2020년 가을이 되어 테크니컬커뮤니케이션 팀에서 벌써 세 번째 포스팅을 올리게 되었습니다. 그동안 테크니컬커뮤니케이션에 대한 소개와 기술 문서 작성 5단계라는 주제를 다뤘는데요. 오늘은 "카카오 i 기술문서 사이트(https://docs.kakaoi.ai)"가 오픈한 지 한 달을 맞이하여, 기술문서 사이트의 구축 배경과 실제 릴리즈까지의 고민과 여정을 여러분들과 공유해 볼까 합니다. 혹시 테크니컬 라이터라고 하면 단지 문서만 작성하고 관리한다고 생각하시는 분들이 계실 수도 있는데요. 요즘은 IT 기업들의 문서화 트렌드에 따라, 종이 버전이나 PDF 버전을 벗어나 웹에 문서를 게시하는 과정의 중심에 테크니컬 라이터의 역할이 한층 강조되고 있습니다. 이처럼 기술문서 게시를 위한..

기술 문서 작성 5단계

시작하며 안녕하세요. 카카오엔터프라이즈에서 테크니컬 라이터 업무를 진행하고 있는 테크니컬커뮤니케이션 팀의 Crystal(김유리)과 Sandy(차신영)입니다. :) 이전 포스팅(Technical Writer에서 Technical Communicator로…)에서는 Technical Communication에 대한 정의와 역사 그리고 어떤 업무를 하는지에 대해서 알아보았습니다. 지난번에도 잠깐 언급했듯이 해외에서는 테크니컬 라이팅의 학위 프로그램도 존재하며, 학계에서는 관련 프로세스가 확립 되어있는데요. 이를 바탕으로, 이번 포스트의 주제는 기술적인 정보를 특정 독자들에게 정확하고 명확하게 전달하기 위해 어떤 프로세스로 진행해야 하는지에 대해 간단히 말씀드리려고 합니다. Kieran Morgan의 Techni..