명확하고 간결한 사용 설명서 작성 방법
사용 설명서란 무엇입니까?
사용 설명서에는 다양한 이름이 있습니다. 기술 문서, 유지 보수 설명서 및 사용 설명서는 모두 동일한 항목을 나타내는 이름입니다. 사용자 매뉴얼은 고객이 제품이나 서비스를 올바르게 사용하거나 사용 중 발생하는 문제를 해결할 수 있도록 돕기 위해 만들어집니다. 인쇄, 디지털 또는 두 가지 형식으로 제공될 수 있습니다.
사용 설명서는 최종 사용자에게 포괄적인 단계별 지침과 문제에 대한 일부 지원을 제공합니다. 처음부터 끝까지 읽어야 하는 책이 아니라 참고 자료이기 때문에 모든 사용 설명서에는 목차가 있어야 합니다. 사용자 설명서에 빠른 시작 또는 시작 자습서를 추가하여 사용자가 쉽게 제품 사용을 시작할 수 있도록 해야 합니다.
사용자 매뉴얼의 종류
다양한 주제와 목적을 위해 사용자 매뉴얼을 제작할 수 있습니다. 여기에 몇 가지 가능성이 있으므로 살펴보겠습니다.
- 사용 설명서
사용 설명서는 사용하려는 방식으로 제품을 사용하기 위한 간단한 지침을 제공하는 사용자 가이드 유형입니다. - 연수 매뉴얼
이러한 종류의 사용자 안내서는 특정 작업, 프로젝트 또는 작업을 완료하기 위한 지침 목록을 제공합니다. - 서비스 매뉴얼
서비스 매뉴얼은 서로 다른 s에서 기계 또는 장비를 관리하고 유지하는 방법을 설명하는 사용자 가이드입니다.tag그것의 수명의 es. - 사용자 설명서
사용 설명서는 제품을 올바르게 사용하거나 작동하는 방법을 설명하는 기술 출판물입니다. - 사용 설명서
비즈니스 또는 조직에 특정한 역할, 의무 및 절차는 운영 매뉴얼에 설명되어 있습니다. - 조직 정책 매뉴얼
조직 정책 매뉴얼은 회사의 정책, 관행 및 모범 사례를 정의하는 문서입니다. - 표준 운영 절차(SOP) 매뉴얼
사용자는 확립된 절차를 수행하기 위한 표준 운영 절차 매뉴얼의 자세한 지침을 활용할 수 있습니다.
비즈니스에 사용자 매뉴얼이 필요한 이유는 무엇입니까?
사람들은 사용 설명서의 지원을 받아 스스로 문제를 처리할 수 있는 능력을 갖추고 있습니다. 적절한 사용자 설명서는 고객이 오늘날의 즉각적인 만족 문화에서 제품이나 서비스에서 원하는 가치를 빠르고 효과적으로 달성하는 데 필요한 도구를 고객에게 제공할 수 있습니다.
우수한 고객 서비스는 사용자 설명서로 보완되어야 합니다. 우수한 사용자 설명서를 작성하면 다음과 같은 이점이 있습니다.tag귀하의 회사를 위한 es:
- 온보딩 및 교육 간소화
잘 작성된 사용자 가이드는 온보딩 및 교육 절차를 더 간단하게 만들 수 있습니다. 최고 수준의 사용자 매뉴얼을 개발하고 구현함으로써 귀사의 직원과 소비자 모두 이익을 얻을 수 있습니다.
회사는 사용자 가이드를 사용하여 신입 직원이 상당한 시간과 재정적 비용이 드는 어려운 대면 교육 세션을 설정하는 것보다 새로운 역할의 일부인 일부 프로세스 및 시스템을 거치도록 도울 수 있습니다. 직원들은 사용자 가이드를 통해 직위와 관련된 업무를 수행하면서 학습할 수 있으므로 온보딩 과정에서 낭비되는 시간이 줄어들 수 있습니다. - 지원 비용을 줄이기 위해
사용자 가이드는 소비자를 위한 고객 서비스 노력에 큰 도움이 되지만 비즈니스 소유자에게도 고객 지원 시스템의 구성 요소를 제공합니다.
검색 가능한 사용자 가이드에 대한 빠른 액세스를 제공하면 고객이 즉시 솔루션을 찾을 가능성이 높고 전문 지원을 위해 기술자나 담당자에게 문의할 필요가 없습니다. - 시간을 절약하기 위해
신입 직원부터 경영진에 이르기까지 고객과 직원 모두 사용자 매뉴얼을 사용하여 시간을 절약할 수 있습니다. 고객이 사용 설명서를 사용할 수 있으면 해당 정보에 바로 액세스할 수 있으므로 고객은 제품 사용 방법에 대한 정보를 찾으려고 시간을 낭비할 필요가 없습니다.
직원이 유용한 사용 설명서를 갖추면 사용자 설명서에서 바로 솔루션에 액세스할 수 있기 때문에 독립적으로 솔루션을 찾거나 질문으로 동료 및 관리자의 관심을 독점하는 데 시간을 낭비할 필요가 없습니다! - 책임을 최소화하려면
제품을 철저히 테스트했고 제품을 안전하게 사용하는 방법을 알고 있음을 입증하는 한 가지 방법은 사용 설명서를 작성하고 배포하는 것입니다. 이를 통해 일반 대중을 위해 무언가를 생산하는 것과 관련된 모든 의무를 크게 낮출 수 있습니다.
경고 및 안전 예방 조치를 기록하고 사용자 가이드를 통해 사용자가 액세스할 수 있도록 하는 것은 판매하는 제품이 사용자에게 위험할 수 있는 경우 오용으로 인한 부상 또는 기타 손상과 관련된 법적 문제를 방지하는 효과적인(완벽하지는 않지만) 방법입니다. 스페이스 히터, 전동 공구 등).
최고의 사용 설명서를 구성하는 구성 요소는 무엇입니까?
각 제품이 고유하고 진정으로 뛰어난 사용자 문서를 생성하려면 고유한 구성 요소가 필요하더라도 어떤 경우에도 준수해야 할 최종 사용자 문서 모범 사례가 있습니다.
- 평범한 언어
사용자 설명서가 전문 용어와 이해하기 어려운 언어로 가득하다는 사실을 발견하는 것보다 더 고객을 짜증나게 하는 것은 없습니다. 이러한 언어 선택으로 인해 사용자 지침을 사용하기 어렵고 뛰어난 고객 서비스를 홍보하지도 않습니다. 개발자가 아닌 사용자를 위해 작성하고 있는지 확인하는 것은 훌륭한 사용자 가이드를 만드는 데 중요한 구성 요소입니다. 최종 사용자가 무엇이든 알고 있거나 익숙하다고 가정하지 마십시오. 두문자어, 전문 용어 및 사무실 용어는 고객이 잘못된 정보를 받고 좌절하고 준비되지 않은 느낌을 갖게 합니다. 사용자 매뉴얼 제작의 가장 좋은 점은 소비자가 어린이인 것처럼 작성하지 않는 것과(물론 어린이가 아닌 한!) 제품 사용 방법을 완전히 이해하는 데 필요한 추가 도움을 간단하게 제공하는 것 사이의 균형을 맞추는 것입니다. 언어. - 간단
사용자 핸드북을 작성하려면 일을 단순하게 유지해야 합니다. 이 개념은 콘텐츠와 디자인 모두에 반영되어야 합니다. 복잡한 그림과 긴 텍스트 구절로 문서를 너무 많이 채우면 문서가 너무 복잡하고 이해하기 어려워 보일 것입니다. 이러한 종류의 사용 설명서는 사용자를 위협하고 스스로 문제를 파악하려고 시도하기보다 헬프 라인에 전화하도록 유도할 수 있습니다. - 비주얼
"보이지 말고 말하지 말라"는 격언은 사용 설명서 작성의 초석입니다. 주석이 달린 스크린샷, 동영상 및 기타 시각적 콘텐츠는 개념을 이해하는 데 매우 유용합니다. 그것에 대해 읽는 것보다 행동하는 것을 보는 것이 종종 훨씬 더 유용합니다. 비주얼은 긴 텍스트 구절을 끊을 뿐만 아니라 사용 설명서에서 무서울 수 있는 텍스트의 양을 줄여줍니다. 사람들이 서면 정보보다 시각 정보를 7% 더 빨리 기억한다는 것이 입증되었습니다. Techsmith 연구에서는 67%의 사람들이 정보를 전달하기 위해 단어만 사용하는 것보다 주석이 달린 스크린샷이 포함된 지침을 제공했을 때 더 효과적으로 작업을 수행하는 것으로 나타났습니다. - 해결해야 할 문제에 집중
누군가 문제를 해결하기 위해 제품을 구입했을 가능성이 큽니다. 제품에 동봉될 사용 설명서의 초안을 작성할 때 이 문제에 집중하는 것이 필수적입니다. 제품이 제공하는 모든 기능이나 통합한 흥미로운 디자인 요소를 열거하고 논의하는 대신 제품 사용을 용이하게 하는 방식으로 사용자에게 알리십시오. 제품을 설명할 때 해결 중인 문제를 제품의 기능 및 이점과 관련하여 설명하십시오. - 논리적 흐름 및 계층
사용자 설명서의 각 섹션에서 배울 내용을 사용자에게 분명하게 나타내려면 명확한 계층 구조를 따르는 헤더와 부제목을 활용하십시오. 처음부터 끝까지 고객이 알아야 할 모든 것을 쉽게 안내하려면 선택한 계층 구조가 논리적 흐름을 따라야 합니다. 기초부터 시작하여 제품의 보다 정교한 기능을 향한 논리적 진행을 통합해야 합니다. - 목차 목록
사용 설명서는 목차로 시작하는 경우 독자에게 가장 유용합니다. 현재 직면한 문제와 관련이 없는 많은 정보 페이지를 파헤칠 필요 없이 문서를 빠르고 쉽게 탐색할 수 있는 친숙한 접근 방식입니다. - 검색 가능하게 만들기
사용 설명서를 인쇄하더라도 디지털 문서가 최우선 순위가 될 가능성이 높습니다. 대부분의 사람들이 스마트폰을 항상 가지고 다니는 세상에서 사용자 설명서는 디지털 형식으로 가장 자주 활용될 가능성이 큽니다. 디지털 사용자 설명서에 검색 가능한 기능을 추가하면 목차가 인쇄 문서에서 사용자를 적절한 위치로 안내하는 역할을 하는 것과 유사하게 액세스하여 문제를 해결하려는 사용자에게 즐거운 사용 편의성을 제공할 것입니다. - 접근성
사용 설명서가 필요한 사람들 중 일부는 제대로 작동하는지 확인하기 위해 추가 지원을 받을 수 있습니다. 법에서 요구하는지 여부에 관계없이 접근성 요구 사항은 일반적으로 좋은 관행입니다. 사용자 설명서에서 접근성 요구 사항을 유지하는 것은 훌륭한 비즈니스 관행입니다. 시각적, 청각적 또는 인지적 문제가 있을 수 있는 사용자가 액세스할 수 있는 콘텐츠로 사용자 가이드를 디자인하는 것이 중요합니다. - 잘 디자인된
사용자 가이드를 만들 때 청중을 고려하십시오. 그들이 보는 것을 즐기는 무언가를 만들면 그들은 그것을 효과적으로 사용하는 경향이 훨씬 더 커질 것입니다! 긴 텍스트 블록을 사용하지 말고 충분한 여백을 제공하십시오. 이 두 가지 특성을 결합하면 소비자가 덜 무섭게 보이고 새로운 것을 배우는 것이 위협적이기보다는 흥미로워 보일 수 있습니다. 앞에서 설명한 "말하지 말고 보여주기" 방식이 여기에도 적용됩니다. 인쇄 및 디지털 사용 설명서의 경우 텍스트에 시각 자료와 사진을 추가하는 것이 훌륭한 대안입니다. 디지털 사용자 설명서의 경우 비디오 및 GIF는 흥미와 도움이 되는 요소를 제공합니다. 회사에 스타일 가이드가 있다면 디자인도 그에 따라야 합니다. 그렇지 않고 사용자 가이드 없이 작업하는 경우 사용자 가이드를 일관되게 유지하는 것이 중요합니다. 문서 전체, 이상적으로는 모든 사용자 가이드에서 사용되는 글꼴 및 색 구성표는 일관성이 있어야 합니다. - 실제 고객 또는 베타 테스터의 의견
당신의 제품을 실제로 사용하게 될 사람들로부터 피드백을 찾고 들어본 후에 준비한 사용자 가이드가 가능한 한 성공적인지 여부를 결정할 수 없을 것입니다. 당신이 당신의 제품을 위해 개발하는 사용자 가이드는 사람들이 가지고 있는 문제를 고려해야 합니다. 매우 명백해 보이는 것을 배울 수도 있지만 도달하려는 고객의 요구 사항을 이해하는 데 도움이 되는 것을 배울 가능성이 훨씬 더 높습니다.
사용 설명서는 어떻게 작성합니까?
사용 설명서를 만드는 것은 회사와 서비스를 제공하려는 소비자 모두에게 큰 영향을 미칠 수 있는 중요한 작업입니다. 부담스러울 수 있으므로 쉽게 따라할 수 있도록 사용 설명서 개발 프로세스를 단순화했습니다.
- 사용자 식별
커뮤니케이션 수신자를 찾는 것은 귀하가 생성하는 다른 커뮤니케이션과 마찬가지로 필수적인 초기 단계입니다. 사용 설명서의 대상 독자는 어조, 제공할 세부 수준 및 콘텐츠 전달 방법과 같은 문제를 결정하는 데 도움이 됩니다. 제품의 최종 사용자를 위한 사용 설명서 작성은 기술 엔지니어를 위한 설명서 작성과 크게 다릅니다. 첫 번째 단계는 청중을 결정하는 것입니다. - 문제에 집중
사용자 설명서는 문제 해결을 돕거나 누군가에게 새로운 것을 수행하는 방법을 지시하기 위해 만들어졌습니다. 사용 설명서의 의도를 정확히 파악하고 그 초점을 유지해야 합니다.
주제를 확장하고 제품의 다양한 기능이나 응용 프로그램에 대해 논의하고 싶을 수 있습니다. 이것은 사용자를 좌절시킬 수 있으며 그들이 요구하는 진정한 대답을 흐리게 하여 고객 지원 라인에 대한 전화로 이어질 수 있습니다.
고객이 제품 사용 방법을 배우는 소비자이거나 제품을 수리해야 하는 기술자인 경우 고객이 필요로 하는 정확한 솔루션에 집중하십시오. - 순차적 접근 방식 사용
사용 설명서의 지침은 당면한 작업을 완료하는 데 필요한 순서대로 배치되어야 합니다. 시작하려면 각 단계를 나열하십시오. 그런 다음, 주어진 순서대로 설명한 정확한 단계를 고수하면서 과제를 수행하기 위해 노력하십시오. 원래 목록을 살펴보면서 다음 항목을 찾을 수 있습니다.tag누락된 es. 또한 한때 단일 작업이라고 믿었던 것이 명확성을 위해 실제로는 여러 활동으로 나누어야 한다는 것을 알 수 있습니다.
사용자 가이드 작성의 다음 단계로 넘어가기 전에 할당한 각 순차적 단계에 대한 명확한 결과를 지정했는지 확인하십시오. 다음 단계로 넘어가기 전에 독자는 자신이 성취하고자 하는 것과 그것이 어떻게 보여야 하는지에 대해 완전히 명확해야 합니다. - 사용자 여정 매핑
소비자가 제품을 어떻게 사용할 계획인지 이해하고 쉽게 사용할 수 있도록 만드는 것이 사용자 가이드 제작의 목표입니다. 소비자가 해결하려는 문제 또는 솔루션을 활용하여 달성하려는 목표와 비즈니스에 참여하는 방식을 이해하기 위해 노력해야 합니다. 이러한 세부 정보를 사용하여 프로세스를 통해 고객을 안내하는 데 필요한 단계를 계획하여 문제에서 솔루션으로의 여정을 시각화할 수 있습니다. - 템플릿을 선택하세요
일련의 템플릿을 만들면 사용자 설명서를 작성하고 개발하는 작업이 예상보다 훨씬 간단해집니다. 절차가 간소화될 수 있으며 일관성이 훨씬 더 현실적인 목표가 될 것입니다.
사용자 매뉴얼 템플릿에는 글꼴(유형 및 크기), 대비 요구 사항 및 색 구성표와 같은 세부 사항을 정의하는 것 외에도 다음 사항도 포함해야 합니다.- 소개를 위해 할당된 지역
- 고유한 하위 섹션 및 섹션
- 일련의 작업을 전달하기 위해 선택한 형식
- 주의 사항 및 경고
- 결론에 할당된 영역
- 간단하고 따라하기 쉬운 내용 작성
사용 설명서의 자료는 가능한 한 이해하기 쉽고 간단해야 합니다. 명확성과 편의성을 위해 형식과 내용을 고민하고 분석하는 것이 중요합니다.
프로세스의 각 단계에서 하나의 작업만 설명하고 가능한 한 명확하고 짧은 언어를 사용하는지 확인하십시오. 정말 필요한 정보만 포함된 사용 설명서가 나올 때까지 텍스트를 올바르게 수정하십시오. - 초보자처럼 모든 사용자에게 접근
사용 설명서를 읽는 사람은 제품을 만들 때 제품에 대한 사전 지식이 없다고 가정합니다. 평신도에게 말하는 것처럼 쓰십시오.
전문 용어나 전문 용어의 사용은 피해야 합니다. 당연히 피해야 할 때도 있겠지만 절대적인 예외다. - 초보 사용자와 함께 제품의 지침을 테스트합니다.
사용자 설명서 작성 프로세스의 테스트 단계는 매우 중요합니다. 실험 대상은 결과에 상당한 영향을 미칩니다.
이상적으로는 제품을 사용한 적이 없거나 문서를 본 적이 없는 사람들을 대상으로 테스트를 수행해야 합니다. 사용 설명서를 살펴보면서 프로세스를 완료하는 과정을 지켜보고 막힌 부분을 기록하십시오. 그런 다음 정보를 적절하게 업데이트해야 합니다.
테스터가 제품을 작동하려면 사용 설명서의 도움만 있으면 됩니다. 그들은 더 많은 도움을 요청할 필요가 없어야 합니다. 소련 가이드에는 필요한 모든 정보가 있어야 합니다. - 실용적인 접근 방식을 사용하여 콘텐츠 구축
구체적인 예를 제공하기 위해 모든 노력을 기울여야 합니다.amp사용자 설명서의 각 단계를 수행한 후 사용자가 경험할 수 있는 모든 결과에 대한 파일 및 자세한 설명. 사용자는 제품에서 얻을 수 있는 모든 피드백과 그 과정에서 마주칠 수 있는 잠재적인 광경이나 소리를 알고 있어야 합니다. - 기호, 아이콘 및 코드를 조기에 설명
필요한 지침을 제공하는 데 도움이 되도록 사용 설명서를 작성하는 동안 아이콘, 기호 또는 코드를 사용해야 할 수도 있습니다. 독자의 혼동이나 불만을 방지하기 위해 사용 설명서에서 가능한 한 빨리 이를 식별하는 것이 중요합니다.
사용 설명서 FAQ
사용 설명서란 정확히 무엇입니까?
사용자 설명서는 사용자 설명서 또는 사용자 가이드의 형태로 제공되는 정보이며 최종 사용자가 제품과 성공적으로 상호 작용할 수 있도록 돕기 위한 것입니다.
- 어떤 종류의 사용자 설명서가 있습니까?
소책자나 설명서와 같은 물리적 문서는 전통적으로 사용자 문서를 제공하는 데 사용되었습니다. 요즘에는 사용 설명서가 디지털 방식으로 더 자주 제작되고 배포됩니다. - 사용 설명서에는 무엇이 포함되어 있습니까?
사용 설명서 또는 사용 설명서는 좋은 디자인, 명확한 글, 문제 해결에 중점을 두고 있습니다. 나는 목차가 있어야 하고, 논리적 계층 구조와 흐름을 고수하고, 접근 가능한 콘텐츠를 제공해야 합니다. 또한 좋은 사용자 설명서는 검색 가능하며 사용자의 의견을 고려합니다.views. - 사용자 문서는 어떻게 만들어지나요?
간단한 단계를 사용하여 사용자 설명서를 개발할 수 있습니다. 사용자 가이드의 목적이 먼저 결정되어야 하며 이를 달성할 수 있는 전략이 개발되어야 합니다. 사용 설명서는 게시되기 전에 필요에 따라 테스트 및 업데이트되어야 합니다. 마지막으로 사용자 가이드를 최신 상태로 유지하고 새 업데이트나 버전이 추가되면 변경하는 것이 중요합니다.