https://www.wikihow.it/Creare-un-Manuale-d%27Uso
- |
사용자 설명서는 어떤 작업을 수행하거나 사용하는 방법에 대한 지침을 제공하는 물리적으로 작성된 설명서(종이) 또는 전자 문서(PDF 또는 XPS)입니다.“사용설명서”는 가장 일반적으로 컴퓨터 소프트웨어에 관한 것으로 생각되지만, 사용설명서는 컴퓨터나 TV, 스테레오, 전화기, MP3 플레이어 등의 기타 전자기기, 가전제품, 정원에 있는 장비에도 부착되어 있습니다.좋은 사용자 매뉴얼은 사용자에게 제품의 기능을 알려주고, 효과적이고 쉽게 접근할 수 있는 방식으로 각 사용자의 작동 방법을 알려줍니다.다음은 사용 설명서의 효과적인 콘텐츠와 레이아웃을 만들 때 고려해야 할 요소입니다.
-
참조 사용자를 정의합니다. 성공적인 매뉴얼을 작성하려면 서면 프로필을 작성하여 공식적으로 또는 사용자의 특성에 대해 합리적인 가정을 하는 데 시간을 투자하여 비공식적으로 사용자 프로필을 작성해야 합니다.이와 같은 프로필은 사용자 문서를 작성하는 팀의 일원일 때 유용하며, 아이디어에서 최종 형태로 제품을 가져오는 과정에도 도움이 될 수 있습니다.사용자 프로필을 작성할 때 고려해야 할 요소는 다음과 같습니다.
- 사용자가 집, 사무실, 원격 작업장 또는 자동차에서 매뉴얼을 사용할 장소.이는 내용뿐만 아니라 매뉴얼의 스타일에도 영향을 미칠 수 있습니다.
- 사용자가 가이드를 사용하는 방법.매뉴얼을 거의 참조하지 않거나 정보를 검색해야 하는 경우에는 주로 참조 문서 형식을 취해야 합니다.처음에 사용자가 자주 문의하는 내용인 경우 참조 섹션에는 "시작하기" 섹션과 제품의 가장 일반적인 사용에 대한 지침이 함께 제공되어야 합니다.
- 사용자가 해당 제품 또는 동일한 카테고리의 다른 제품에 대해 이미 경험한 정도입니다.귀하의 제품이 새 제품이거나 유사한 제품과 상당한 차이가 있는 경우 이러한 차이점에 대한 설명과 사용 시작 방법에 대한 지침을 포함해야 합니다.제품이 많은 컴퓨터 응용 프로그램과 같이 사용자가 자주 문제를 겪는 문제를 다루는 경우 이해하기 쉬운 스타일로 적절한 정보와 세부 정보를 제공해야 합니다.
-
사용자가 이해할 수 있는 방식으로 사용자의 요구 사항을 해결하세요. 사용자가 기술적 경험이 없는 한 명확하고 간단한 설명을 선호하고 특정 용어를 피하는 것이 가장 좋습니다.또한 텍스트는 사용자의 추론을 수용할 수 있도록 구성되어야 합니다.기능별로 그룹화하여 제품 기능을 나열하는 것이 목록에서 일반적으로 사용되는 순서보다 더 의미가 있는 경우가 많습니다.
- 더 일반적인 원형 및 막대형 차트와 함께 피보나치 차트를 포함하는 차트 작성 소프트웨어와 같이 기술 용어를 사용할 수 없는 경우도 있습니다.비슷한 경우에는 재무 분석에서 피보나치 테이블의 정의와 유용성을 탐구하는 등 용어를 정의하고 설명을 제공하는 것이 유용합니다.
-
사용자가 해결하려는 문제를 설명하고 해결책을 제시합니다. 일반적인 문제에 대한 솔루션만 제공하는 것은 제품의 판매 단계에서 작동하지만 일단 사용자가 제품을 구입한 후에는 이를 가장 좋은 방법으로 사용하는 방법을 이해해야 합니다.사용자가 직면하게 될 특정 문제를 식별하고 이를 사용자 가이드에 설명한 다음 문제 해결 지침으로 이동합니다.
- 문제가 복잡한 것이라면 작은 부분으로 나누어 보세요.각 부분을 해결하거나 처리하는 방법에 대한 지침과 함께 나열한 다음, 순서대로 배열하세요.이 프로세스를 "청킹"이라고 합니다.
광고
-
적절한 표지와 제목 페이지를 포함합니다. 단순한 참조 카드 이상으로 구성된 각 사용 설명서의 표지와 접힌 종이보다 긴 설명서(4페이지 이상)의 표지가 필요합니다.
- 설명서가 저작권으로 보호되는 경우 표지와 제목 페이지에 모두 명시해야 합니다.
- 매뉴얼 및 관련 제품의 이용약관을 보고할 경우 표지 안쪽에 이를 포함시켜야 합니다.
-
소개에 연결된 문서에 대한 참조를 포함합니다. 사용자 문서가 두 권 이상을 다루는 경우 여기에 올바른 버전의 다른 문서에 대한 참조를 제공하십시오.소개 부분에는 필요한 경우 "이 가이드 사용 방법" 섹션을 삽입할 수 있는 부분이기도 합니다.
-
매뉴얼이 10페이지를 초과하는 경우에는 색인을 포함시키십시오.
-
매뉴얼 본문에 지침/방법 및 참고 자료를 배치합니다. 대부분의 경우 방법과 참고 자료에는 각각 고유한 섹션이 있어야 하지만 사용자에게 항상 한 섹션에서 다른 섹션으로 특정 콘텐츠를 참조하도록 지시할 수 있습니다.이를 통해 사용자는 원하는 정보를 더 빠르게 찾을 수 있습니다.
- 방법은 설명서의 지침 섹션 전반에 걸쳐 일관되게 작성되어야 합니다.작업 개요부터 시작한 다음 사용자가 수행해야 하는 작업과 달성해야 하는 결과를 설명합니다.이 문서의 각 섹션에 있는 단계와 마찬가지로 단계에는 번호를 매기고 동작 동사로 시작해야 합니다.
- 참고 자료에는 옵션 목록, 팁, 자주 묻는 질문(FAQ)이 포함될 수 있습니다.일반적으로 사용되는 용어 목록이 처음에 나타날 수도 있지만 설명서 끝 부분에 용어집과 부록이 추가될 수 있습니다.매뉴얼이 20페이지 미만인 경우 색인을 생략할 수 있습니다.
-
텍스트를 뒷받침하는 데 필요한 경우 그래픽을 사용하십시오. 그래픽이나 스크린샷은 특히 사용자가 올바른 실행을 시각적으로 확인해야 하는 복잡한 절차 내에서 텍스트보다 설명서의 특정 사항을 더 잘 설명할 수 있습니다.그래픽은 CAD 프로그램이나 그래픽 소프트웨어, 디지털 편집 및 디지털 카메라를 사용하여 제작할 수 있으며, 스크린샷의 경우 컴퓨터에 내장된 기능("스탬프"/cmd+shift+3) 또는 다음을 제공하는 그래픽 프로그램을 통해 제작할 수 있습니다. 화면 녹화 옵션.
- 그래픽이 생성되면 압축 형식으로 저장하여 프로그램 작성이나 출판에 사용할 수 있습니다.또한 사용자의 세부 정보를 줄이지 않고 페이지에 더 쉽게 포함할 수 있도록 파일 크기를 줄이는 것이 좋습니다(필요한 경우 원본 이미지를 분해하고 텍스트를 살펴보면서 관련 부분을 표시해야 할 수도 있습니다). .
- 방법에 수많은 그래픽을 사용하는 경우 길이와 너비가 모두 같거나 항상 원래 크기에서 같은 비율로 축소되는지 여부에 관계없이 치수의 일관성을 유지하십시오.이렇게 하면 이미지가 사용자에게 더욱 매력적으로 보일 것입니다.마찬가지로 스크린샷을 컴퓨터에 저장할 때 설명서에서 이러한 색상을 유지하도록 요구하는 경우를 대비해 이 단계에서 컴퓨터가 표준 색상으로 설정되어 있는지 확인하십시오.
- Photoshop 및 Paint Shop Pro와 같은 그래픽 프로그램은 우수한 화면 저장 기능을 제공하지만 SnagIt과 같은 특수 프로그램을 사용하면 화면을 쉽게 편집하고 카탈로그화하고 고정할 수도 있습니다.
광고
-
읽을 수 있는 글꼴 몇 개를 선택하세요. 컴퓨터는 다양한 글꼴을 지원할 수 있지만 사용자 설명서의 목표는 쉽게 읽을 수 있도록 하는 것입니다.잘 어울리는 글꼴 몇 개를 선택하는 것이 이 목표를 달성하는 가장 좋은 방법입니다.글꼴에는 2가지 범주가 있습니다."serif" 및 "sans serif"(세리프 유무에 관계없이).
- 세리프 글꼴은 글자의 주요 획 끝에 작은 끝부분이 있습니다.Serif 글꼴에는 Times New Roman, Baskerville 및 Book Antiqua가 포함됩니다.세리프체는 인쇄된 사용자 설명서의 본문에 있는 10-12 크기의 큰 텍스트 블록에서 가장 잘 작동합니다.
- 산세리프 글꼴은 끝이 없이 글자를 형성하는 획만 나타냅니다.산세리프체에는 Arial, Calibri 및 Century Gothic이 포함됩니다.이러한 글꼴은 온라인 설명서나 PDF에서 8-10 크기의 큰 텍스트 블록에 사용할 수 있지만 끝 부분이 부족하여 12+ 크기의 문장을 읽기가 더 어렵습니다.그러나 헤드라인과 제목을 표시하기 위해 더 큰 크기에서 효과적으로 사용할 수 있으며, 열이나 표의 바닥글과 숫자에 대해 더 작은 크기에도 동일하게 적합합니다.
- 일반적으로 사용 설명서에는 Arial 또는 Times New Roman과 같은 중립 글꼴을 선택해야 합니다. 예를 들어 판타지나 과학이 포함된 비디오 게임용으로 글을 쓰는 경우 인용문이나 제목의 경우 장식 글꼴을 선택하는 것이 더 좋습니다. 소설 설정(동일한 텍스트에서 발췌한 경우 동일한 글꼴을 "기울임꼴" 형식으로 사용할 수 있는 경우가 많습니다).
- 사용할 글꼴을 선택한 후에는 테스트 페이지를 만들어 글꼴이 종이에 잘 어울리는지 확인하세요.계속하기 전에 매뉴얼의 모양을 승인해야 하는 사람에게 이 증거를 보여줄 수도 있습니다.
-
레이아웃을 생각해 보세요. 사용자 설명서의 글꼴을 선택한 후에는 페이지의 다양한 요소 위치를 결정해야 합니다.
- 일반적으로 매뉴얼이나 장 제목을 머리글이나 페이지 하단에 배치하는 것이 좋습니다. 이상적으로는 왼쪽 페이지에 매뉴얼 제목을, 오른쪽에 장 제목을 사용하는 것이 좋습니다.페이지 번호는 위나 아래, 바깥쪽(머리글이나 바닥글) 또는 중앙(바닥글만)에 있어야 합니다.페이지 번호를 중앙에 배치하고 다음 페이지를 머리글 바깥쪽 모서리에 배치하여 각 섹션이나 장의 첫 번째 페이지를 다른 페이지와 구별할 수 있습니다.
- 텍스트의 일부를 색상이나 음영 상자에 그려 나머지 텍스트와 분리할 수 있습니다.반드시 텍스트와 겹치지 않는 색상이나 음영 정도를 선택하세요.
- 함께 묶일 가장자리에 충분한 공간을 두고 모든 면에 적당히 넓은 여백을 남겨두십시오.
-
사용자 매뉴얼의 제본 유형을 고려하십시오. 매뉴얼이 4페이지 이상인 경우 어떤 방식으로든 제본해야 합니다.내부 문서는 한쪽 모서리에 함께 스테이플로 고정할 수 있지만, 제품과 함께 제공되는 외부 설명서는 일반적으로 다음 세 가지 방법 중 하나로 제본됩니다.
- 측면 스테이플은 21x27.5cm, 21x35cm 또는 27.5x42.5cm 크기의 접힌 종이로 구성된 설명서에 적합합니다.48페이지 미만의 대부분의 경제 매뉴얼은 이런 방식으로 제본됩니다.
- 측면 솔기는 비자동차 제품에 포함된 사용 설명서보다는 외부 참조 가이드에 더 일반적으로 사용되지만, 일부 긴 가이드는 이런 방식으로 바인딩됩니다(Paint Shop Pro는 처음에 솔기 바인딩 가이드와 함께 배송되었으며, JASC Software에서 제작했을 때) ).
- 나선형 제본은 스테이플 또는 스테이플러로 고정된 매뉴얼이 저항하지 않는 실외 환경과 같이 보다 견고하게 설계된 사용자 가이드에 적합합니다.일부 나선형 제본 매뉴얼에는 물이나 진흙과의 접촉으로 인해 손상되는 것을 방지하기 위해 코팅된 페이지가 포함될 수도 있습니다.
-
매뉴얼용 템플릿을 만드세요. 많은 작성 및 출판 프로그램은 사용자 매뉴얼을 위한 템플릿 문서를 생성할 수 있는 가능성을 제공하므로, 글을 작성할 때 작업 중인 매뉴얼 부분 내에서 텍스트가 자동으로 원하는 글꼴로 표시됩니다(이 기사는 실제로 처음에는 MS Word 템플릿을 사용하여 작성되었습니다).이러한 프로그램 중 상당수에는 처음부터 템플릿을 만드는 대신 필요에 맞게 수정할 수 있는 미리 만들어진 템플릿 세트도 포함되어 있습니다.
- 작성 및 출판 프로그램을 사용하면 머리글, 바닥글, 제목 및 텍스트 본문에 대한 "스타일", 미리 설정된 글꼴 및 크기를 만들 수도 있습니다.미리 정의된 스타일(예: "제목1", "일반", "인용문") 중 하나를 선택하거나 고유한 이름으로 사용자 정의 스타일을 만들 수 있습니다.동일한 텍스트에 대해 여러 스타일이 있는 경우 가능한 한 제도적 스타일 명명 규칙을 따르십시오. 예를 들어 MS Word에서는 제목 스타일을 "제목 1", "제목 2" 등으로 표시합니다.제목별로, 주요 제목부터 다양한 자막 수준까지).필요한 모든 스타일을 미리 만들어 두십시오. 그러면 실제 글쓰기 과정에서 스타일 생성을 중단할 필요가 없습니다.
광고
조언
- 가능하면 코드와 텍스트 변수를 잘 활용하세요.실제 텍스트를 작성하는 대신 제품명, 매뉴얼 제목, 장 제목 등의 값을 지정하여 문서에 배치할 수 있습니다.문서를 미리 보거나 인쇄할 때 변수는 텍스트로 대체됩니다.제품명이 변경되거나, 매뉴얼이나 장의 이름이 변경된 경우, 문서 내에서 검색해서 바꾸는 것보다 텍스트 변수의 값을 바꾸는 것이 정보를 변경하는 것이 더 쉬울 것입니다.
광고
필요한 것
- 저술 또는 출판 프로그램
- 그래픽 또는 영상 녹화 프로그램
아래 라이선스: CC-BY-SA