본문 바로가기

마케터의 무게/버라이어티 of 마케팅

[버라이어티 of 트렌드] 테크니컬 라이팅 4대 원칙

https://tech.kakaoenterprise.com/102

 

테크니컬 라이팅 4대 원칙

시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅팀의 Crystal(김유리)과 Sandy(차신영)입니다. 오늘은 테크니컬 라이팅에서 일반적으로 쓰이는 테크니컬 라이팅 4대 원칙을 소개해 드리

tech.kakaoenterprise.com

 

많은 개발자와 엔지니어분들이 테크니컬 라이팅을 함께 수행하고 있습니다.

기본 문예적 글쓰기와는 크게 달라 어떤식으로 기술을 풀어 써야 할지,

어려움을 느끼시는 분들도 많을 것 같아요.

 

회사 내에서 그리고 기술 문서를 제작할 때 숙지하고 잘 활용해 볼 수 있는 테크니컬 라이팅 원칙을 공유드립니다!

 

 

#1. 명확성(Clarity)

 

대상 독자가 기술문서를 읽을 때 내용의 모호함이나 혼란 없이 한 번에 이해가도록 하는 글을 말해요.

핵심 단어나 핵심 문장은 최대한 명확하게 표현하는 것이 좋습니다.

명확성이 모호해질수록 메시지가 정확하게 전달될 가능성은 떨어집니다.

이럴 경우, 독자는 한 문장을 이해하기 위해 같은 문장을 수십 번 읽어봐야 하는 경우가 발생할 수 있어요.

 

#2. 간결성(Conciseness)

 

메시지를 효과적으로 전달하는 데 목적이 있는 만큼,

미사여구나 감탄사 등은 사용하지 않고 간단하고

쉬운 단어와 간결한 문장 형태를 갖춘 글을 쓰는 것이 중요합니다.

또한 기술적인 내용을 신속하고 정확하게 이해할 수 있도록 하기 위해 -한다, -입니다와 같은

능동태를 활용하면 행위 주체가 뚜렷해지고 문장이 더욱 간결해질 수 있습니다.  

 

#3. 정확성(Accuracy)

 

명확성과 간결성이 떨어지더라도 정확성이 확보된 기술문서라면,

독자들은 시간이 많이 걸린다고 해도 결국 해당 문서를 이해할 수 있겠죠.

무엇보다 문서 내 정확성이 떨어지면, 문서 전체에 신뢰도에 상당한 영향을 미치게 됩니다.

독자들이 원하는 정보를 토대로 오류없이 정확하게 문서를 만드는 것이 그 무엇보다 중요하다고 말하고 있어요.

 

#4. 일관성(Coherence)

 

IT 기술을 글로 설명할 때, 문구 또는 어미가 다르면 독자들을 혼란스럽게 만들 수 있습니다.

테크니컬 라이팅이라면 독자 입장에서 조금의 오해 여지를 남기면 안되겠죠.

때문에 문서 일관성 유지가 중요합니다. 숫자, 하이픈, 구두점, 문법, 기호 등

기호를 쓸 때 더욱 각별히 일관성을 유지하기 위한 노력이 필요합니다.