사용 설명서 작성 방법: Zero에서 Hero까지(전체 가이드)

고객이 제품에서 더 많은 가치를 얻을 수 있도록 사용자 설명서를 만드는 방법을 모르십니까?

사용자 매뉴얼은 고객(또는 직원)이 제품이나 서비스를 효과적으로 사용하는 데 도움이 되는 콘텐츠입니다. 사용 설명서, 사용 설명서, 제품 설명서 등으로 불리는 것을 볼 수도 있습니다.

고객이 제품을 효과적으로 사용하도록 돕는 것 외에도 고품질 사용자 설명서를 작성하면 사용자가 지원에 연락하지 않고도 문제를 해결할 수 있으므로 고객 서비스 및 지원 요청을 줄이는 데 도움이 될 수 있습니다.

이 세부 가이드에서는 고객이 성공을 달성하는 데 도움이 되는 사용 설명서를 만드는 방법을 배웁니다.

이를 위해 우리가 다룰 내용은 다음과 같습니다.

• 다양한 유형의 사용 설명서
• 사용 설명서를 게시할 위치
• 사용 설명서를 만드는 방법

파헤쳐 보자!

다양한 유형의 사용 설명서

고객 대상 및 내부 콘텐츠를 포함하여 다양한 유형의 사용자 설명서가 있습니다.

시작하기 전에 어떤 유형의 매뉴얼을 만들고 싶은지 이해하는 것이 중요합니다. 이는 콘텐츠에 접근하는 방식에 영향을 미치기 때문입니다.

다음은 다양한 유형의 사용 설명서에 대한 간략한 요약입니다.

• 사용 설명서 – 고전적인 사용 설명서는 사용자에게 제품 사용 방법을 알려줍니다.
• 교육 매뉴얼 – 교육 매뉴얼은 사용자에게 특정 작업을 수행하거나 특정 작업을 완료하는 방법을 알려줍니다.
• 운영 매뉴얼 – 운영 매뉴얼은 일반적으로 회사 운영을 문서화하는 내부 매뉴얼입니다.
• 서비스 설명서 – 서비스 설명서는 제품 수명 주기의 여러 시점에서 제품을 적절하게 유지 관리하는 방법을 사용자에게 가르치는 데 중점을 둡니다.
• 표준 운영 절차(SOP) – SOP는 조직 구성원에게 특정 프로세스를 "올바른 방법"으로 적절하게 완료하는 방법을 가르치는 내부 매뉴얼입니다.

아래 지침의 경우 대부분 공개 사용자 설명서를 만드는 데 관심이 있습니다. 그러나 아래의 기본 원칙은 모든 유형의 사용 설명서에 적용됩니다.

사용 설명서를 게시할 위치

사용자 매뉴얼을 게시하는 위치는 작성 중인 사용자 매뉴얼의 유형에 따라 다릅니다.

고객용 사용 설명서의 경우 거의 항상 웹 사이트에 게시하고 싶을 것입니다. 그렇게 하면 사용자는 어디에서나 설명서에 액세스할 수 있습니다.

또한 웹에 사용 설명서 콘텐츠를 게시하면 클릭할 수 있는 목차 및 실시간 검색 제안을 추가하는 등 실제 사용 설명서보다 더 사용자 친화적인 환경을 만들 수 있습니다.

그러나 실제 제품의 경우 웹 기반 설명서와 함께 실제 사용 설명서를 포함할 수도 있습니다.

내부 사용자 매뉴얼의 경우 일반적으로 공개되지 않도록 숨기고 싶을 것입니다.

이를 달성하는 한 가지 방법은 회사 인트라넷에서만 사용할 수 있도록 하는 것입니다. 그러나 집에서 일하는 사람이 너무 많기 때문에 회사에 자체 VPN 설정이 없으면 이 작업을 수행하기 어려울 수 있습니다.

대신 직원이 사용자 계정에 로그인하도록 요구하거나 페이지에 액세스하기 위해 암호를 추가하여 콘텐츠를 암호로 보호하는 것을 고려할 수 있습니다.

실제 사용 설명서의 경우 전용 지식 관리 도구를 사용하여 보다 복잡한 설명서를 게시할 수 있습니다. 또는 간단한 사용 설명서의 경우 Google 문서도구에 작성하고 거기에서 게시할 수 있습니다. 기술 문서 작성 도구 컬렉션에는 삶을 더 쉽게 만들어주는 몇 가지 유용한 도구가 있습니다.

사용 설명서를 온라인으로 게시하려면 대부분의 문서 또는 지식 기반 소프트웨어를 사용할 수 있습니다. 공개 및 내부 사용자 설명서를 모두 처리할 수 있는 도구를 원하는 경우 WordPress용 오픈 소스 Heroic Knowledge Base 플러그인을 고려할 수 있습니다. 이에 대해서는 튜토리얼에서 더 자세히 설명하겠습니다.

다음은 Heroic Knowledge base(및 Heroic Knowledge Base에 대한)의 온라인 사용 설명서의 예입니다.

튜토리얼에 대해 말하자면…

6단계로 사용 설명서를 만드는 방법

이제 몇 가지 배경 정보가 있으므로 사용 설명서를 작성하는 방법에 대해 알아보겠습니다. 0부터 시작하여 완성된 사용 설명서로 이동합니다.

1. 사용자 페르소나 만들기

콘텐츠 생성을 시작하기 전에 사용자 페르소나를 생성하여 달성할 수 있는 콘텐츠가 누구를 위한 것인지 이해하려고 합니다.

고객이 누구인지 이미 잘 알고 있을 수 있지만 실제로 노력을 집중하기 위해 이를 적어 두는 것이 좋습니다.

이것이 왜 중요한가요?

예를 들면 다음과 같습니다.

기계 엔지니어를 위한 기술 콘텐츠를 만드는 것과 비기술 사용자를 위한 기술 콘텐츠를 만드는 것에는 큰 차이가 있습니다.

대부분의 제품에서 그 차이는 그다지 뚜렷하지 않습니다. 그러나 실제로 사용하게 될 사람들이 사용 설명서를 이해할 수 있도록 고객 특성을 이해하는 것은 여전히 ​​중요합니다.

2. 주요 문제 및 목표 식별

고객이 누구인지 이해했다면 다음 단계는 만들 사용자 설명서를 통해 고객이 달성하려는 것이 무엇인지 이해하는 것입니다.

즉, 이 매뉴얼을 읽을 사람들의 최종 목표(또는 최종 목표)는 무엇입니까?

설명서의 목적은 사용자가 가능한 한 효율적으로 해당 목표를 달성하도록 돕는 것이기 때문에 이를 이해하는 것이 중요합니다.

경우에 따라 이 최종 목표는 특정한 것일 수 있습니다. 예를 들어 소셜 미디어 관리 도구가 있는 경우 "소셜 미디어에 게시물 예약"일 수 있습니다.

다른 경우에는 "프로젝트 관리 프로세스 개선"과 같은 보다 추상적인 목표일 수 있습니다.

더 큰 제품의 경우 사용자가 달성하려고 하는 여러 가지 사항이 있을 수 있으며 이에 따라 다음 섹션으로 이동합니다.

3. 논리적 구조 및 계층 구조 만들기

이제 고객이 누구이며 그들이 달성하고자 하는 것이 무엇인지 이해했으므로 사용 설명서의 구조를 매핑할 수 있습니다.

이전 섹션에서 나열한 최종 목표를 달성하기 위해 "0"에서 사용자를 데려가는 구조를 만들고 싶습니다.

다음은 이를 수행하는 데 도움이 되는 몇 가지 팁입니다.

1. 고객이 가능한 한 빨리 제품에서 가치를 얻도록 돕는 방법에 대해 생각하십시오.
2. 그것에서 자신의 개인적인 지식을 가져 가라. 귀하는 분명히 귀하의 제품에 대해 많은 것을 알고 있지만 귀하의 고객은 그러한 수준의 배경 지식을 가지고 있지 않을 것입니다.
3. 고객이 제품을 사용하려고 할 때 발생할 수 있는 일반적인 문제나 혼란스러운 세부 사항을 다루어야 합니다. 이러한 문제는 고객이 문제에 부딪힐 가능성이 가장 높은 시점에 논리적으로 해결되어야 합니다.

4. 사용 설명서 내용 작성

콘텐츠를 매핑하면 작성을 시작할 준비가 된 것입니다.

제품/조직의 규모에 따라 모든 것을 직접 작성할 수 있습니다. 또는 콘텐츠를 작성하기 위해 다른 팀 구성원과 협력해야 할 수도 있습니다.

다음은 사용 설명서를 작성할 때 고려해야 할 몇 가지 일반적인 사용 설명서 모범 사례입니다.

• 템플릿을 사용하여 일관된 형식을 유지하십시오 . 형식이 지정된 템플릿을 만들면 작업 속도가 빨라질 뿐만 아니라 매뉴얼의 각 항목이 다른 항목과 일관성을 갖게 됩니다.
• 사용자에게 도움이 되는 시각 자료(이미지 및 동영상)를 포함합니다 . 주석이 잘 달린 이미지나 GIF는 텍스트가 아무리 자세하고 철저하더라도 독립형 텍스트 지침보다 더 유용할 수 있습니다.
• 평이한 언어를 사용하고 전문 용어를 사용하지 마십시오 . 또는 전문 용어가 완전히 불가피한 경우에는 반드시 설명하십시오.
• 짧고 요점만 유지하십시오 . 사용 설명서의 목표는 주제를 완전히 다루는 것이지만 가능한 한 적은 단어로 작성해야 합니다. 중요한 정보는 빠뜨리지 말고 불필요한 내용은 과감히 잘라낸다.
• 가능한 경우 지침에 글머리 기호와 목록을 사용하십시오 . 번호 매기기 또는 글머리 기호 목록을 사용하면 사용자가 가이드를 쉽게 추적할 수 있습니다. 또는 목록에서 허용하는 것보다 더 자세한 정보가 필요한 경우 각 단계에 고유한 하위 제목을 만들 수 있습니다.
• 능동태를 ​​사용하십시오 . 수동태는 사용 설명서의 지침에 대해 특히 혼란스러울 수 있습니다. "빨간색 버튼을 눌러 제품을 켤 수 있다"와 "빨간색 버튼을 눌러 제품을 켤 수 있다"의 차이입니다. 후자의 예(능동태)는 더 명확하며 독자가 지침에 자신을 더 쉽게 넣을 수 있도록 합니다.

마지막으로 처음 사용하는 것처럼 사용 설명서 지침을 테스트하는 것이 좋습니다.

즉, 기사를 작성한 후에는 뒤로 돌아가서 해당 지침을 단계별로 실제로 따라 누락된 사항이 없는지 확인하십시오.

5. 사용 설명서 게시

콘텐츠를 확보한 후 게시하기 위한 마지막 단계는 고객이 쉽게 사용할 수 있도록 사용 설명서를 게시하는 것입니다.

이를 수행하는 방법은 제공하는 제품 유형에 따라 다릅니다. 예를 들어 실제 제품을 배송하는 경우 설명서의 실제 버전을 포함할 수 있습니다.

그러나 어떤 유형의 제품을 제공하든 사람들이 쉽게 찾을 수 있도록 사용 설명서를 온라인에 게시하고 싶을 것입니다.

이를 돕기 위해 기술 자료/문서 소프트웨어를 사용할 수 있습니다.

예를 들어 Heroic Knowledge Base WordPress 플러그인을 사용하면 오픈 소스 WordPress 소프트웨어를 사용하여 사용자 설명서를 게시할 수 있습니다.

이 오픈 소스 접근 방식은 플랫폼에 대한 완전한 소유권과 제어권을 제공하는 동시에 고객이 사용자 설명서를 보다 효과적으로 탐색하는 데 도움이 되는 유용한 도구를 많이 제공합니다.

• 범주 구성 – 사용 설명서를 논리적 범주로 쉽게 구성하고 끌어서 놓기를 사용하여 해당 범주를 정렬할 수 있습니다.
• 실시간 검색 제안 – 고객이 특정 자습서로 바로 이동하려는 경우 검색어를 입력하기 시작하고 쿼리를 기반으로 실시간 검색 제안을 볼 수 있습니다.
• 자동 목차 – 플러그인은 각 사용 설명서 기사에 대해 클릭 가능한 목차를 자동으로 생성하여 독자가 관련 섹션으로 바로 이동할 수 있도록 도와줍니다.
• 간편한 콜아웃/서식 지정 – 콜아웃 및 기타 서식을 쉽게 추가하여 기사의 핵심 요소에 주의를 끌 수 있습니다.
• 인스턴트 답변 위젯 – 사이트에 전용 사용자 매뉴얼 페이지를 생성하는 것 외에도 방문자가 사이트 어디에서나 사용자 매뉴얼 콘텐츠를 탐색할 수 있도록 검색 가능한 인스턴트 답변 위젯을 추가할 수도 있습니다.

사용자 설명서를 게시하는 데 도움이 되는 소프트웨어에 대한 더 많은 옵션을 보려면 최고의 지식 기반 소프트웨어 및 최고의 문서화 도구에 대한 게시물을 읽을 수 있습니다.

6. 필요에 따라 사용 설명서 업데이트 및 수정

사용 설명서 작성은 일회성 작업이 아닙니다. 앞으로는 콘텐츠를 수정하고 업데이트하는 데 시간을 할애해야 합니다.

사용 설명서를 업데이트해야 하는 두 가지 주요 이유는 다음과 같습니다.

1. 제품에 새 기능을 추가했거나 기존 기능/인터페이스가 작동하는 방식을 변경했습니다.
2. 사용 설명서 내용을 개선하여 더 유용하게 만들고 싶습니다.

첫 번째 상황은 명백합니다. 어떤 식으로든 제품을 변경하는 경우 해당 변경 사항을 설명하기 위해 사용 설명서를 업데이트해야 합니다.

그러나 두 번째 상황도 고려하는 것이 중요합니다. 처음부터 모든 사용자 설명서 항목을 완벽하게 얻을 수는 없을 것입니다.

사용자를 더 잘 돕기 위해 실적이 저조한 수동 콘텐츠를 업데이트하고 수정하여 더 유용하게 만들 수 있습니다.

Heroic Knowledge Base와 같은 도구를 사용하여 사용자 설명서를 게시하는 경우 내장된 문서 유용성 등급이 포함되어 개선이 필요한 문서를 쉽게 확인할 수 있습니다. 또한 사용자는 기사에 텍스트 피드백을 남길 수 있으며, 이는 기사에서 도움이 되지 않는 특정 부분을 알려줄 수 있습니다.

사용자에게 문제가 있는 주제에 대한 기사가 누락될 수도 있습니다. 이러한 누락된 주제를 찾는 데 도움이 되도록 Heroic 지식 베이스에는 기본 제공 검색 분석이 포함되어 있어 주제 결과가 없는 검색(일반적인 전체 검색 포함 )을 추적할 수 있습니다.

오늘 사용 설명서 만들기

고객이 성공할 수 있도록 설정하려면 사용 설명서를 만드는 방법을 배우는 것이 중요합니다.

이 게시물의 팁과 모범 사례를 통해 이제 사용자 설명서를 시작하고 실행하는 데 필요한 지식을 갖게 되었습니다.

사용 설명서를 온라인에 게시하고 고객이 쉽게 탐색할 수 있도록 WordPress 및 Heroic Knowledge Base 플러그인을 사용할 수 있습니다.

Heroic Knowledge Base를 사용하면 기사를 쉽게 게시하고 필요에 따라 정리할 수 있습니다. 또한 고객은 실시간 검색 제안, 자동 목차 등과 같은 유용한 기능을 활용할 수 있습니다.

오늘 시작하면 곧 사용 설명서를 게시할 수 있습니다.

비즈니스의 내부 지식을 향상시키기 위해 문서를 작성하는 데 관심이 있는 경우 직원을 위한 교육 매뉴얼을 게시하는 방법에 대한 자습서에도 관심이 있을 수 있습니다.