궁극적인 기술 자료 문서 템플릿(인포그래픽)

궁극적인 지식 기반 문서 템플릿에 대한 이 가이드에서는 이익 증대, 고객 유지, 지원 요청 감소, 전반적으로 멋진 지식 기반을 만드는 방법을 보여줍니다. 방법을 알아 보려면 계속 읽으십시오 ...

새로운 고객을 확보하기 위해 엄청난 시간과 에너지를 소비합니다. 하지만 이미 가지고 있는 고객을 유지하기 위해 동일한 노력을 기울이고 있습니까?

킬러 지식 기반을 만드는 것은 섹시하지 않을 수 있지만 유료 고객이 제품을 최대한 활용할 수 있도록 돕는 데는 큰 도움이 됩니다. 그리고 고객에게 더 많은 가치를 제공할수록 고객은 재방문 고객이 될 가능성이 높아집니다.

기술 자료 만들기 - 쉬운 방법!

지식 기반을 구축하고 고객이 스스로 돕도록 하십시오.

테마 가져오기

고객이 찾을 수 있는 제목 선택

제목부터 시작하겠습니다. 신중한 제목은 고객이 실제로 문제에 대한 답을 찾는 방법이기 때문에 필수적입니다.

문제의 사실은 이렇습니다.

고객이 지식 기반 문서가 문제를 해결할 수 있다는 것을 모른다면 나머지 문서가 얼마나 좋은지 한 번에 문제가 되지 않습니다!

따라서 제목을 중요하게 생각하십시오. 전문 용어를 피하십시오. 인터페이스에서 사용하는 것과 동일한 용어를 사용하여 간단한 영어로 문제를 설명하십시오.

MailChimp의 기사 제목이 모두 단순하고 인터페이스 항목(예: "Email Beamer")과 어떻게 연결되어 있는지 보십시오.

제목을 올바르게 지정하는 것은 검색에 매우 중요합니다. 기사에 대한 대부분의 트래픽은 Google과 같은 검색 엔진이나 귀하의 사이트 검색을 통해 발생합니다. 도움말을 검색하는 고객이 전체 지식 기반을 탐색할 필요 없이 관련 결과를 빠르게 찾을 수 있도록 합니다.

문제부터 시작

기사 상단에서 기사에서 해결하게 될 실제 문제에 대해 간결하게 논의하는 것으로 시작하십시오. 이를 통해 독자는 답변을 찾을 수 있는 올바른 위치에 있음을 알리고 기사에서 얻을 수 있는 기대치를 적절하게 설정합니다.

기차 예약 서비스인 Loco2가 각 기사에서 독자가 기대할 수 있는 것을 정확히 설명하는 방법을 살펴보세요.

특정 주제의 경우 구체적이어야 합니다 . 예를 들어, 귀하의 기사가 오류 메시지 해결에 관한 것이라면 첫 번째 단락에서 오류 메시지를 논의하십시오. 문제를 해결하기 전에 고객이 오류 메시지를 받는 이유를 빠르게 설명하세요.

Yoast가 오류가 발생하는 이유를 정확하게 설명하는 방법을 살펴보세요.

긴 기사에 대한 목차 포함

기사가 특히 긴 경우 독자가 필요한 섹션으로 건너뛸 수 있도록 목차를 포함하는 것이 좋습니다. 가능하면 기사를 별도의 짧은 기사로 나누는 것이 더 좋습니다.

그러나 긴 내용이 불가피한 경우에는 목차를 그 위에 두십시오. 짧은 기사에서도 MailChimp가 수행하는 방법을 확인하십시오.

HeroThemes 지식 기반을 사용한 적이 있다면 목차 위젯과 유사한 작업을 수행하는 것을 눈치채셨을 것입니다.

지침 작성 – 한 단계, 한 포인트

제품에 익숙하다면 지침을 작성하는 것이 놀라울 정도로 어려울 수 있습니다. 당신은 모든 것을 알고 있으므로 독자들에게도 같은 수준의 전문 지식이 부족하다는 사실을 잊기 쉽습니다. 그러지 마세요.

지시 사항을 간단하게 유지하십시오. 한 단계는 한 지점만 다루어야 합니다. 그게 무슨 말이에요?

Dropbox에서 지침을 작성하는 방법을 살펴보세요.

다음과 같이 쓰는 것보다 간단하지 않습니까? “1. Dropbox에 로그인하고 이름을 클릭한 다음 설정 을 선택하십시오. 나도 그렇게 생각해.

지침을 명확한 요점으로 구분하면 독자가 쉽게 따라할 수 있습니다.

마찬가지로 지침 대신 FAQ를 작성하는 경우 각 질문과 특정 주제에 대한 답변을 유지해야 합니다.

제목으로 콘텐츠 나누기

지능형 제목을 사용하여 콘텐츠를 쉽게 소화할 수 있는 덩어리로 나눕니다. 한 기사에서 독자가 두 가지 다른 작업 세트를 완료해야 하는 경우 별도의 제목 아래에 두는 것이 좋습니다.

예를 들어, Canva가 제목을 사용하여 동일한 문서에서 다양한 지침 세트를 나누는 방법을 살펴보세요.

여백과 메모에 적절한 서식 사용

지침이나 FAQ에 더 많은 정보를 추가해야 하는 경우가 있습니다. 괜찮아. 불가피하다. 그러나 추가 정보를 추가할 때 독자가 해당 정보를 제쳐두고 알 수 있도록 형식을 지정해야 합니다.

예를 들어, KnowAll 지식 기반 테마에서 Heroic Shortcodes를 사용하여 제쳐두고 스타일을 지정하는 방법을 살펴보십시오.

독자는 설명서와 옆에 있는 추가 정보를 빠르게 구별할 수 있습니다.

마찬가지로 Asana는 글머리 기호 아이콘과 테두리를 사용하여 "아사나 팁"을 일반 지침과 구별합니다.

지식 기반 기사에서 다양한 유형의 정보를 적절하게 형식화하면 독자의 이해도를 높이는 데 큰 도움이 됩니다.

기술 자료 문서를 함께 연결

최고의 지식 기반이 하는 일은 다음과 같습니다.

고객이 직면한 현재 문제를 해결하는 데 그치지 않습니다. 또한 고객이 도움이 필요하다는 것을 알기도 전에 다음 문제를 해결합니다.

내가 무슨 뜻이야? Asana가 지식 기반의 거의 모든 기사를 어떻게 마무리하는지 보십시오.

해당 기사를 클릭하고 맨 아래로 스크롤하면 다른 링크를 찾을 수 있습니다.

Asana는 고객이 Asana에서 최대한의 가치를 얻도록 압박할 수 있다면 해당 고객이 계속 머물고 계속 비용을 지불할 가능성이 더 높다는 것을 알고 있습니다. 이를 달성하기 위해 지식 기반 기사의 결론을 사용하여 고객이 제품에 대해 더 많이 배우도록 유도합니다.

예를 들어 고객이 팀원을 초대할 수 있다는 사실을 모른다면 어떻게 될까요?
아사나에? 기사의 끝 부분에 링크가 없으면 Asana의 필수 기능에 대해 결코 알지 못할 것 입니다.

따라서 지식 기반 문서를 사용하여 참여도와 유지율을 높이십시오. 고객이 제품에서 최대한의 가치를 얻을 수 있도록 사람들을 논리적인 다음 단계로 밀어 넣습니다.

기술 자료 문서 템플릿 표준화

마지막으로 중요한 것은 이러한 원칙을 문서의 표준화된 템플릿 개발에 적용해야 한다는 것입니다. 동일한 템플릿을 계속해서 사용하면 고객이 인지 능력을 개발할 수 있습니다.

기본적으로 사용자는 이미 작동 방식에 익숙하기 때문에 지식 기반을 더 쉽게 탐색할 수 있습니다. 그들은 글머리 기호 아이콘은 옆에 있음을 의미 하고 다른 글머리 기호 아이콘 은 필수 지시 사항을 의미 한다는 것을 알고 있습니다.

기술 자료 문서 작성을 위한 팁

좋아 – 당신은 템플릿을 알고 있습니다. 그러나 실제로 지식 기반 기사를 작성하는 것은 어떻습니까? 올바른 방향으로 시작하기 위한 몇 가지 팁은 다음과 같습니다.

• Show Don't Tell – "그림은 천 마디 말의 가치가 있다"는 말이 이 시점에서 진부할 수 있지만 지식 기반에서는 사실입니다. 독자가 쉽게 따라할 수 있도록 가능하면 스크린샷, 애니메이션 GIF 또는 동영상을 추가하세요.
• 가장 쉬운 것부터 시작 – 독자가 여러 단계를 완료해야 하는 경우 항상 가능한 한 가장 쉬운 단계부터 시작하십시오. 이를 통해 독자는 어려운 내용으로 이동하기 전에 벨트 아래에서 적어도 하나의 성취를 얻을 수 있습니다.
• 올바른 어조를 사용하십시오 – 간단하고 가능한 한 전문 용어를 사용하지 마십시오. 귀하의 주요 목표는 정보를 전달하는 것임을 기억하십시오. 그리고 항상 독자의 기분을 고려하십시오. 실망스러운 오류 메시지에 대한 기사를 작성하는 경우 농담을 해서는 안 됩니다.
• 지식의 저주를 피하십시오. 위에서 언급했습니다. 그러나 독자는 귀하와 같은 깊이의 지식을 갖고 있지 않다는 것을 항상 기억하십시오. 지식 기반 기사를 작성할 때 초심자의 입장이 되어 보십시오.

정리하기

지식 기반 기사의 구조에 시간을 투자하면 보다 쉽게 ​​이해할 수 있는 지식 기반의 형태로 수익을 올릴 수 있습니다.

다음 템플릿을 따라야 합니다.

• 찾기 쉬운 제목 선택
• 문제 설명 및 기대치 설정
• 지침과 FAQ를 특정 지점에 보관하십시오.
• 목차, 머리글 및 옆에 적절한 형식을 사용하십시오.
• 독자를 제품에서 더 많은 가치를 얻는 데 도움이 되는 다른 기술 자료 문서로 안내합니다.

그런 다음 모든 지식 기반 문서에 동일한 템플릿을 사용하는 것을 잊지 마십시오!

자신의 지식 기반에 대한 제안이 필요하십니까? 아래에 댓글을 남겨주시면 최선을 다해 도와드리겠습니다!