3부에 걸쳐 기술 매뉴얼에 대해 쉽게 알아보고 있습니다.

1부에는 ‘기술 문서’가 무엇이며 필요에 따라 어떤 문서들이 있는지를 알아보았고

지난주 2부에는 기술 매뉴얼이 비즈니스에 어떤 이점을 주는지에 대해 알아보았습니다.

 

오늘은 3부 마지막으로 기술 매뉴얼을 쉽고 효과적으로 작성하는 방법을 단계별로 살펴보겠습니다.

 

 

이제 기업은 내부 직원과 소비자 모두를 위한 기술 매뉴얼 작성의 중요성을 알게 되셨을 겁니다. 그럼 이제 실제로 기술 매뉴얼을 작성하는 핵심에 들어갈 차례입니다.

대부분의 기술 매뉴얼은 읽기가 지루할 수 있지만 어떻게 만드느냐에 따라 충분히 매력적이고 대화형이며 흥미로워지면 브랜드가 눈에 띄고 소비자에게 좋은 인상을 줄 수 있습니다.

다음의 간단한 단계에 따라 매력적인 기술 매뉴얼을 만드는데 참조하시길 바라겠습니다.

 

 

 

1 단계 – 대상의 결정

기술 매뉴얼을 작성하는 가장 중요한 첫 번째 단계는 매뉴얼을 읽는 대상을 정의하는 것입니다. 최종 사용자에 대해 더 많이 알수록 그들의 문제를 더 잘 이해하고 예측할 수 있습니다. 그러면 사용자가 기대하는 내용과 일치하고 도움이 되는 기술 매뉴얼을 만들 수 있습니다.

앞서 말씀드린 것처럼 소비자를 위한 고객 지원 매뉴얼과 기술팀을 위한 기술 지원 매뉴얼은 명확하게 사용자에 따라 나눠집니다.

 

 

2 단계 – 사용 목적의 정의

최종 사용자가 기술 매뉴얼을 읽음으로써 무엇을 얻을 수 있는지 정의합니다. 사용자가 매뉴얼에서 무엇을 기대하는지 정확히 알게 되면 목차를 정리하고 콘텐츠를 작성하는 데 큰 도움이 됩니다.

제품을 처음 접하는 일반 소비자의 경우 제품의 사용 방법에 대한 일반적인 내용에 대해 궁금할 것이며 기술지원 팀에서는 제품에서 발생할 수 있는 오류를 체크하고 수리할 수 있는 절차에 대해 궁금할 것입니다. 이렇게 사전에 사용 목적을 명확하게 한다면 사용자가 궁금해하는 내용과 사용자의 제품에 대한 지식수준에 따라 매뉴얼을 작성할 수 있을 것입니다.

 

 

3 단계 – 사용자의 요구 사항

다음으로 사용자들이 가지고 있는 기술 매뉴얼에 대한 요구 사항을 수집해야 합니다.

소비자들이 자주 묻는 질문은 무엇입니까?

소비자들은 ‘언제’ 또는 ‘어디에서’ 문제에 직면합니까?

이러한 질문들을 기본적으로 기술 매뉴얼 문서를 작성하기 전에 답변해야 할 질문입니다.

이러한 문제에 대한 접근은 고객 서비스 담당자와 영업 직원을 한곳에 모아 제안과 피드백을 요청하는 것입니다. 그들은 고객과 가장 많이 커뮤니케이션을 하는 직원들이기 때문에 고객의 요구에 대해 가장 심층적인 통찰력을 가지고 있습니다.

또한 기존 고객과 온라인 설문 조사를 수행하고 고객의 불만 사항에 대해 질문할 수도 있습니다.

이후 매뉴얼에서 이러한 문제점을 해결하고 고객 만족도를 크게 향상시킬 수 있습니다.

 

 

4 단계 – 개요 만들기

3단계까지 자료를 준비하는 과정에서 매뉴얼에 포함되어야 할 내용이 많다고 무조건 전부 포함할 수는 없습니다.

내용이 많아지면 매뉴얼을 만드는 것도 부담이 되고 막상 제작한다고 해도 매뉴얼을 사용하는 소비자들도 읽지 않게 될 것입니다.

좋은 방법은 먼저 구조화된 개요를 만들고 이를 중심으로 콘텐츠를 정리하는 것이 도움이 됩니다.

사용자의 요구 사항을 수집하는 단계에서 매뉴얼에서 다룰 주요 사항을 나열하고 이를 제목, 하위 제목, 범주, 하위 범주 또는 주제로 나눕니다.

이렇게 개요를 정리하고 나면 기술 매뉴얼을 만드는 것이 더 쉬울 뿐만 아니라 최종 사용자도 필요한 내용을 더 쉽게 찾아볼 수 있습니다.

 

 

5 단계 – 대화 형으로 만들기

대부분의 기술 매뉴얼은 아무도 읽지 않는 평범한 텍스트와 전문 용어로 가득 차 있습니다. 이로 인해 소비자들은 사용 설명서를 멀리하게 되고 사소한 문제가 발생하면 스스로 해결하기 보다 고객 서비스에 먼저 문의를 할 것입니다.

단 하나의 이미지가 한 페이지의 텍스트를 줄일 수 있습니다.

사용자의 이해를 돕기 위해 이미지, 비디오, 인포 그래픽 등을 추가하여 기술 매뉴얼을 인터랙티브하게 만드십시오.

글보다는 시각적 이미지를 통한 이해가 훨씬 빠르기 때문에 읽고 있는 글의 내용에 대한 시각적 자료가 있을 때 사용자는 더 잘 이해할 수 있습니다.

제품 사용을 단계적으로 설명하는 경우 스크린 샷을 단계별로 추가하여 사용자가 보는 변화된 단계를 일치시키는 것이 좋습니다.

 

 

6 단계 – 사용자 리뷰 및 교정

“게시물 등록”, “인쇄 발주”를 누르기 전에 전체 내용을 다시 검토하십시오.

실제 사용자를 대상으로 제품과 사용설명서를 전달하고 사용자가 제품을 사용하는데 아무런 불편함이 없는지 체크해야 합니다.

최대한 사용자의 입장에서 작성한다고 해도 매뉴얼을 작성하는 담당자는 완벽하게 사용자의 입장에서 볼 수 없습니다. 그렇게 때문에 사용자 리뷰는 세부적인 부분을 놓친 것이 없는지 확인하는 데 도움이 됩니다. 기술 매뉴얼의 정확성은 고객 경험을 만들거나 망칠 수 있으므로 잘 검토해야 합니다.

 

 

7 단계 – 지속적인 업데이트

물론 하드웨어 적으로 업그레이드가 필요 없는 단일 제품도 있겠지만 소프트웨어는 물론이고 최근 많은 제품들이 IOT 기술과 연동하여 지속적인 기능 업그레이드가 이뤄지고 있습니다.

그에 따라 매뉴얼 역시 지속적인 업그레이드가 필요한 라이브 문서입니다. 이것은 기업에서 한번 만들고 잊어버릴 수 있는 일회성 문서가 아닙니다.

또한 기능적인 업그레이드가 없다고 하더라도 기술 매뉴얼을 게시한 후에는 매뉴얼의 효과에 대해 사용자 조사를 하거나 최종 사용자에게 후속 조치를 취하고 그들이 만족하는 것과 불편한 것을 이해해야 합니다.

그래서 후속 제품이 새로운 기능을 출시할 때마다 이를 설명하는 기술 매뉴얼에 추가 항목이 있어야 합니다.

 

 

이렇게 3주간 ‘기술 문서’가 무엇이며 필요에 따라 어떤 문서들이 있는지, 그리고 기술 매뉴얼이 비즈니스에 어떤 이점을 주는지, 기술 매뉴얼을 쉽고 효과적으로 작성하는 방법을 단계별로 살펴보겠습니다.

기술문서에 대해 경험이 많은 담당자분들도 계시겠지만 기술문서를 처음 작성하시거나 온라인 매뉴얼, AR 매뉴얼 등 웹 및 모바일 앱을 통한 기술문서 제작이 필요하시다면 텍스트리의 기술문서 콘텐츠 제작팀에 문의를 주시면 쉽고 상세하게 설명드리겠습니다.

감사합니다.