12 최고의 문서 예
게시 됨: 2021-08-05고객이 제품이나 서비스의 문제에 대한 솔루션을 스스로 찾을 수 있습니까? 그리고 그들은 그렇게 빠르고 쉽게 할 수 있습니까?
이 두 질문에 모두 예라고 답하는 것은 훌륭한 고객 경험을 제공하고 고객 만족도를 높이는 데 큰 부분을 차지합니다. 그렇기 때문에 직원의 답변을 기다리지 않고 고객이 질문에 대한 답변을 찾도록 도와주는 문서를 보유하는 것이 중요합니다.
그러나 처음부터 온라인 문서를 작성하는 것은 대단한 일이 아닙니다. 이전에 성공적으로 수행한 브랜드를 살펴보는 것이 도움이 됩니다. 따라서 이 게시물에서는 다양한 문서 범주와 해당 범주에서 최고의 문서 예를 살펴보겠습니다. 또한 최고의 문서를 따라가서 자신만의 문서를 만드는 방법도 알아보겠습니다. 시작하자.
문서 유형
문서 예제로 넘어가기 전에 다양한 유형의 문서에 대해 배우는 것이 중요합니다. 이것은 귀하의 비즈니스에 가장 적합한 유형을 이해하는 데 도움이 될 것입니다.
사용자 문서
사용자 문서는 제품 또는 서비스의 최종 사용자에게 잠재력을 최대한 활용하는 데 필요한 도움을 제공하기 위해 사용자 설명서, 빠른 시작 가이드, 자습서, FAQ 및 기타 교육 자료를 만드는 것입니다.
개발자 문서
짐작할 수 있듯이 개발자 문서는 개발자가 일반적으로 API(응용 프로그래밍 인터페이스)를 통해 주어진 소프트웨어 라이브러리 또는 서비스를 사용하거나 통합하는 방법의 모든 측면을 이해하기 위한 것입니다. 개발자 문서에는 사용 사례, 인증, 문제 해결 정보 등과 같은 자료가 포함됩니다. 일반적으로 고객이 대면하는 사용자 문서보다 기술적인 문서로 구성됩니다.
기술 문서
기술 문서는 사용자 문서와 개발자 문서 중간 어딘가에 있으며 일반적으로 기술 작성자가 필요합니다. 제품과 관련된 기술 지침이나 개념을 비개발자도 이해할 수 있도록 이해하기 쉽게 설명하는 것을 목표로 합니다.
프로젝트 문서
프로젝트 문서에는 프로젝트에 대한 주요 세부 정보가 포함됩니다. 프로젝트를 적절하게 실행하기 위해 프로젝트 과정에서 필요한 것을 설명하는 포괄적인 문서를 만드는 것입니다. 프로젝트 문서화의 몇 가지 예에는 프로젝트 제안, 프로젝트 계획, 비즈니스 사례, 상태 보고서 등이 포함됩니다.
문서화의 이점
우리는 그것을 얻는다. 당신은 사업을 운영하느라 바쁘고 마지막으로 원하는 것은 상태 보고서, 가이드 등과 같은 것을 지속적으로 문서화해야 하는 것입니다. 그러나 예상치 못한 문제가 아무데도 발생하지 않을 때(그리고 그럴 것입니다) 귀하와 귀하의 사용자에게 대체할 문서가 있다는 사실에 기뻐할 것입니다. 다음은 적절한 문서의 우선 순위를 정할 때의 주요 이점입니다.
한 곳에서 지식
지식 근로자는 정보를 찾는 데 하루에 약 2.5시간을 소비하는 것으로 추정됩니다. 효과적인 문서화는 모든 필수 정보를 한 곳에서 수집하여 모든 사람에게 상당한 시간을 절약합니다.
생산성 향상
문서는 팀 구성원의 부재 또는 알려진 문제가 다시 발생하는 것과 같은 예기치 않은 이벤트가 발생하더라도 작업을 완료할 수 있도록 합니다. 자격 증명, 세부 정보 등을 추적하는 데 리소스를 낭비하지 않고 바퀴를 계속 움직일 수 있습니다.
만족도 향상
문서화는 고객의 만족과 만족을 유지하는 데 도움이 됩니다. 문서는 제품에서 최대한의 가치를 얻는 방법을 보여줌으로써 이탈률을 줄이고 고객 평생 가치를 높입니다.
이점을 제외하고 4가지 유형의 문서 각각에 대한 최상의 문서 예제로 바로 이동해 보겠습니다.
지식 기반을 구축하고 고객이 스스로 돕도록 하십시오.
플러그인 가져오기사용자 문서 예
Google은 소개가 필요 없습니다. 수백 가지 제품을 제공하며 각 제품에는 자체 설명서가 있습니다. Google 제품 문서에서 두드러지는 점은 사용자가 피드백을 제출하고 질문할 수 있는 정적 답변과 커뮤니티 포럼이 결합되어 있다는 것입니다.
Google 문서의 다른 주목할만한 기능은 다음과 같습니다.
- 사용자는 흔하지 않은 쿼리로 서로를 도울 수 있습니다. 이는 고객이 자신의 의견을 더 잘 듣고 문제를 제기할 수 있는 더 나은 기회를 제공합니다.
- Upvote 기능은 다른 사람들도 같은 문제에 직면하고 있는지 확인하고 가장 중요한 문제와 아이디어에 대한 지원을 수집하는 데 유용합니다.
- 고객은 토론에 대한 업데이트를 구독하거나 의견을 게시하여 추가 관점을 제공할 수도 있습니다.
스카이프
Skype는 비즈니스 회의, 교육 세션 및 개인 채팅과 같은 다양한 목적으로 사용되는 Microsoft의 인기 있는 화상 회의 소프트웨어입니다. Skype는 소프트웨어 문서가 다양한 탐색 및 정렬 옵션과 같은 사용자 친화적인 기능으로 로드되어 있으므로 훌륭한 문서 예제를 만듭니다.
기타 주의할 사항은 다음과 같습니다.
- 사용자는 문서가 도움이 되었는지 여부를 표시하고 피드백을 공유할 수 있습니다.
- 이동 경로 및 목차와 같은 기능을 통해 문서를 쉽게 탐색할 수 있습니다.
애플 아이폰
Apple의 iPhone은 직관적이고 사용자 친화적인 기능으로 유명하지만 적절한 문서를 무시할 수는 없습니다. 다행히도 Apple은 이를 이해하고 있으며 설명서는 iPhone만큼 간단하고 탐색하기 쉽습니다.
iPhone 문서의 주목할만한 측면은 다음과 같습니다.
- 사용자가 현재 설치한 iOS 버전을 선택하는 옵션이 있습니다. 이는 최종 사용자가 지침이 정확하고 관련성이 있는지 확인하는 데 도움이 됩니다.
- 목차는 다른 기능과 기기별 스크린샷을 참조하는 데 사용되었습니다.
- 문서가 쿼리에 응답하지 않는 경우 사용자는 지원 팀에 직접 문의할 수 있습니다.
개발자 문서 예
도커 문서
Docker는 애플리케이션을 빌드, 실행 및 제공하기 위한 개방형 플랫폼입니다. 소프트웨어를 신속하게 제공하기 위해 인프라에서 애플리케이션을 분리할 수 있습니다. Docker의 문서가 놀라운 시작을 제공하는 것은 야간 모드와 주간 모드 사이를 전환하는 기능입니다.
이 문서를 훌륭하게 만드는 다른 요소는 다음과 같습니다.
- 다양한 장의 끝에 요약 및 치트 시트 섹션이 있습니다. 이 섹션은 사용자가 놓쳤을 수 있는 개념을 강화하는 데 도움이 됩니다.
- 문서의 모든 페이지에 내부 링크가 제공되어 사용자가 정보를 쉽게 확장할 수 있습니다.
- 현재 페이지에서 제공되는 통찰력을 이해하는 데 필수적인 전제 조건 페이지 또는 장으로 돌아갈 수 있습니다.
헤로쿠 개발자 센터
Heroku는 개발자를 위한 강력하고 쉬운 애플리케이션 배포 서비스를 제공합니다. 그리고 개발자 센터에는 아름다운 문서 설정이 있습니다. 이 문서의 가장 큰 하이라이트는 다른 언어로 쉽게 전환할 수 있다는 것입니다.
Heroku 문서에 대해 주목할 가치가 있는 몇 가지 사항이 더 있습니다.
- 각 패키지와 함께 다양한 프로그래밍 언어에 대한 순차적 단계를 제공합니다.
- Github를 코드 리포지토리로 사용하는 것과 같이 Heroku와 함께 자주 사용되는 다른 도구 및 통합에 대한 리소스를 사용할 수 있습니다.
Twilio 문서
Twilio는 2008년부터 맞춤형 커뮤니케이션 솔루션으로 기업과 개발자를 지원하는 최고의 API 제공업체였습니다. Twilio의 개발자 문서는 예술 작품으로, 세련된 2패널 디자인으로 사용자가 즉시 알아야 할 모든 것을 제공합니다. 왼쪽 패널은 간단한 설명을 제공하고 오른쪽 패널은 편리한 코드 조각을 제공합니다.
이 문서를 훌륭하게 만드는 또 다른 이유는 무엇입니까? 다음과 같은:
- Twilio의 개발자 문서에는 우아한 글꼴 스타일과 대조되는 하이퍼링크가 있습니다. 전체 인터페이스는 눈에 매우 쉽습니다.
- 개발자가 시간과 번거로움을 줄이기 위해 즉시 복사하여 붙여넣을 수 있는 여러 소스 코드 조각이 있습니다.
- Twilio는 "REST API란 무엇입니까?"와 같은 주제로 초보자에게도 놀라운 수준의 깊이를 제공합니다.
기술 문서 예
캠페인 모니터
이메일 마케팅 도구인 Campaign Monitor는 기술 문서가 잘 작성된 좋은 예입니다. 검색 기능에 중점을 두고 고객을 돕기 위해 깨끗하고 적절하게 구성된 기사 모음이 이어집니다.
좋은 문서를 만드는 또 다른 이유는 무엇입니까?
- 기사는 이메일 자동화 소프트웨어의 기능과 일치하는 범주로 나뉩니다.
- 앱 상태 표시기는 고객이 직면한 문제가 Campaign Monitor의 끝에서 발생한 것인지 알려주는 영리한 움직임으로 스트레스를 완화합니다.
칸바
Canva는 iOS 및 Android 기기에서도 사용할 수 있는 개인 및 전문가용 그래픽 디자인 도구를 제공합니다. Canva의 디자인 전문성은 아름다운 자체 문서 페이지에서 분명합니다. 검색 기능에서 기사 카테고리에 이르기까지 사용자가 올바른 솔루션을 신속하게 찾을 수 있는 명확한 선택이 있습니다.
Canva의 문서는 다음과 같은 이유로 작동합니다.
- 메인 페이지에는 인기 기사, 카테고리 및 기타 지원 옵션이 다양하게 혼합되어 있습니다.
- "인기 검색어"는 고객이 검색 기능을 효과적으로 사용하기 위해 검색할 수 있는 구문의 종류를 이해하는 데 도움이 됩니다.
드롭 박스
클라우드 스토리지 서비스를 사용하는 경우 Dropbox에 대해 들어봤을 것입니다. Dropbox와 같은 SaaS 솔루션의 경우 가장 일반적인 문제를 홈페이지에서 바로 해결하는 것이 현명한 결정입니다.
Dropbox 설명서의 추가 하이라이트는 다음과 같습니다.
- 매력적인 삽화의 사용은 브랜드의 친근한 분위기를 강화하여 문제가 있는 사람들을 위로하는 데 큰 역할을 합니다.
- Dropbox 커뮤니티와의 통합은 사용자 간의 상호 작용을 용이하게 하고 도움을 요청할 수 있는 추가 경로를 제공합니다.
프로젝트 문서 예시
Guelph 대학의 프로젝트 헌장
프로젝트 헌장은 각 이해 관계자의 역할과 책임 외에도 프로젝트의 범위, 목표 및 개발에 대한 세부 정보를 공유하는 공식 프로젝트 승인 문서입니다.
Guelph 대학의 프로젝트 헌장은 훌륭한 문서 예시입니다. 쉽게 이해할 수 있는 테이블 레이아웃으로 프로젝트 헌장에 필수적인 모든 측면을 다룹니다.
MS Word용 프로젝트 계획 템플릿
프로젝트 문서화의 또 다른 예는 MS Word용 간단한 프로젝트 계획 템플릿입니다. 작업을 추가하고 시작 및 종료 날짜를 추적하며 각 작업의 상태를 모니터링할 수 있습니다.
프로젝트 상태 보고서
프로젝트 상태 보고서는 프로젝트 관리자가 모든 이해 관계자에게 프로젝트의 현재 상태를 전달하기 위해 작성한 주간 보고서입니다. 기본 수준에서는 범위, 예산, 일정, 문제 및 위험을 다룹니다. 여기 예가 있습니다.
웹사이트에 문서 추가하기
문서를 작성하고 유지 관리하는 것이 어려울 수 있습니다. 그러나 작성하는 모든 문서는 수만 명의 고객이 사람의 도움 없이도 질문에 대한 답변을 얻는 데 도움이 될 수 있습니다.
시작할 준비가 되었다면 Heroic KB를 고려하여 웹사이트에 문서를 추가하십시오. 멋진 문서를 WordPress 사이트와 통합하는 사용하기 쉬운 지식 기반 플러그인입니다. Heroic KB의 주요 기능은 다음과 같습니다.
즉각적인 테마 통합 : 템플릿 중심 구조로 Heroic Knowledge Base는 문서의 모양과 느낌을 제어할 수 있습니다. 또한 Heroic KB를 WordPress에 대한 가장 유연한 지식 기반 플러그인 중 하나로 만드는 테마 통합 노트가 제공됩니다.
즉각적인 답변 : 번개처럼 빠른 AJAX 검색을 통해 고객은 몇 초 만에 필요한 것을 찾을 수 있습니다.
기본 제공 분석 : 지식 기반이 사용자를 얼마나 잘 돕고 있는지에 대한 통찰력을 얻으십시오. 또한 기사에 대한 피드백을 수집하여 사용자에게 도움이 되는 기사를 찾아낼 수 있습니다.
쉬운 정리: Heroic KB는 끌어서 놓기 범주 순서와 함께 제공되므로 모든 것을 원하는 대로 주문할 수 있습니다.
사용자 액세스 제어 : 암호로 보호하고 다른 사용자 역할의 기사를 숨깁니다.
파일 첨부 지원 : 방문자에게 기사에서 다운로드 가능한 파일을 제공합니다.
위젯 지원 : 사이트 전체에 지식 기반 기사, 카테고리 및 작성자를 표시하기 위한 세 가지 위젯이 있습니다.
개발자 친화적 : Heroic KB는 기본적으로 반응형 스타일과 함께 가장 잘 코딩된 테마와 함께 기본적으로 작동합니다.
언어 지원 : 플러그인은 WPML과 호환되는 번역 준비가 되어 있으며 완전한 현지화 지원을 제공합니다.
우수한 고객 서비스 : Heroic KB 팀은 문제가 발생할 경우 항상 기꺼이 도와드립니다.
물론 WordPress 사용자는 블로그 게시물로 기사를 추가할 수 있습니다. 그러나 특정 KB 플러그인을 사용하면 여러 가지 이점이 있습니다. 문서를 훨씬 쉽게 관리하고 사용자가 다른 콘텐츠와 별도로 문서를 검색할 수 있습니다.
다른 옵션은 전용 지식 기반 테마를 사용하는 것이지만 이는 전체 웹 사이트가 지식 기반인 경우에만 좋은 생각입니다. 기존 WordPress 웹 사이트에 지식 기반을 추가할 때 플러그인이 단연 최고의 솔루션입니다.
위의 예에서 볼 수 있듯이 훌륭한 문서는 현재 고객을 만족시킬 뿐만 아니라 직원 교육 및 잠재 고객 유치에도 엄청난 잠재력을 가지고 있습니다. 웹 사이트에 문서를 추가하기 위해 들인 노력은 앞으로 몇 년 동안 상당한 성과를 거둘 것입니다. 그럼 지금 바로 Heroic KB를 시작하세요.