사용자 설명서 작성 방법

사용자 설명서 또는 사용자 가이드는 특정 제품에 대해 사용자를 교육하도록 설계된 기술 통신 문서입니다. 인쇄 또는 디지털로 제작되어 거의 모든 제품에 대해 작성할 수 있지만 컴퓨터 소프트웨어 및 하드웨어,전자 장치 및 비디오 게임에서 가장 일반적입니다.

일반적으로 기술 작가 또는 제품 디자이너에 의해 작성,그 목적은 사용자에게 알리고 그들이 제품에 관련된 문제를 해결하는 데 도움이하는 것입니다. 제품 유통의 중요한 구성 요소로서 매뉴얼의 품질은 전반적인 고객 경험에 큰 영향을 미칠 수 있으며,이것이 바로 당신이 그것을 올바르게 얻고 자하는 이유입니다!

이 기사에서는 고객에게 정보를 명확하게 전달하는 사용 설명서를 작성하는 방법에 대한 팁을 공유하고 젠키트의 작성 과정을 어떻게 구성 할 수 있는지 보여 드리겠습니다.

사용자 설명서 작성 팁

사용자 설명서 작성에는 많은 부분이 있습니다. 기능 설명에서,모든 법적 세부 사항 및 안전 경고,지침을 복구합니다. 여기 그것을 쓰기에 올 때 명심할 것이다 몇몇 끝은 있는다:

  1. 당신의 목표를 알고

모든 사용자 설명서는 목적을 가져야한다. 일반적으로,그것은 사용자가 귀하의 제품에 관한 문제를 해결 하는 데 도움이 하지만 당신은 또한 당신이 그들을 도울 방법을 결정 해야. 너가 너가 가지고 가고 싶는 각에 결정하면 하자마자,따르기 위하여 똑바른 충분히 단계적인 지시와 단면도로 정보를 나누십시요.

  1. 사용자 결정

사용 설명서가 작성 방법에 영향을 미치므로 사용자 설명서를 읽을 대상자의 종류를 알아야 합니다. 일반 사용자를 알면 사용자 설명서,형식 및 전반적인 스타일을 작성할 때 사용 해야 하는 언어의 아이디어를 줄 수 있습니다. 예를 들어,기술에 정통한 전문가를 위해 글을 쓰는 것은 젊은 가족을 둔 부모를 위해 글을 쓰는 것과 매우 다를 것입니다.

  1. 접근 가능한 언어 사용

청중이 누구인지에 관계없이 사용자 설명서 텍스트의 언어는 가장 비 기술적 인 사람조차도 액세스 할 수 있어야합니다. 너는 독자가 너의 제품에 관하여 영 지견이 있는다 것 을 추측해야 한다,그래서 이해할 수 있고,명확하고,간결해야 한다. 그것은 독자를 다루어야 하고 특수 용어의 사용은 한정되어야 한다.

  1. 시각적으로 만들기

인간은 텍스트보다 60,000 배 빠른 시각 데이터를 처리하는 것으로 알려져 있으므로 사용자 설명서에 이미지를 포함하기를 원합니다. 사용자 설명서에는 거의 항상 텍스트와 관련된 이미지가 포함됩니다. 일부 제품은 단계별 지침의 스크린 샷 이미지를 공유하거나 순전히 이미지(이케아 매뉴얼은 유명한 텍스트 무료)입니다. 심상은 진짜로 너가 너의 독자에게 교통하고 싶는 메시지를 전한것을 도울 수 있는다.

  1. 발견 가능성 향상

아무도 전체 사용 설명서를 읽지 않을 것이므로 독자가 그 안에 가치를 찾으려면 사람들이 훑어보고 찾고있는 것을 찾을 수있을만큼 간단하게 만들어야합니다. 페이지에서 페이지에 일관하는 배치를 있어서서 그것에게 청결한 체재를 주고 원본의 덩어리사이 많은 공간 있는다 것 을 확인하십시요. 제품에 관련 된 친숙 한 키워드를 사용 하 고 글꼴은 간단 하 고 읽을 수 있는지 확인.

사용자 설명서를 계획하는 방법

젠키트는 사용자 설명서를 계획하는 훌륭한 도구입니다. 프로젝트 관리 도구에는 데이터를 수집한 다음 구조화하여 최적화된 워크플로를 만들 수 있는 기능이 포함되어 있습니다. 사용자 설명서 작성 프로세스를 구성하는 단계는 다음과 같습니다.

단계 1:

젠키트 무료 계정에 가입하고 로그인하십시오.

2 단계:

프로필을 사용자 정의한 후”새 컬렉션”을 클릭하고 컬렉션에 이름을 지정하고 입력 또는”만들기”를 누르십시오. 기본 칸반 보기로 이동합니다.

당신은 당신의 컬렉션에 대한 아이콘을 사용자 정의하여 약간의 문자를 제공 할 수 있습니다. 이렇게하려면 컬렉션 제목,선택”사용자 정의”를 클릭하고 원하는 색상과 아이콘 로고를 선택합니다.

저는 개인적으로 칸반 보드를 사용하여 프로젝트 계획을 시각적으로 매핑하는 팬입니다. 시각적 스케줄링 시스템은 계획 프로세스 중에 발생할 수있는 병목 현상 및 문제를 식별하는 데 적합합니다. 그것은 또한 당신에게 당신의 프로젝트가 어떻게 진행되는지에 대한 명확한 개요를 제공 할 수 있습니다.

칸반 보기에는”할 일,진행 중 및 완료”라고 표시된 세 개의 기본 열이 표시됩니다. 레이블 이름 중 하나를 클릭하고 나타나는 메뉴 상자의 이름 섹션으로 이동하여 열 이름을 바꿀 수 있습니다. 워크플로에 더 많은 스테이지를 추가하려면”+스테이지 추가”를 클릭하고 열에 레이블을 지정하고”만들기”를 클릭하거나 입력을 누르기만 하면 됩니다.

당신이 당신의 워크 플로우에 대해 원하는 당신이 맞는 볼 무엇이든을 레이블을 물론 당신은 많은 단계를 선택할 수 있습니다. 내가 갔던 단계는 다음과 같습니다:

  • 정보&리소스
  • 피드백&지침
  • 섹션
  • 초안

3 단계:

워크플로의 구조가 결정되면 각 열 아래에 다른 요소를 항목으로 추가할 수 있습니다.

이 문서의 시작 부분에서 언급 한 바와 같이,사용자 설명서를 작성하는 등의 프로젝트는 많은 내용을 포함한다;다양한 장과 섹션 및 섹션의 섹션으로 분류 할 필요가 콘텐츠.

젠키트의 하위 항목은 더 큰 작업을 더 작은 작업으로 나누는 완벽한 기능입니다. 당신이 관리 타임 라인과 함께 작업 할 수있어,그래서 우리의 프로젝트 관리 도구의 12 사용자 정의 필드 중 하나는 구조화 된 방법으로 모든 항목을 제공합니다.

당신은 더 하위 하위 항목으로 이미 세분화 된 항목을 분해 할 수 있습니다!

항목 중 하나에 하위 항목을 추가하려면 항목을 클릭하여 엽니다. 그런 다음 주석 섹션 위에있는”+”기호를 클릭 한 다음”사용자 정의 필드”를 선택하십시오. ‘유형’섹션에서 아래로 스크롤하여’하위 항목’필드를 선택하십시오. 필드에 이름을 지정하는 것을 잊지 마십시오!

4 단계:

워크플로에 추가 구조를 추가하려면 젠키트의 계층 구조 뷰를 사용할 수 있습니다. 귀하의 컬렉션에서이 보기를 활성화 하려면 클릭”칸 반”(또는 어느 보기의 이름에 있을 일이)오른쪽 상단 모서리에 찾아”새 보기”를 선택 합니다. 메뉴 확장이 나타나고 단순히”계층 구조”를 선택해야합니다.

5 단계:

계층 뷰를 처음 사용하면 항목이 연결되지 않은 것을 알 수 있습니다. 각 항목을 기본 계층 패널로 끌어서 놓아 연결할 수 있습니다. 상위 항목을 드래그하면 하위 항목이 함께 표시됩니다.

항목에 할당된 계층은 배치 위치에 따라 달라집니다. 예를 들어,맨 위로 끌어온 항목은 1 단계 계층 구조를 가지며 다른 항목 아래로 끌어온 항목은 해당 항목의 하위 항목으로 바뀝니다.

계층 구조 뷰에는 항목이 하위 항목이 되는 시점을 나타내는 들여쓰기를 사용하여 항목의 계층 구조에 추가한 모든 단일 항목이 표시됩니다. 당신은 상위 작업의 개요를 얻거나 축소 또는 항목을 열어 한 번에 프로젝트의 모든 것을 볼 수 있습니다.

다른 종류의 텍스트 문서 및 자료 계획

사용자 설명서를 계획하는 것과 마찬가지로 젠키트는 다른 텍스트가 많은 문서 또는 자료를 계획하는 데 사용할 수 있습니다. 계층 구조보기 및 하위 항목 기능은 소설이나 대학 논문과 같은 다른 섹션으로 세분화해야하는 많은 양의 콘텐츠를 구성해야하는 프로젝트를 계획하는 데 적합합니다.

소설 쓰기 계획

소설을 쓰는 것은 완료하는 데 몇 년이 걸릴 수 있으므로 모든 것을 적어 두는 것이 좋습니다. 사용자 설명서 가이드와 유사한 템플릿을 사용하여 장별로 소설 장을 구성하고 하나의 플랫폼에서 모든 캐릭터,플롯 및 테마 세부 정보를 추적 할 수 있습니다.

논문/논문 계획

주제 아이디어에서 연구에 이르기까지 데이터 수집,논문 또는 논문 작성에는 많은 계획이 필요합니다. 젠키트를 이용해서 모든 것을 관리하면,제때에 논문을 완성할 수 있고 중요한 것을 간과하지 않을 수 있습니다!

논문/논문 계획 템플릿을 사용하려면 여기를 클릭하십시오.

훌륭한 사용 설명서는 독자에게 정보를 명확하게 전달하여 제품에 발생할 수있는 문제를 극복 할 수 있도록합니다. 젠키트를 사용하여 작성 과정을 계획하고 계층 구조 뷰와 하위 항목 기능을 활용하면 고객에게 최상의 경험을 제공할 수 있는 양질의 사용 설명서를 만들 수 있습니다.

마지막으로 도움이 된 사용 설명서는 무엇입니까?

건배,

디니와 젠키트 팀

이 글이 도움이 되었나요? 그것을 평가하십시오!

답글 남기기

이메일 주소는 공개되지 않습니다.