제품 문서 궁극적인 가이드: 훌륭한 문서를 만들기 위해 알아야 할 모든 것

제품 문서... 비즈니스를 운영하는 데 있어 가장 섹시한 부분은 아닐 수 있지만 비즈니스를 성공시키려면 간과해서는 안 되는 핵심 영역입니다.

고품질 제품 문서를 작성하면 고객을 보다 성공적으로 만들고 지원 부담을 줄이며 일반적으로 더 나은 비즈니스를 구축하는 데 도움이 될 수 있습니다.

그러나 제품 문서를 만드는 데 필요한 것은 무엇입니까? 그리고 어떻게 웹사이트에 자신만의 문서를 설정할 수 있습니까?

이는 제품 설명서에 대한 궁극적인 가이드에서 답변할 몇 가지 질문에 불과합니다. 다룰 내용은 다음과 같습니다.

• 제품 문서화 전략에 관심을 가져야 하는 이유
• 최고 수준의 문서에 대한 몇 가지 실제 예
• 최고의 제품 문서화 소프트웨어
• 더 나은 문서를 만들기 위한 8가지 팁

비즈니스에서 문서를 처리하는 방식을 개선할 준비가 되셨습니까? 파헤쳐보자!

제품 문서화 전략에 관심을 가져야 하는 이유

제품 문서화 전략을 게을리해서는 안 되는 이유를 살펴보고 시작하겠습니다.

그것은 당신의 고객을 더 성공적으로 만듭니다

제품 문서 작성의 가장 큰 이점은 고객이 보다 성공적으로 수행할 수 있다는 것입니다. 더 성공적인 고객이 있다는 것은 더 높은 전환율, 더 낮은 이탈율 등을 의미합니다.

그것은 의미가 있습니다. 고객이 제품에서 가치를 얻는 방법을 이해하지 못한다면 고객으로 오래 머물지 못할 것입니다.

제품 문서는 고객이 최대한 많은 가치를 얻을 수 있도록 교육하는 유용한 방법 중 하나입니다. 그들이 당신의 제품에서 더 많은 가치를 얻으면 계속 돈을 지불하고 친구/동료에게 당신을 추천할 가능성이 더 높아집니다.

지원 부담을 줄여줍니다.

제품 문서는 또한 인적 지원 채널의 부담을 줄이는 좋은 방법이 될 수 있습니다.

제품 문서의 품질이 낮거나 존재하지 않는 경우 문제가 발생할 때마다 고객이 인적 지원 팀에 연락해야 함을 의미합니다. 즉, 지원 요청에 응답하는 데 더 많은 시간이 소요됩니다.

이러한 응답을 스스로 처리하기 위해 비즈니스 성장에서 시간을 할애하거나 전담 지원 담당자를 고용해야 합니다( 비용이 많이 듦 ).

고품질 문서를 ​​통해 고객은 자신의 많은 문제를 해결할 수 있으므로 지원을 요청할 필요가 없습니다. 또한 사람들이 요청하기 전에 문서를 확인하도록 지원 프로세스를 구성할 수 있습니다.

좋은 마케팅 및 판매 도구가 될 수 있습니다

많은 사람들이 이미 구매를 결정한 사람들을 돕는 맥락에서 제품 설명서를 생각하지만, 좋은 제품 설명서는 애초에 더 많은 고객을 유치하고 전환하는 데 도움이 될 수도 있습니다.

마케팅 관점에서 제품 문서는 문서 순위를 매길 수 있는 롱테일 SEO 키워드의 금광입니다. Google의 제품 설명서에 직접 방문하는 사람들의 수에 놀랄 수 있습니다. 문서를 잘 구성하면 이러한 사람들을 고객으로 전환할 수 있습니다.

문서는 또한 제품 구매를 망설이는 사람들에게 유용한 판매 도구가 될 수 있습니다. 제품 문서는 그들이 가질 수 있는 잠재적인 사전 판매 질문을 해결하고, 당신의 제품이 그들이 필요로 하는 것을 할 수 있다고 확신시키며, 그들이 필요할 때 도움을 받을 것이라는 확신을 줄 수 있습니다.

예를 들어 Stripe는 최고의 제품 설명서를 제공하는 것으로 유명합니다. Twitter에 가보면 Stripe 문서의 품질 때문에 Stripe을 추천하는 사람들을 많이 볼 수 있습니다.

직원의 효율성을 높여줍니다.

제품 설명서는 고객만을 위한 것이 아니라 팀 구성원이 제품에 대해 배우고 필요할 때 참조할 수 있는 중요한 리소스가 될 수도 있습니다. 이것은 특히 제품에 대한 광범위한 지식이 없는 신입 직원에게 해당됩니다.

네 가지 훌륭한 실제 제품 문서 예제

더 많은 영감을 주기 위해 성공적인 회사의 실제 제품 설명서 예를 살펴보겠습니다.

1. 스트라이프

우리는 이전에 Stripe를 마케팅/판매 도구로서 고품질 문서의 가장 좋은 예 중 하나로 언급했으므로 Stripe 문서가 우리 목록에서 1위를 차지해야 한다는 것을 알고 있습니다.

2. 아디엔

Adyen은 전자상거래, 모바일 및 POS(point-of-sale) 결제를 위한 결제 플랫폼입니다. Stripe와 마찬가지로 개발자는 이를 자체 플랫폼에 통합해야 하며 이를 위해서는 우수한 문서가 필요합니다. Adyen은 실망시키지 않습니다. 여기에서 전체 Adyen 설명서를 확인하십시오.

3. 트윌리오

Twilio에 익숙하지 않다면 기업에서 문자 메시지, 이메일, 전화 통화 등을 통해 플랫폼에 커뮤니케이션을 구축하는 데 도움이 되는 도구입니다. Stripe 및 Adyen과 마찬가지로 이는 기업이 Twilio를 기존 서비스에 통합해야 함을 의미하며, 이를 위해서는 최고 수준의 문서가 필요합니다. Twilio 문서를 탐색하여 훌륭한 예를 볼 수 있습니다.

4. 여유

Slack은 매우 잘 작성되고 유용한 문서가 있는 또 다른 도구입니다. 여기에서 전체 Slack 문서를 찾아볼 수 있습니다.

더 많은 예제를 보려면 최고의 사용자 문서 예제에 대한 전체 게시물을 확인하세요.

최고의 제품 문서화 소프트웨어

이제 사이트에서 더 나은 제품 설명서를 제공할 수 있는 방법을 살펴보겠습니다.

다음 섹션에서 실제로 문서를 작성하는 방법에 대해 이야기하겠습니다. 그러나 문서를 작성하기 전에 해당 문서를 저장하고 사용자가 액세스할 수 있도록 할 장소가 필요합니다.

이러한 기사를 사이트에 직접 추가할 수도 있지만 전용 제품 문서 소프트웨어를 사용하는 것이 훨씬 더 좋습니다. 콘텐츠를 구성하고 방문자가 액세스할 수 있도록 하는 것 외에도 우수한 제품 문서 소프트웨어에는 다음과 같은 다른 유용한 기능이 포함됩니다.

• 방문자가 문서를 탐색하는 데 도움이 되는 Ajax 검색 기능.
• 사람들이 찾고 있는 주제를 볼 수 있도록 분석을 검색하십시오.
• 각 개별 문서가 얼마나 도움이 되는지 추적하고 필요할 때 개선할 수 있도록 도움이 되는 데이터.

여기에 두 가지 최고의 솔루션이 있습니다.

영웅 기술 자료(영웅 KB)

Heroic Knowledge Base는 자체 호스팅 제품 문서 허브를 쉽게 만들 수 있는 무료 오픈 소스 WordPress 소프트웨어용 플러그인입니다.

비즈니스 웹사이트에 이미 WordPress를 사용하고 있다면 사이트에 Heroic Knowledge Base를 추가하여 자신만의 문서 허브를 만들 수 있습니다. 또는 그렇지 않은 경우 문서용 전용 WordPress 설치를 만들 수 있습니다. 후자의 경우 KnowAll WordPress 문서 테마 에 관심이 있을 수도 있습니다.

Heroic Knowledge Base를 사용하면 WordPress의 콘텐츠 편집기를 사용하여 모든 문서를 추가할 수 있으므로 필요한 경우 멀티미디어 콘텐츠를 쉽게 포함할 수 있습니다. 또한 변경 사항을 쉽게 추적하고 문서의 이전 버전을 비교할 수 있는 WordPress의 내장 콘텐츠 버전 관리 시스템에 액세스할 수 있습니다.

Heroic Knowledge Base는 또한 다음과 같은 여러 가지 유용한 기능을 추가합니다.

• 즉각적인 Ajax 검색.
• 검색 분석.
• 기사 유용성 등급.
• 기사 파일 첨부.

Heroic Knowledge Base 비용은 $129입니다.

어도비 로보도움말

문서를 웹에만 게시하는 경우 Heroic Knowledge Base와 같은 솔루션만 있으면 됩니다. 그러나 더 많은 엔터프라이즈 수준의 문서가 필요한 경우 웹, 실제 종이, 모바일 앱, PDF 등을 비롯한 여러 플랫폼에 문서를 게시해야 하는 상황이 있을 수 있습니다.

이 경우 Adobe RoboHelp와 같은 다중 플랫폼 문서 작성 도구를 선호할 수 있습니다. 개인 사용의 경우 월 $29.99부터 시작하며 Heroic Knowledge Base보다 비쌉니다. 그러나 다중 플랫폼 저작이 필요한 경우 추가 비용을 지불할 가치가 있습니다.

제품 문서 구조 및 콘텐츠를 최적화하는 방법

이제 문서를 관리하는 데 필요한 소프트웨어가 있으므로 고품질 기사를 작성하는 방법에 대해 이야기해 보겠습니다. 다음은 문서를 구조화하고 더 나은 도움말 기사를 작성하기 위한 8가지 핵심 팁입니다...

1. 청중 이해하기

훌륭한 제품 문서를 작성하려면 작성 대상(즉, 고객)을 이해해야 합니다.

누구를 위해 작성하는지에 따라 포함하는 정보와 모든 것을 구성하는 방법에 영향을 미칩니다. 예를 들어 개발자를 위해 작성하는 경우 문서는 일반 사용자에게 작성하는 것과 근본적으로 달라야 합니다.

청중이 전문가라고 가정하고 주요 세부 사항을 간과하고 싶지는 않지만 청중이 누구인지에 따라 몇 가지 기본 지식이 있다고 가정할 수 있습니다.

2. 다양한 제품 문서 유형 이해

다양한 제품 문서 유형이 있으며 각각 다른 접근 방식이 필요합니다. 일반적인 유형은 다음과 같습니다.

• 개요 – 이 문서는 "시작하기" 가이드와 같이 제품 영역의 작동 방식에 대한 개요를 제공합니다.
• 단계별 자습서 – 이 기사는 사람들에게 특정 작업을 수행하는 방법을 보여줍니다.
• 참조 – 이 문서에서는 제품의 특정 개념을 설명합니다.
• 문제 해결 – 이 문서에서는 고객이 겪을 수 있는 일반적인 문제를 디버그/문제 해결하는 방법을 설명합니다.

작업 중인 문서 유형은 문서 작성 방법과 문서 구성 방법에 영향을 미치므로 자세히 알아보기 전에 목표가 무엇인지 아는 것이 중요합니다.

3. 스타일과 명명 규칙을 일관되게 유지하십시오.

고객이 제품 문서를 더 쉽게 사용할 수 있도록 문서 전체에서 동일한 스타일과 명명 규칙을 유지하는 것이 중요합니다. 이렇게 하면 고객이 문서를 더 쉽게 따르고 잠재적인 혼동을 피할 수 있습니다.

이를 돕기 위해 기본 형식 및 용어에 대한 스타일 가이드를 작성하는 것이 유용할 수 있습니다.

4. 평이한 언어를 사용하고 간결하게 유지

모든 것이 평등하고 짧고 단순한 언어가 단어 샐러드보다 항상 낫습니다. 귀하의 목표는 가능한 한 적은 단어로 필요한 모든 정보를 전달하는 것이어야 합니다.

또한 가능하면 전문 용어나 복잡한 용어를 사용하지 않아야 합니다. 모든 고객이 동일한 지식 기반을 갖고 있는 것은 아니며 일부는 문서 언어를 모국어로 사용하지 않을 수도 있습니다. 따라서 최대한 단순하게 유지하면 모든 사람이 문서에서 가치를 얻을 수 있습니다.

5. 논리적인 "문제 크기" 문서로 문서 구성

사람들이 문서를 보다 쉽게 ​​탐색하고 특정 문제에 대한 기사를 찾을 수 있도록 문서를 논리적 세그먼트로 분할해야 합니다. 일반적으로 각 기사는 하나의 특정 문제를 해결하는 데 중점을 두어야 합니다.

물론, 그 주요 문제 내에 여러 하위 문제가 있을 수 있지만, 아이디어는 사람들이 해당 주제를 검색하기 어렵게 만들기 때문에 완전히 별개의 두 문제를 동일한 기사로 묶는 것을 원하지 않는다는 것입니다. 기사에 도착하면 혼란스러울 수 있습니다.

고객은 책을 읽는 것처럼 선형 방식으로 문서를 읽지 않을 것입니다. 대신 현재 직면하고 있는 문제를 기반으로 이동합니다. 기사를 논리적 세그먼트로 나누면 이러한 행동을 설명하는 데 도움이 됩니다.

6. 멀티미디어 요소 통합

서면 텍스트는 제품 문서의 핵심을 구성해야 하지만 유일한 것은 아닙니다. 적절한 위치에 이미지 및 비디오 콘텐츠를 포함하는 것도 도움이 될 수 있습니다.

스크린샷을 포함하는 경우 이미지에 주석을 추가하여 주요 세부 정보를 명확히 할 수도 있습니다.

7. 제목 사용 및 목차 추가

개별 제품 문서 기사 내에서 하나의 긴 텍스트 벽을 작성하는 대신 표제를 사용하여 기사를 논리적 세그먼트로 나누십시오.

사람들이 기사를 탐색하는 데 도움이 되도록 독자가 특정 섹션으로 빠르게 이동할 수 있도록 목차를 추가할 수도 있습니다.

일부 제품 설명서 소프트웨어는 자동으로 목차를 추가하는 데 도움이 될 수 있습니다. 예를 들어 Heroic Knowledge Base 플러그인에는 각 기사의 제목을 기반으로 목차를 자동으로 생성하는 기능이 내장되어 있습니다.

8. 항상 문서를 개선하고 업데이트하십시오.

마지막으로 제품 문서 작성은 일회성 이벤트가 아니라는 점을 기억하는 것이 중요합니다. 진행중인 과정입니다.

기본 수준에서 제품이 변경될 수 있으므로 이러한 변경 사항과 추가한 새 기능을 설명하도록 설명서를 업데이트하는 것이 중요합니다.

그러나 그 외에도 Heroic Knowledge Base와 같은 제품 문서 소프트웨어를 선택하면 사람들이 문서를 사용하는 방식을 이해하는 데 도움이 되는 분석에 액세스할 수 있습니다. 이러한 분석을 사용하여 다음을 수행할 수 있습니다.

1. 사람들이 무엇을 검색하는지 추적하십시오. 아직 수행하지 않은 경우 해당 주제에 대한 문서를 작성해야 한다는 신호일 수 있습니다.
2. 어떤 기사가 사용자에게 원하는 만큼 도움이 되지 않는지 확인하십시오. 이는 기사의 유용성을 향상시키기 위해 해당 기사를 개선해야 한다는 신호일 수 있습니다.

지금 멋진 제품 문서 작성을 시작하십시오!

고품질 제품 문서를 작성하는 것은 비즈니스의 장기적인 성공을 위한 투자입니다. 그것은 당신을 돕습니다…

• 고객을 더 성공적으로 만드십시오.
• 지원팀의 부담을 줄이십시오.
• 우선 더 많은 고객을 유치하고 전환하십시오.
• 제품에 대한 직원의 지식을 향상시키십시오.

이 게시물에서 성공적인 회사의 제품 문서에 대한 몇 가지 훌륭한 예와 함께 문서를 작성하고 구성하는 방법에 대한 몇 가지 팁을 공유했습니다.

자체 제품 문서 허브를 만들 준비가 되었다면 Heroic Knowledge Base 플러그인을 사용하여 WordPress에서 제공하는 자체 호스팅 솔루션을 구축할 수 있습니다. Heroic Knowledge Base에 대해 자세히 알아보려면 클릭하세요.