소프트웨어 사용자 설명서 작성 방법: 최종 가이드(템플릿 포함)

귀하의 제품에 대한 소프트웨어 사용 설명서를 작성하는 방법을 모르십니까?

사용자가 가능한 한 가장 효율적인 방법으로 제품에서 최대한의 가치를 얻도록 돕고 싶다면 양질의 소프트웨어 사용 설명서를 작성하는 것이 좋은 시작점입니다.

사용자가 직접 제품을 배우고 문제를 해결하는 데 필요한 콘텐츠를 제공함으로써 인간 지원 채널에 연락할 필요 없이 사용자가 성공하도록 도울 수 있습니다.

이렇게 하면 사용자가 작업을 더 쉽게 수행할 수 있을 뿐만 아니라 비즈니스에서 지원 요청을 줄여 시간과 비용을 절약할 수 있습니다.

그렇다면 사용자를 위한 완벽한 소프트웨어 사용 설명서를 어떻게 만들 수 있습니까? 이것이 이 안내서의 목적입니다.

시작하고 실행하는 데 도움이 되도록 이 게시물에서 다룰 내용은 다음과 같습니다.

• 소프트웨어 사용 설명서란?
• 소프트웨어 사용자 설명서 템플릿을 포함하여 소프트웨어 사용자 설명서를 4단계로 작성하는 방법
• 사용자 매뉴얼을 위한 고품질 콘텐츠 생성을 위한 모범 사례

파헤쳐 보자!

소프트웨어 사용 설명서란 무엇입니까?

소프트웨어 사용 설명서는 소프트웨어 앱 또는 제품을 사용하고 관리하는 방법에 대한 정보를 제공하는 문서입니다.

소프트웨어 사용 설명서에는 시작 가이드, 지침, 용어집, 문제 해결 팁 및 기타 유사한 유형의 콘텐츠가 포함될 수 있습니다.

기본적으로 사용자가 소프트웨어에서 가치를 얻는 데 필요한 모든 정보가 포함됩니다.

일반적으로 설치 단계로 시작한 다음 인터페이스의 일반적인 개요와 다양한 기능을 사용하는 방법을 다룬 다음 필요한 경우 문제 해결 및 FAQ를 자세히 살펴봅니다. 다시 한 번 더 자세한 소프트웨어 사용 설명서 템플릿을 아래에서 공유하겠습니다.

소프트웨어 사용 설명서의 예를 보려면 인터페이스 설명으로 바로 이동하는 Forklift 3 사용 설명서를 볼 수 있습니다.

또 다른 예로 Slack의 시작하기 콘텐츠를 보면 바로 Slack 인터페이스를 설명할 수 있습니다.

소프트웨어 사용 설명서를 작성하는 것이 중요한 이유는 무엇입니까?

제품에 대한 소프트웨어 사용 설명서를 작성해야 하는 두 가지 큰 이유가 있습니다.

1. 향상된 사용자 경험 – 사용자가 소프트웨어 사용 방법을 쉽게 배우고 소프트웨어에서 받는 가치를 극대화함으로써 사용자는 더 나은 경험을 할 수 있습니다.
2. 지원 부담 감소 – 사용자에게 자신의 문제를 해결할 수 있는 기능을 제공함으로써 인적 지원 채널의 부담을 줄일 수 있습니다. 사용자 설명서를 지식 기반 및/또는 자주 묻는 질문(FAQ)과 같은 다른 유형의 지원 콘텐츠와 결합하는 경우 특히 그렇습니다.

네 단계로 소프트웨어 사용자 매뉴얼을 작성하는 방법

이제 소프트웨어 사용 설명서를 작성하는 방법에 대한 일반적인 단계별 가이드를 살펴보겠습니다. 다음 섹션에서는 사용 설명서의 실제 콘텐츠에 대한 몇 가지 모범 사례도 살펴보겠습니다.

이러한 항목에 대한 보다 일반적인 내용에 관심이 있는 경우 모든 유형의 사용 설명서를 만드는 방법에 대한 가이드도 있습니다.

1. 소프트웨어 사용 설명서의 구조 계획

매뉴얼 콘텐츠를 만들기 전에 먼저 매뉴얼의 구조를 적절하게 계획하고 싶을 것입니다.

설명서를 가능한 한 포괄적으로 만들기 위해 이를 수행하는 데 도움이 되는 여러 주요 이해 관계자를 모으는 것이 좋습니다.

예를 들어 여기에는 고객 성공, 판매 등이 포함될 수 있습니다. 즉, 사용자가 제품에서 최대한 많은 가치를 얻을 수 있도록 돕는 방법을 알고 있는 모든 사람입니다. 경우에 따라 고급 세부 정보를 지원하기 위해 더 많은 기술 직원을 고용해야 할 수도 있습니다.

물론, 당신이 단독 프로젝트를 진행한다면, 당신은 이 모든 모자를 직접 착용하게 될 것입니다. 그것이 바로 1인 창업자의 기쁨입니다.

관련 지식 보유자가 준비되면 사용 설명서의 개요를 작성할 수 있습니다.

대략적인 소프트웨어 사용 설명서 템플릿의 경우 다음과 같이 할 수 있습니다.

1. 목차 – 사용자가 무엇을 기대하는지 알 수 있도록 사용 설명서의 여러 섹션을 나열합니다.
2. 소개 – 소프트웨어 사용 설명서의 목적을 설명하십시오.
3. 시스템 요구 사항 – 하드웨어 사양, 운영 체제 등과 같이 사람들이 소프트웨어를 사용하는 데 필요한 특정 요구 사항을 자세히 설명합니다.
4. 설치 지침 – 사용자가 소프트웨어를 설치하는 방법을 다룹니다.
5. 사용자 인터페이스 개요 – 인터페이스에 대한 높은 수준의 개요를 제공합니다.
6. 특정 기능을 사용하는 방법 - 사용자에게 작동 방식을 보여주는 각 핵심 기능에 대한 섹션을 만듭니다.
7. 자주 묻는 질문 – 사용자가 가질 수 있는 몇 가지 일반적인 질문을 다룹니다.
8. 문제 해결 - 문제 해결 조언을 공유합니다.
9. 용어집 – 소프트웨어에 특정 용어가 있는 경우 소프트웨어 사용 설명서 끝 부분에 용어집을 추가할 수 있습니다.
10. 지원 연락처 세부 정보 – 사용자가 추가 도움이 필요한 경우 지원팀에 문의할 수 있는 방법을 설명합니다. 사용자가 지원을 요청하기 전에 스스로 해결하려고 시도할 수 있도록 마지막에 이를 유지해야 합니다.

이 소프트웨어 사용자 설명서 템플릿을 정확히 따를 필요는 없습니다. 포함할 항목에 대한 아이디어를 제공하는 시작점일 뿐입니다.

2. 소프트웨어 사용 설명서 콘텐츠 만들기

개요가 있으면 소프트웨어 사용 설명서 콘텐츠를 만들 준비가 된 것입니다.

대부분의 콘텐츠는 텍스트이지만 관련 이미지, GIF 및 비디오도 포함하는 것을 잊지 마십시오.

이 단계는 아마도 가장 많은 시간이 소요될 것이지만, 다음 섹션에서 귀하의 팀이 효과적인 사용 설명서 콘텐츠를 만드는 데 도움이 되는 몇 가지 소프트웨어 사용 설명서 모범 사례를 공유할 것이기 때문에 지금은 이 섹션을 간략하게 유지합니다.

콘텐츠를 작성하는 사람은 조직의 규모와 제품의 복잡성에 따라 다릅니다. 직원에 전담 기술 작가가 없는 경우 소프트웨어의 복잡성에 따라 고객 성공 팀 또는 기술 팀에 콘텐츠를 할당해야 할 수 있습니다.

또는 1인 창업자인 경우 콘텐츠에 대해 가장 깊이 이해하고 있으므로 매뉴얼 콘텐츠를 작성하는 데 가장 적합한 사람이 될 것입니다. 언제든지 편집자를 고용하여 초안을 개선할 수 있습니다.

3. 소프트웨어 사용 설명서 게시

소프트웨어 사용자 설명서에 대한 콘텐츠가 있으면 사용자가 쉽게 사용할 수 있는 방식으로 설명서를 게시해야 합니다.

대부분의 기술 자료 또는 문서화 소프트웨어는 소프트웨어 사용자 설명서에 대해 잘 작동해야 하지만 지나치게 제한적이라고 느끼면 언제든지 고유한 솔루션을 코딩할 수 있습니다. 일부 기업에서는 웹 버전 외에 사용자 설명서의 PDF 버전도 게시합니다.

소프트웨어 사용 설명서의 웹 버전을 게시하기 위한 훌륭한 옵션을 보려면 최고의 지식 기반 소프트웨어 및 최고의 문서화 도구 목록을 확인하십시오.

견고한 기능 목록, 콘텐츠에 대한 완전한 소유권, 필요에 따라 사용자 정의할 수 있는 유연성을 제공하는 사용자 설명서 소프트웨어를 찾고 있다면 Heroic Knowledge Base WordPress 플러그인을 사용할 수 있습니다.

Heroic Knowledge Base는 소프트웨어 사용 설명서를 게시하는 데 필요한 모든 기능으로 유사한 오픈 소스 WordPress 콘텐츠 관리 시스템(CMS)을 확장하는 오픈 소스 소프트웨어입니다.

플랫폼에 대한 완전한 소유권과 필요에 따라 모든 요소를 ​​조정할 수 있는 유연성을 갖게 됩니다. 그러나 동시에 Heroic Knowledge Base에는 소프트웨어 사용 설명서에 필요한 모든 중요한 기능에 대한 내장 기능이 포함되어 있습니다.

• 기사 구성 – 범주를 사용하여 소프트웨어 설명서의 기사를 구성할 수 있습니다. 예를 들어 "설치", "인터페이스", "기능 사용", "문제 해결" 등에 대해 서로 다른 범주를 가질 수 있습니다.
• 콘텐츠 검색 기능 – 사용자가 가능한 한 빨리 관련 콘텐츠를 찾을 수 있도록 Heroic Knowledge Base에는 실시간 검색 제안, 자동 목차 등과 같은 유용한 콘텐츠 검색 기능이 포함되어 있습니다.
• 사용자 피드백 시스템 – 사용자는 각 문서의 유용성에 대한 피드백을 공유할 수 있으므로 잘하고 있는 부분(및 개선해야 할 부분)을 알 수 있습니다.
• 자세한 분석 – 가장 많은 조회수를 얻은 기사, 가장 많은 인적 지원 요청으로 이어지는 기사, 사용자가 검색하는 용어, 결과를 반환하지 않는 검색 등을 추적할 수 있습니다.

4. 피드백 및 변경 사항을 기반으로 소프트웨어 사용 설명서 업데이트

양질의 소프트웨어 사용자 매뉴얼을 만드는 것은 "한번에 끝나는" 것이 아닙니다. 매뉴얼을 게시한 후에도 필요에 따라 매뉴얼을 업데이트하고 수정할 주요 이해 관계자를 지정하는 것이 중요합니다.

경우에 따라 소프트웨어 변경으로 인해 이러한 업데이트가 필요할 수 있습니다. 예를 들어, 새로운 기능을 추가하거나 소프트웨어의 인터페이스를 변경하는 경우 이러한 변경 사항을 고려하여 사용 설명서를 업데이트해야 합니다.

다른 경우에는 이러한 업데이트가 사용자 피드백에서 발생할 수 있습니다. 예를 들어 사용자가 특정 기사로 인해 혼란스러워하는 경우 해당 기사를 업데이트하여 더 유용하게 만들 수 있습니다.

또는 사용자가 소프트웨어 사용 설명서에 없는 항목을 검색하는 경우 해당 항목을 다루는 새 문서를 만들어야 할 수 있습니다.

Heroic Knowledge Base와 같은 도구를 사용하여 사용자 매뉴얼을 게시하면 이러한 유형의 분석을 쉽게 추적할 수 있으므로 사용자 매뉴얼 콘텐츠를 모니터링하고 개선할 수 있습니다.

소프트웨어 사용 설명서 작성 모범 사례

이제 소프트웨어 사용자 설명서를 작성하는 기본 프로세스를 이해했으므로 효과적인 사용자 설명서 콘텐츠를 만들기 위한 몇 가지 모범 사례를 살펴보겠습니다.

청중이 누구인지 이해

유용한 사용 설명서 콘텐츠를 만들고 싶다면 누구를 위해 작성하는지 알아야 합니다.

• 사용자의 출처.
• 귀하의 소프트웨어로 달성하려는 것.
• 고객이 겪고 있는 문제
• 산업 및/또는 관련 기술 분야에 대한 일반 지식 수준.
• 그들이 일하는 회사(또는 개인 사용자인 경우).
• 등.

예를 들어 소프트웨어가 Salesforce와 거래한다고 가정해 보겠습니다. 대상 사용자가 숙련된 Salesforce 관리자인 경우 콘텐츠는 대상 사용자가 영업 사원인 경우와 많이 다르게 보일 것입니다.

이미 기존 작업에서 대상 사용자를 잘 이해하고 있을 것입니다. 그러나 확실하지 않은 경우 고객 페르소나, 설문 조사 및 인터뷰를 사용하여 더 깊이 이해할 수 있습니다.

논리적 구조 및 조직 사용

이전 섹션의 첫 번째 단계에서 이에 대해 다루었지만 사용자가 콘텐츠에서 가치를 쉽게 얻을 수 있도록 사용자 설명서를 최적의 방식으로 구성하는 것이 중요합니다.

사용 설명서를 구성할 수 있는 다양한 방법이 있으며 다양한 섹션에서 여러 접근 방식을 사용할 수 있습니다.

• 선형 경험 – 사용자가 경험하는 방식으로 매뉴얼을 구성할 수 있습니다. 예를 들어 첫 번째 섹션으로 "설치"로 시작한 다음 다음 섹션에서 설치 후 첫 번째 작업으로 이동할 수 있습니다.
• 기능 - 소프트웨어의 다양한 기능을 기반으로 수동 콘텐츠를 구성할 수 있습니다.
• 문제 해결 – 일반적인 문제 해결 단계를 한 곳에서 수집할 수 있습니다.

다시 말하지만, 매뉴얼 내에서 여러 접근 방식을 사용하는 것은 전적으로 괜찮습니다. 예를 들어 설치 프로세스를 위해 선형 방식으로 항목을 구성하여 시작할 수 있습니다.

그러나 일단 설치를 다루고 사용자가 다양한 방식으로 소프트웨어를 적용할 수 있게 되면 기능 기반 조직 접근 방식으로 전환할 수 있습니다.

작성을 단순하고 일관되게 유지하십시오.

소프트웨어 사용 설명서에 최대한 액세스할 수 있도록 작성하려면 최대한 간단하게 작성하는 것이 중요합니다.

그렇게 하기 위해 명심해야 할 몇 가지 사항은 다음과 같습니다.

• 전문 용어나 혼란스러운 단어를 사용하지 마십시오 . 귀하의 산업 및/또는 제품 언어에 대해 모든 사용자가 동일한 지식을 가지고 있는 것은 아니므로 불필요한 기술 전문 용어와 혼란스러운 어휘를 피하는 것이 중요합니다. Flesch Reading Ease 테스트와 같은 도구로 콘텐츠를 테스트하여 문제를 찾을 수 있습니다.
• 수동태를 피하십시오 – 수동태를 사용하는 것은 사용 설명서에서 특히 혼란스러울 수 있습니다. 예를 들어 "초안을 저장하려면 초안 저장 버튼을 눌러야 합니다"와 같은 수동태를 사용하는 대신 " 초안 저장 버튼을 눌러 초안을 저장하십시오. 초안."
• 짧은 문장 사용 - 콘텐츠를 짧은 문장으로 나누면 사용자가 사용 설명서 콘텐츠를 더 쉽게 사용하고 스캔할 수 있습니다. 가능하면 긴 단락(일명 "텍스트 벽")을 피하십시오.
• 일관성 유지 – 일관된 문구와 형식을 사용하면 사용자가 매뉴얼을 더 쉽게 이해할 수 있습니다. 예를 들어 특정 작업의 개별 단계를 나열하기 위해 항상 정렬된 목록을 사용하는 경우 전체 사용 설명서에서 해당 형식을 유지하도록 노력하십시오.
• 문법 문제를 피하십시오 – 사용자가 설명서를 이해하기 어렵게 만들 수 있는 문법 오류가 없는지 확인하십시오. Grammarly 및 Hemingway와 같은 도구를 사용하여 이를 확인할 수 있습니다.

도움이 되는 경우 이미지 및 동영상 포함

텍스트 콘텐츠가 사용 설명서의 기초를 형성하지만 의미가 있는 곳에 이미지와 비디오를 포함하는 것도 중요합니다.

"사진은 백 마디 말보다 가치가 있다"는 말은 진부할 수 있지만 사용자가 소프트웨어 제품에서 가치를 얻을 수 있는 방법을 설명하려고 할 때 확실히 사실이 될 수 있습니다.

텍스트의 개념을 설명하는 데 도움이 되도록 대화 내용을 보여주는 주석이 달린 이미지나 GIF를 추가할 수 있습니다.

예를 들어 Slack은 인터페이스 소개 이미지에 주석을 추가하는 작업을 훌륭하게 수행합니다.

비디오 콘텐츠는 일부 사용자에게 유용할 수도 있습니다. 그러나 사용자가 소프트웨어 수동 콘텐츠를 사용하는 것이 항상 최적의 방법은 아니므로 비디오 콘텐츠 에만 의존하는 것에 대해 주의해야 합니다.

예를 들어 사용자가 특정 세부 정보의 문제를 해결하려는 경우 일반적으로 비디오보다 텍스트 콘텐츠에서 해당 세부 정보를 찾는 것이 훨씬 쉽습니다.

지금 바로 소프트웨어 사용 설명서 만들기

이것으로 사용자가 성공할 수 있도록 훌륭한 소프트웨어 사용자 설명서를 작성하는 방법에 대한 가이드를 마치겠습니다.

소프트웨어 사용 설명서를 게시하는 가장 쉬운 방법을 원하는 경우 WordPress용 Heroic Knowledge Base 플러그인을 사용할 수 있습니다.

Heroic Knowledge Base는 WordPress CMS를 활용하여 완전히 제어할 수 있는 자체 호스팅 소프트웨어 사용 설명서를 만들 수 있는 오픈 소스 플러그인입니다.

동시에 Heroic Knowledge Base는 훌륭한 소프트웨어 사용자 설명서를 만드는 데 필요한 모든 기능을 제공하기 때문에 기능을 희생할 필요가 없습니다. 이러한 기능에는 실시간 검색 제안, 범주 구성, 사용자 피드백 수집, 분석 등이 포함됩니다.

시작할 준비가 되셨다면 오늘 Heroic Knowledge Base를 구입하시면 멋진 사용자 설명서를 곧 만나보실 수 있습니다.