간단한 단계별 가이드¶

드디어 여러분의 멋진 제품에 대한 새로운 사용자 가이드를 작성하기로 결정하셨군요.

2021년에도 사용자 가이드 작성은 여전히 대부분 수동 작업이라는 사실을 깨닫게 됩니다. 사용자 가이드를 만들기 위해 가장 적합한 앱을 선택하고 콘텐츠를 작성하기 시작합니다.

그럼 어떻게 시작하고, 왜 시작하며, 왜 사용자 가이드가 필요한 걸까요? 이 글에서는 사용자 가이드 작성에 관한 일반적인 질문에 답하고, Docsie에서 첫 번째 사용자 가이드를 만드는 방법을 안내해 드리겠습니다. 물론 다른 도구를 사용해도 됩니다.

사용자 가이드 작성의 이유와 이점¶

사용자 가이드를 작성하는 이유는 다양합니다. 사용자 가이드는 소비자, 전자제품, 소프트웨어 프로그램 및 모든 유형의 유형/무형 제품에서 매우 중요한 역할을 합니다. 사용자 가이드는 제품 사용법이나 조립 방법에 대한 간단하고 단계적인 지침을 제공합니다.

고객은 여러분이 판매하는 제품, 제공하는 서비스, 또는 따라야 할 방법과 절차에 대해 배울 필요가 있습니다. 사용자 가이드는 고객이 제품의 다양한 기능과 특징을 어떻게 사용하고 배울 수 있는지 단계별로 알려줍니다.

적절한 사용자 가이드 작성은 제품의 법적 책임을 제한합니다:¶

사용자 가이드는 제품의 잘못된 사용에 대한 책임도 제한합니다. 제품을 부적절하게 사용하거나 조립하면 부상이나 심지어 사망을 초래할 수 있는 제품에는 사용자 가이드가 매우 유용합니다. 예를 들어, 고전압 장치, 화재 발생 장치, 레이저 등은 부적절한 사용으로부터 고객을 보호하기 위한 광범위한 매뉴얼이 필요합니다.

좋은 사용자 가이드는 시간을 절약합니다:¶

품질이 좋은 사용자 매뉴얼은 제품 사용법에 대한 지침을 공유하여 기술팀이 설명하거나 영업팀이 데모를 하는 데 많은 시간을 절약할 수 있습니다. 복잡한 소프트웨어 제품은 고객이 제품을 최대한 활용하는 방법을 배울 수 있도록 좋은 기술 사용자 가이드가 필요합니다. 소프트웨어는 일반적으로 많은 기능이 있으므로, 고객에게 유용한 정보를 제공하는 적절한 사용자 가이드는 장기적으로 고객 유지와 소프트웨어 및 복잡한 제품의 다양한 측면 설명에 시간을 절약하는 데 도움이 됩니다.

제품 사용법에 대한 고객 교육:¶

기술 제품에 대한 고객 교육은 매우 중요합니다. 적절한 사용자 가이드 없이는 고객이 숨겨진 기능들로 인해 혼란을 겪고 기술 제품의 전체 잠재력을 활용하는 방법을 모를 수 있습니다. 사용자 가이드는 고객이 제품의 다양한 기술적 측면을 쉽게 배우고, 제품을 더 깊이 이해해야 할 때 사용자 가이드를 활용할 수 있어 편안함을 느끼게 합니다. 이는 공식적인 서면 지침 없이 문제를 해결하려는 스트레스를 줄여줍니다. 또한 위험한 제품의 경우, 사용자 가이드는 위험한 방식으로 제품을 오용하는 것에 대한 경고를 제공할 수 있습니다.

훌륭한 사용자 가이드의 요소¶

사용자 가이드를 만들기 시작하려면 특정 고객을 위해 어떤 문제를 해결하려고 하는지 이해해야 합니다. 모든 것에 대한 모든 내용을 담은 사용자 가이드는 대상 독자를 포함해 아무도 이해할 수 없는 복잡한 혼란이 됩니다. Stripe나 Slack과 같은 최고 기업들이 작성한 온라인 사용자 가이드의 가장 좋은 예를 살펴보면 특정 패턴이 보입니다.

각 사용자 가이드는 특정 문제 해결에 집중합니다.

각 가이드는 어떤 역할을 해야 할까요? 이 가이드를 따르면서 사용자가 수행할 수 있는 간단한 작업에 집중해야 합니다. 복잡할 필요가 없습니다. 오히려 제품의 일반적인 간단한 문제를 해결하는 데 도움이 되는 일반적인 간단한 작업에 집중하면, 고객이 좋아할 멋진 사용자 가이드 세트를 갖게 될 것입니다.

그럼 몇 가지 사용자 가이드를 자세히 살펴보고, 우리가 참고할 수 있는 훌륭한 사용자 가이드의 구조가 무엇인지 이해해 봅시다.

훌륭한 사용자 가이드에는 무엇이 포함될까요?¶

위의 '책 관리 가이드'를 살펴보고 몇 가지 요점을 생각해 봅시다.

사용자 가이드 구성하기¶

Docsie를 사용하여 사용자 가이드 만들기

Docsie는 멋진 사용자 가이드를 만들 수 있는 다양한 도구와 기능을 제공합니다. 먼저 Docsie가 어떻게 작동하는지 살펴보겠습니다. Docsie는 책, 책장, 컬렉션이라는 개념으로 작동합니다.

컬렉션은 다양한 유형의 고객에게 보여주고 싶은 여러 책을 분리하는 데 사용됩니다. 예를 들어, 이 컬렉션은 비즈니스 사용자에게만 보여주기 위해 사용됩니다. 이는 생성된 모든 책 중에서 특정 고객에게 보여줄 3권의 책만 선택했다는 의미입니다.

이는 제품의 다양한 등급을 사용하는 여러 유형의 고객이 있을 때 유용합니다. Docsie에서는 "All" 옆에 있는 세 개의 점을 클릭하고 추가를 누르면 쉽게 할 수 있습니다.

Docsie의 Collection 도구 모음에 있으면 컬렉션 이름을 생성하고 이 특정 컬렉션에 포함할 사용자 가이드를 선택할 수 있습니다. 이것이 중요한 이유는 다양한 고객이 제품의 다양한 사용자 가이드를 알아야 할 수 있기 때문에, 이 도구를 통해 그들이 보아야 할 특정 사용자 가이드만 보여줄 수 있습니다.

이제 Docsie의 "Book"으로 첫 번째 사용자 가이드 작성을 시작해 봅시다.

책은 사용자 가이드나 매뉴얼로 생각하세요. 열린 책 안에서 에디터, '아티클'과 헤더를 만드는 공간을 볼 수 있습니다.

위쪽에 에디터, 왼쪽 상단 모서리에 다양한 버전과 언어를 만드는 기능, 그리고 왼쪽에 "아티클 및 하위 제목" 섹션이 있습니다.

에디터는 사용하기 쉽고, 간단한 드래그 앤 드롭 과정으로 비디오, 사진, 코드를 추가할 수 있습니다. 또한 원하는 대로 콘텐츠 스타일을 지정할 수 있습니다.

아티클은 만들기 매우 쉽습니다. 제목만 입력하면 됩니다. 이 경우 유형은 "What is Docsie"이지만 사용자 가이드 제목으로 원하는 것을 입력할 수 있습니다.

사용자 가이드에 1.1, 1.2 등으로 표시될 하위 섹션을 만들려면 텍스트 위치를 선택하고 텍스트를 '헤더'로 설정하면 됩니다. 에디터 탭에서 H를 클릭하면 됩니다.

Docsie는 또한 사용자 가이드의 다양한 버전과 언어를 만들 수 있게 해줍니다. 이는 현지화와 제품 사용자 가이드의 다양한 변형에 대해 이야기하는 데 매우 유용합니다.

사용자 가이드를 준비하고, 작성하고, 제품의 다양한 측면과 기능을 설명하는 데 도움이 되는 사진으로 스타일을 지정한 후 다음 단계는 출판입니다.

요약: 사용자 가이드 작성을 위한 팁과 요령¶

대부분의 소프트웨어와 기술 제품은 매우 복잡하고 다양한 측면을 가지고 있습니다. 복잡한 제품에 대한 사용자 가이드를 만들 때 정보와 지침을 더 작은 부분으로 나누는 것이 좋습니다. 기본적으로 다양한 작은 사용자 가이드를 만들어 사용자 가이드 매뉴얼 설정으로 컴파일합니다.

고객은 여러분의 제품이나 서비스에 익숙하지 않습니다. 제품이 기술적일수록 사용자 가이드는 더 자세하게 작성해야 합니다. 모호한 단어와 표현은 이 과정에서 도움이 되지 않습니다. 가능한 한 구체적으로 작성하여 고객이 제품의 기본적인 측면까지도 이해할 수 있도록 하세요.

한 장의 사진은 천 마디 말보다 가치가 있습니다. 이는 특히 사용자 가이드와 매뉴얼에서 사실입니다. 이 단계는 대부분의 회사에서 크게 간과되지만, 사용자 가이드에서 제품 기능과 측면을 설명하면서 적절한 사진이나 스냅샷을 갖는 것은 매우 중요합니다. 이를 통해 고객은 여러분이 언급하는 제품의 어떤 측면을 이해할 수 있습니다.

사용자 가이드는 고객이 제품의 다양한 용도를 이해하도록 돕기 위해 설계되었습니다. 고객이 다양한 기능과 측면을 쉽게 이해할 수 있도록 가능한 한 간단하게 설명하세요.