최고의 사용자 문서를 작성하는 방법

제품이 종이 타월보다 더 복잡한 경우 사람들이 사용 방법을 배우는 데 도움이 되는 일종의 사용자 문서를 만들 가능성이 있습니다.

잘 짜여진 사용자 친화적인 제품 매뉴얼이나 사용자 가이드는 환상적인 고객 경험과 끔찍한 경험의 차이를 의미할 수 있습니다.

또한 사용자 설명서는 신규 사용자만을 위한 것이 아닙니다.

숙련된 고객은 사용 설명서나 제품 가이드를 참조하여 자주 사용하지 않는 기능에 대한 기억을 되살리거나 특정 문제를 해결할 수도 있습니다.

이 게시물에서는 소프트웨어와 같은 비물리적 제품에 대한 사용자 문서를 작성하기 위한 모범 사례에 주로 초점을 맞출 것이지만 이러한 팁의 대부분(전부는 아닐지라도)은 하드웨어 영역에도 적용됩니다.

배울 내용은 다음과 같습니다.

• 사용자 문서의 정의와 중요한 이유.
• 최종 사용자 문서가 고객 경험의 일부인 방법.
• 훌륭한 사용자 문서가 고객 지원 팀의 부담을 덜어주는 데 얼마나 도움이 되는지.
• 시각적 콘텐츠가 최고의 문서를 만드는 비결인 이유.
• 최고의 사용자 문서를 보장하는 필수 요소.
• 고객을 기쁘게 하고 시간의 테스트를 거치는 문서를 만드는 4단계.

사용자 문서란 무엇입니까?

사용자 문서(최종 사용자 설명서, 최종 사용자 가이드, 사용 설명서 등이라고도 함)는 최종 사용자가 귀사의 제품이나 서비스를 보다 성공적으로 사용할 수 있도록 돕기 위해 제공하는 콘텐츠입니다.

이것은 누군가가 제품을 올바르게 사용하거나(물리적 제품의 경우) 조립하는 방법을 배우도록 돕기 위해 제품과 함께 제공되는 교육 자료입니다.

IKEA 가구를 조립해본 적이 있다면 최종 사용자 문서를 사용해 본 적이 있을 것입니다.

그러나 사용자 문서는 다양한 형태를 취합니다.

비디오 게임에는 악당을 쏘기 위해 어떤 버튼을 눌러야 하는지 알려주는 설명서가 함께 제공됩니다. 소프트웨어 설명서는 구매로 수행할 수 있는 작업과 수행 방법을 보여줍니다.

세금 양식에는 올바르게 작성하는 방법에 대한 안내서가 함께 제공됩니다.

잔디 깎는 기계와 제설기에는 엔진 시동 방법과 연료 보충 위치를 보여주는 제품 안내서가 있습니다.

사용자 문서 작성 방법으로 건너뛰기

사용자 문서가 왜 중요한가요?

당신은 당신의 제품이 훌륭하다는 것을 알고 있습니다. 당신은 당신의 고객도 그것을 알기를 원합니다. 사용자 문서는 고객이나 사용자가 제품을 최대한 활용하는 방법을 실제로 배울 수 있도록 도와줍니다.

문서를 저장하는 방법, 모터를 시작하는 방법, 특정 도구를 사용하는 방법 또는 중요한 안전 정보에 관계없이 최종 사용자 문서는 고객과의 관계에서 중요한 부분입니다.

사용자 문서는 고객을 기쁘게 할 수 있습니다

사용자 문서는 쉽죠? 내 말은, 당신의 제품을 사용하는 방법에 대한 몇 가지 정보를 작성하고 당신은 갈 수 있습니다!

그렇게 간단하지 않습니다.

이는 단순한 "방법" 자료 그 이상입니다. 고객 경험의 일부입니다. 마케팅 자료이기도 합니다.

나 자신도 소비자로서 훌륭하고 끔찍한 사용자 가이드를 모두 경험했습니다. 대부분 비슷한 경험을 하셨을 거라 생각합니다.

훌륭한 사용자 매뉴얼이나 제품 가이드는 고객이 제품을 구매하는지 여부뿐 아니라 실제로 제품을 사용하는 데 진정으로 훌륭한 경험을 하고 있는지 여부에도 관심을 갖고 있음을 보여줍니다.

당신이 지갑을 넘어 그들을 신경 쓴다고 느끼는 고객은 계속해서 당신에게 돌아올 것입니다.

그들이 당신의 제품과 서비스를 얼마나 사랑하는지 세상에 알리고 싶다면 멋진 사용자 문서를 제공하는 것이 구매 후 경험의 필수적인 부분입니다.

사용자 문서가 지원 팀을 지원하는 방법

사람들은 종종 무언가가 작동하지 않을 때 지원 팀에 연락하지만 단순히 무언가를 이해할 수 없을 때 전화를 걸 수도 있습니다. 훌륭한 사용자 문서가 있으면 두 가지 주요 방법으로 지원 팀에 도움이 됩니다.

1. 그들에게 쉬운 참조 가이드 제공

훌륭한 사용자 문서는 고객만을 위한 것이 아닙니다. 제품 지원 팀은 문서를 사용하여 고객이 도움을 요청할 때 더 나은 지원을 제공할 수 있습니다. 목차나 색인과 같은 필수 항목을 포함하면 필요한 정보를 빠르게 찾을 수 있습니다. 그리고 검색 가능한 전자 문서라면 더욱 좋습니다! 이 기사의 뒷부분에서 이에 대해 자세히 알아보겠습니다.

2. 통화량 감소

위에서 언급했듯이 사람들은 종종 무언가를 이해할 수 없을 때 지원을 요청합니다. 그러나 고객이 스스로 해결할 수 있다면 도움이 필요하지 않을 가능성이 훨씬 낮습니다. 실제로 70% 이상의 사람들이 전화나 이메일로 도움을 받는 것보다 회사 웹사이트를 통해 도움을 받는 것을 선호합니다.

최고의 문서라도 이러한 요청을 모두 없애지는 않겠지만 명확하고 포괄적이며 간결한 사용자 가이드와 매뉴얼을 작성하면 전반적인 지원 요청을 줄이는 데 큰 도움이 됩니다.

훌륭한 사용자 문서의 필수 요소는 무엇입니까?

각 제품이 고유하고 진정으로 훌륭한 사용자 문서를 작성하기 위해 서로 다른 요소가 필요하더라도 어떤 일이 있어도 따라야 할 최종 사용자 문서 모범 사례가 있습니다.

훌륭한 사용자 문서에는 다음이 포함되어야 합니다.

• 평범한 언어
• 간단
• 비주얼
• 문제에 대한 집중
• 논리적 계층 구조 및 흐름
• 목차
• 검색 가능한 콘텐츠
• 접근 가능한 콘텐츠
• 좋은 디자인
• 실제 사용자의 피드백
• 추가 리소스 링크

평범한 언어

고객이 이해할 수 없는 것을 읽는 것만큼 고객을 실망시키는 일은 없습니다. 아무도 멍청하다고 느끼고 싶어하지 않으며 고객이 그렇게 느끼게 만드는 언어는 확실히 훌륭한 경험을 조성하는 방법이 아닙니다.

고객이 가장 복잡한 개념을 이해할 수 있도록 가능한 한 간단하고 쉬운 언어를 사용하십시오.

개발자가 아닌 사용자를 위해 작성하십시오.

당연한 말처럼 들리지만 알고 있는 제품이나 서비스에 대해 평이한 언어로 글을 쓰는 것은 생각보다 어렵습니다. 고객이 모르는 모든 종류의 전문 용어, 두문자어 및 기타 "내부자" 정보를 알고 있습니다. 사용하시는게 당연합니다.

하지만 여기서 심각한 문제에 직면할 수 있습니다.

고객이 귀하의 제품에 대해 아무것도 알고 있다고 가정하지 마십시오. 그들이 사무실에서 매일 사용하는 기술 및/또는 업계 유행어를 모두 알고 있다고 가정하지 마십시오.

아이들처럼 글을 쓰지는 말고 진정으로 이해하기 위해서는 추가적인 도움이 필요할 수 있다는 점을 이해하세요. 문서를 읽기 쉽게 작성하십시오.

간단

목표를 달성하기 위해 가능한 한 간단하게 문서를 유지하십시오. 이것은 문서의 내용과 디자인 모두에 적용됩니다. 글과 그래픽 콘텐츠로 꽉 채워진 긴 텍스트 블록과 페이지는 사용자 가이드나 매뉴얼을 위협적이고 비우호적으로 느낄 수 있습니다.

사용자 자료가 두려운 고객은 스스로 질문을 해결하려고 하는 것보다 지원 팀에 도움을 요청하는 경우가 훨씬 더 많습니다. 또한, 그들은 좋은 고객 경험을 가질 가능성이 훨씬 적습니다.

비주얼

최고의 사용자 문서는 "표시하고 말하지 마십시오"라는 문구를 완벽하게 보여줍니다.

이미지, 주석이 달린 스크린샷, 그래픽 및 비디오를 포함한 시각적 콘텐츠는 다른 사람에게 제품 작동 방식을 빠르게 보여줍니다. 그들은 그것에 대해 읽을 필요가 없습니다: 그들은 그것을 볼 수 있습니다!

TechSmith의 최근 연구에 따르면 시각적 또는 비디오 콘텐츠와 함께 지침이 제공될 때 사람들은 실제로 시각적 정보를 더 빨리 흡수하고 작업을 더 잘 수행합니다.

또한 시각적 콘텐츠는 긴 텍스트 블록을 분리하는 데 도움이 되며 많은 사용자 가이드나 매뉴얼이 겁나고 불쾌하게 느끼게 만드는 많은 텍스트를 제거하는 데 도움이 될 수 있습니다.

사용자 문서에 시각적 콘텐츠를 포함하는 일반적인 방법에는 스크린샷, 화면 녹화, 튜토리얼 비디오 등이 있습니다.

단순화된 그래픽이라고 들어보셨나요? 단순화된 사용자 인터페이스(SUI)라고도 하는 단순화된 그래픽은 이름에서 알 수 있듯이 사용자 인터페이스나 기타 그래픽의 이미지를 가져와 단순화합니다. 이 보다 기본적인 버전은 가장 중요한 정보를 강조하는 동시에 단순한 모양에 중요하지 않은 텍스트와 그래픽을 줄입니다.

따라서 다음과 같이 보입니다.

이제 다음과 같이 보입니다.

Connect Mobile Device 메뉴 항목을 선택하는 방법을 누군가에게 보여주려고 했다면 두 번째 이미지는 모든 혼란을 제거하고 고객의 눈이 필요한 곳에 집중할 수 있도록 합니다.

G Suite 학습 센터의 다음과 같이 이미 단순화된 그래픽을 접하고 깨닫지 못했을 가능성이 있습니다.

많은 도구가 있지만 스크린샷과 화면 녹화를 만드는 강력하고 쉬운 방법을 찾고 있다면 Snagit 무료 평가판을 다운로드하는 것이 좋습니다.

해결해야 할 문제에 집중

모든 제품은 문제를 해결합니다. 그러나 너무 자주, 우리는 우리의 멋진 제품 기능을 너무 사랑해서 우리가 하고 싶은 모든 것은 고객이 그것을 필요로 하는 이유보다는 그것이 할 수 있는 것을 강조합니다.

제품으로 작업을 수행하는 방법을 사용자에게 보여주십시오.

당연히 여기에는 제품 기능이 포함되지만 사용자가 특정 문제를 해결하기 위해 처음에 제품을 구매한 이유를 알 수 있도록 돕는 맥락에서 강조합니다.

예를 들어, Camtasia 및 Snagit 자습서(예, 자습서 비디오는 문서 형식일 수 있음)는 특정 기능을 강조하지만 누군가가 특정 기능을 사용할 수 있는 맥락에서 강조합니다. 그것은 단지 방법이 아니라 이유에 관한 것입니다.

여기에 좋은 예가 있습니다 ...

논리적 계층 및 흐름

좋은 문서에는 사용자가 각 섹션에서 무엇을 보여줄지 알 수 있도록 하는 헤딩과 부제목의 계층 구조가 필요합니다. 그리고 그 계층 구조는 사용자가 가장 유용한 방식으로 제품을 사용하는 방법을 배우는 데 도움이 되는 논리적 흐름을 따라야 합니다.

예를 들어, 제품 작동 방식에 대한 기본 사항을 먼저 보여주지 않고 고급 기능을 사용하는 방법을 고객에게 보여주면서 문서화를 시작하고 싶지는 않을 것입니다. 먼저 쉬운 것부터 시작한 다음 사용자가 지식을 쌓으면서 고급 기능을 보여줍니다.

목차

목차는 고객이 질문이나 문제에 대한 솔루션을 신속하게 찾을 수 있는 간단하고 효율적이며 친숙한 방법을 제공합니다. 문서 시작 부분에 있으므로 원하는 내용을 찾기 위해 텍스트 페이지를 샅샅이 뒤지지 않아도 됩니다. 여기에는 위에서 설명한 모든 주요 제목과 소제목이 포함되어야 합니다.

검색 가능하게 만들기

대부분의 사용자 문서가 인쇄되던 시절이 있었습니다. 이제 거의 모든 사람이 스마트폰에 액세스할 수 있는 시대에 전자 문서를 만드는 것이 더 합리적입니다. 그렇다고 해서 인쇄 버전도 만들 수 없다는 의미는 아니지만 전자 버전은 아래에서 더 자세히 논의할 여러 가지 이점을 제공합니다.

목차처럼 검색 가능한 콘텐츠는 사용자가 콘텐츠에 더 쉽게 액세스하고 스스로 솔루션을 찾도록 도와줍니다.

접근성

접근 가능한 콘텐츠를 만듭니다. 이는 전자 문서가 맹인 또는 시각 장애인, 청각 장애인 또는 난청인 또는 인지 장애가 있는 사람들을 위한 접근성 표준을 준수하도록 하는 것을 의미합니다.

많은 고객이 사용자 설명서를 이해하고 완전히 액세스하려면 이 정보가 필요하다는 것을 기억하십시오. 그들을 뒤에 남겨두지 마십시오!

좋은 디자인

사용자에게 보고 싶은 문서를 제공하면 문서를 사용할 가능성이 높아집니다.

고객을 염두에 두고 재료를 디자인합니다. 사용 가능하고 친근하게 만드십시오. 내용이 너무 많은 긴 텍스트 단락이나 페이지를 피하십시오. 공백을 허용하여 단조로움을 해소하고 새로운 제품을 배우는 전망을 덜 힘들게 만듭니다.

고객에게 제품 사용 방법을 알려주기보다 그래픽과 이미지를 최대한 많이 포함하여 보여줍니다. 전자 문서의 경우 비디오 및 GIF를 사용합니다.

여러 문서에서 일관된 글꼴과 보색을 사용합니다. 조직에 스타일 가이드가 있는 경우(아직 없는 경우 작성하는 것이 좋습니다) 문서가 이를 준수하는지 확인하십시오.

Snagit 템플릿을 사용하면 일련의 스크린샷이나 기타 이미지에서 전문가 수준의 사용자 문서를 매우 쉽게 만들 수 있습니다. 필요한 이미지를 수집하고 생성을 선택한 다음 템플릿에서 이미지를 선택하기만 하면 됩니다.

Snagit은 전문적으로 디자인된 다양한 무료 템플릿과 함께 제공되며 Snagit용 TechSmith Assets를 사용하면 훨씬 더 많은 템플릿에 액세스할 수 있습니다!

실제 사용자 및/또는 베타 테스터의 피드백

실제로 제품을 사용하는 조직 외부의 사람들의 말을 듣기 전에는 진정으로 훌륭한 사용자 문서를 작성할 수 없습니다.

그들의 고충을 파악하고 가능한 한 최선을 다해 해결하십시오. 제품을 가장 잘 사용하기 위해 알아야 할 사항이 무엇인지 알아보십시오. 일부는 명백해 보일 수 있지만, 나는 당신이 한 번도 생각해보지 못한 것들을 배우게 될 것이라고 장담합니다.

다른 문서에 대한 링크

고객이 제품을 성공적으로 사용하는 방법에 대한 조직의 리소스에 더 많이 액세스할 수 있도록 하십시오. 전자 사용자 문서의 경우 자습서, FAQ, 사용자 포럼 등에 대한 링크를 제공하는 것처럼 간단할 수 있습니다.

그러나 인쇄된 문서에도 추가 지원을 위해 웹사이트 주소 및 전화번호와 같은 항목이 포함될 수 있습니다.

보너스! 단계별 지침 추가

단계별 가이드는 긴 텍스트 블록을 피하고 텍스트만으로 설명하는 것보다 프로세스를 훨씬 더 명확하게 보여주는 방법을 제공합니다. 단순히 작업을 완료하는 방법을 다른 사람에게 알려주는 것보다 따르기 쉽고 이해하기 쉬우며 훨씬 더 사용자 친화적인 경험을 제공합니다.

또한 단계별 지침에 시각적 콘텐츠를 포함하면 지침이 더욱 향상된다는 점을 기억하십시오.

Snagit은 훌륭한 단계별 문서를 작성하는 데 도움이 되는 사용하기 쉬운 단계 도구를 제공합니다. 또한 이미지 결합 도구를 사용하면 개별 스크린샷과 기타 이미지를 하나의 이미지로 결합하여 더 쉽게 편집하고 마크업할 수 있습니다.

훌륭한 사용자 문서를 만드는 방법

1단계: 계획

모든 훌륭한 사용자 문서 세트는 계획에서 시작됩니다. 가고 싶은 곳으로 가는 방법에 대한 몇 가지 팁이 있습니다.

어디서부터 시작해야 하는지 알고

많은 사람들은 제품을 알고 있으면 문서 작성을 시작할 수 있다고 생각합니다. 하지만 거기에는 더 많은 것이 들어 있습니다. 대신 실제로 사용자를 돕고 있는지 확인하는 계획부터 시작하세요.

문서화하기 전에 고려해야 할 몇 가지 사항은 다음과 같습니다.

• 무엇을 포함해야 합니까? 무엇을 빼야 할까요? (힌트: 여기에서 사용자 피드백이 정말 도움이 될 수 있습니다!)
• 어떤 순서로 정보를 제시해야 합니까? (학교에서 에세이 개요를 기억합니까? 사용하십시오!)
• 어떤 다른 리소스를 사용할 수 있습니까? 이들에 대한 액세스/링크를 어떻게 제공합니까?
• 문서 작성을 담당하는 사람은 누구입니까? 문서에 대한 피드백을 책임지는 사람은 누구입니까? 누가 최종 승인을 받았습니까?
• 번역하거나 현지화해야 합니까?

이러한 질문에 대한 답변은 문서 작성 방법을 결정합니다. 계획은 원활한 프로세스와 더 나은 사용자 문서를 보장합니다.

당신의 제품을 알고

당신이 당신의 제품을 알고 있는지 확인하십시오.

그렇다고 해서 모든 것에 절대적인 전문가가 될 필요는 없지만 사용자 매뉴얼이나 사용자 가이드를 만드는 사람은 누구나 제품에 대한 실무 경험이 있어야 합니다.

더 심도 있는 지식을 얻으려면 해당 주제 전문가에게 의존하십시오. 그러나 다른 사람을 가르치기 전에 스스로 지식을 사용하는 방법을 알아야 합니다.

형식 선택

또한 문서의 최종 형식도 똑같이 중요합니다. 인쇄만 되나요? 전자가 될까요? 그렇다면 어디에서 살 것인가?

거의 모든 사용자 문서가 인쇄 전용이었던 것은 그리 오래되지 않았습니다. 그러나 아주 합당한 이유가 없는 한 최소한 웹사이트에서 전자 버전을 사용할 수 있도록 하는 것이 좋습니다.

대부분의 사용자는 스마트폰, 컴퓨터 또는 태블릿에 24시간 액세스할 수 있으며 알고 싶을 때 언제든지 알고 싶은 것을 찾는 데 익숙합니다. 사용자 리소스를 온라인에 배치하면 어디에서나 액세스할 수 있습니다. 즉, 몇 년 동안 보지 못한 사용자 설명서를 찾기 위해 서랍이나 파일 캐비닛을 검색할 필요가 없습니다.

또한 장애가 있는 사람들이 전자 문서에 액세스할 수 있도록 하는 것이 더 쉽습니다. 인쇄 전용 버전은 대부분의 사람들에게 적합하지만 맹인이나 시각 장애가 있는 사용자를 위해 점자 버전을 만들 준비가 되셨습니까? 손으로 물건을 조작하기 어려운 신체 장애가 있는 사용자는 어떻습니까?

모든 사람이 전자 문서에 더 쉽게 액세스할 수 있도록 하는 도구가 존재하지만 인쇄 전용 버전은 훨씬 더 어려운 접근성 문제를 제공합니다.

또한 전자 문서는 웹에 있기 때문에 업데이트하기가 훨씬 쉽습니다.

내 문서를 PDF로 만들어야 합니까?

문서의 다운로드 가능한 PDF 버전을 제공하려는 경우 괜찮습니다. 그러나 웹 사이트에서 PDF가 아닌 형식으로도 사용할 수 있는지 확인하십시오.

2단계: 사용자 문서 만들기

모든 질문에 답하고 위에서 설명한 모든 결정을 내렸다면 사용자 문서를 작성할 차례입니다. 귀하의 특정 제품에 대한 문서를 정확히 작성하는 방법을 설명하지는 않겠지만 염두에 두어야 할 몇 가지 핵심 사항이 있습니다.

• 절대적으로 필요한 경우를 제외하고는 전문 용어와 고도로 기술적인 용어를 피하십시오(그리고 반드시 정의하십시오).
• 의미를 설명하지 않는 한 두문자어를 사용하지 마십시오.
• 가능하면 AP나 Chicago와 같이 일반적으로 인정되는 작문 스타일을 사용하십시오. 조직에 회사 스타일 가이드가 있는 경우 이를 사용하십시오.
• 사용자가 귀하의 제품이나 제품이 하는 일에 대해 아무것도 알고 있다고 가정하지 마십시오. 그들이 성공하기 위해 알아야 할 것을 보여주십시오.
• 일반 언어를 사용하는 것을 잊지 마십시오. 8학년 이하를 대상으로 작성하십시오. 고급 독자에게도 간단한 언어는 더 빠른 처리와 더 나은 이해로 이어집니다.
• 디자인은 만족스럽고 위협적이지 않아야 하며 사용자를 끌어들여야 합니다. 사용자가 문서를 사용하고 싶게 만드십시오.

3단계: 테스트

사용자 가이드는 고객이 최대한 제품을 사용하는 데 도움이 되는 경우에만 유용합니다. 그리고 누군가가 그것을 사용하기 전까지는 알 수 없습니다. 당신의 새로운 창조물이 세상에 널리 퍼지기 전에 당신은 그것을 테스트하기를 원합니다. 다음은 몇 가지 팁입니다!

• 모범 사례: 실제 사용자 또는 베타 테스터 그룹에게 제공하고 그들이 어떻게 하는지 확인하십시오. 완성된 문서에 피드백을 통합합니다.
• 베타 테스트 사용자 피드백이 없는 경우 내부적으로, 가급적이면 제품에 가장 익숙하지 않은 직원과 함께 테스트하십시오.
• 개발자와 엔지니어로부터 피드백을 받으세요. 그들은 누구보다 제품을 잘 알고 있으며 놓친 부분을 지적할 수 있습니다.

4단계: 문서를 최신 상태로 유지

제품이 변경되면 사용자 설명서를 최신 상태로 유지해야 합니다. 위에서 언급했듯이 이것은 전자 문서가 인쇄에 비해 큰 이점을 제공합니다. 그러나 인쇄 전용 문서라도 웹사이트에서 업데이트하고 다운로드할 수 있습니다.

귀하의 콘텐츠는 정확할 때만 훌륭하다는 것을 기억하십시오. 고객에게 제공하는 것이 실제로 제품을 사용하는 데 도움이 되는지 확인하십시오.

요약

다른 것이 기억나지 않는다면 훌륭한 사용자 문서는 사용자에게 가장 도움이 되는 방식으로 작성, 설계 및 제공되어야 한다는 점을 명심하십시오 .

고객을 계속 기쁘게 하고 원하는 종류의 고객 경험을 제공하는 문서를 제공하십시오.

문서를 접근 가능하고 유용하며 시각적으로 만드십시오.

자주 묻는 질문