사용자 매뉴얼 작성

동영상: [시나공 정보처리] 1419500 소프트웨어 사용자 매뉴얼 작성

콘텐츠

단계로
4 단계 중 1 : 사용 설명서 계획
4 단계 중 2 : 필수 정보 삽입
4/4 부 : 제품 유지 관리 설명
4/4 부 : 읽기 쉬운 매뉴얼 작성
팁

소프트웨어, 컴퓨터, 게임 및 장치에는 사용자 설명서가 필요합니다. 제품 사용 방법 (및 사용하지 않는 방법)을 설명합니다. 사용 설명서는 특정 구조를 가진 공식 문서이며 기술 작가 나 제품 디자이너와 같이 제품을 완전히 아는 사람이 작성해야합니다. 효과적인 사용자 매뉴얼을 작성하려면 누가 제품을 사용할 것인지 알고 이러한 사용자를 염두에두고 매뉴얼을 작성해야합니다. 번거롭지 않은 사용자 경험을 보장하기 위해 명확하고 정확하며 간단하게 작성하십시오.

단계로

4 단계 중 1 : 사용 설명서 계획

사용자 분석을 수행하십시오. 사용자 매뉴얼은 제품이나 서비스를 구매하고 사용자 매뉴얼을 읽는 사용자를 위해 작성되어야합니다. 사용자 분석은 귀하의 주요 또는 대상 청중이 누구인지를 알려주고 텍스트 작성을 안내합니다.
- 장치를 사용할 사람들과 이야기하십시오. 제어 된 조건에서 테스트 사용자에게 장치의 프로토 타입과 초안 사용자 설명서를 제공합니다. 테스트 사용자에게 사용 설명서에서 명확하지 않거나 혼란스러운 부분에 대한 피드백을 요청하고이 피드백을 기반으로 사용자 가이드를 변경하십시오.
- 전체 청중을 만족시킬 수는 없습니다. 목표 청중 또는 가장 많은 청중에 맞춘 매뉴얼을 작성하십시오.
- 연령, 건강 (질병, 학습 장애 또는 장애가 있습니까?) 및 청중의 교육 수준을 고려하여 사용자 설명서를 작성하는 가장 좋은 방법을 결정하십시오.
사용자 설명서의 디자인을 조정하십시오. 장치 또는 제품을 설계하고 개발하는 데 도움을 준 팀의 일원이라면 제품의 작동 방식을 설명하기 위해 제품을 객관적으로 살펴보기가 어려울 수 있습니다. 따라서 사용자 설명서를 준비하는 데 도움이되는 작가 (가급적 쓰기 지침 작성 경험이있는 사람)와 그래픽 디자이너의 조언을 구해야합니다. 외부 컨설팅을 통해 또는 자신의 회사 또는 조직에서 이러한 사람들을 선택할 수 있습니다.
작업 분석을 수행하십시오. 작업 분석은 장치 사용에 필요한 단계를 식별하고 구성하는 프로세스입니다. 철저한 작업 분석을 통해 각 단계에 필요한 재료 및 장비 (예 : 배터리, 의약품 또는 기타 사용자 제공 제품)는 물론 각 단계에 필요할 수있는 조치, 오류 및 문제 해결 조언을 식별합니다.
- 다양한 작업 또는 하위 작업을 수행 할 수있는 제품이있는 경우 각 작업에 대해 작업 분석을 수행해야합니다. 예를 들어, 자동차에서 경적을 울리고 몸을 묶고 헤드 라이트를 켜거나 끌 수 있습니다. 필요한 경우 각각에 대한 작업 분석을 수행하십시오.
제품이 라벨링 및 마케팅 승인 요구 사항을 충족하는지 확인하십시오. 이러한 요구 사항은 제품이 사용자의 안전을 염두에두고 제조되고 방사선 및 감전과 같은 위험한 조건에 대한 사용자의 노출을 제한하도록 보장합니다. 광고는 제품의 목적과 기본 작동 지침을 명확하게 나타내야하며 소유자 설명서를 작성할 때 이러한 리소스를 사용해야합니다.
- 제품의 사용 설명서가 유효하려면 제품에 직접 부착 된 라벨에 따라 작성해야합니다.
- 사용 설명서를 작성하기 전에 장치가 공식적으로 판매 허가를 받았는지 확인하십시오.
매뉴얼의 레이아웃을 결정하십시오. 매뉴얼을 능률화 할 수있는 몇 가지 중요한 방법이 있습니다. 각 단어를 대문자로하여 각 섹션의 시작 부분에 굵은 제목을 넣어야합니다. 예를 들어, "장치 설정", "장치 작동"및 "문제 해결"은 모두 굵은 섹션 제목 일 수 있습니다.
- 가이드를 간소화하는 또 다른 방법은 글 머리 기호, 숫자 또는 경고 표시 나 빨간색 느낌표와 같은 작은 아이콘이있는 두 개의 열을 사용하는 것입니다. 하나는 텍스트가있는 오른쪽에 다른 하나는 텍스트의 왼쪽에 있습니다.
- 매뉴얼은 주로 장치를 설명하기 위해 각 이미지 아래에 텍스트가있는 이미지로 구성되거나, 첨부 된 이미지가 거의없는 텍스트 일 수 있습니다. 순서도를 사용하여 사용자를 안내 할 수도 있습니다. 제품에 대해 생각하고 각 방법이 매뉴얼 작성에 어떻게 도움이 될 수 있는지 생각해보십시오. 그러나 하나의 매뉴얼에서 다른 레이아웃을 혼합하지 마십시오. 하나를 골라서 고수하십시오.

4 단계 중 2 : 필수 정보 삽입

설명서를 논리적으로 구성하십시오. 매뉴얼은 사용자가 최대한의 이익을 얻을 수 있도록 구성되어야합니다. 설명서를 제품 사용에 적합한 장 또는 섹션으로 나누고 각 섹션을 빠르게 찾을 수 있도록 설명서 앞면에 목차를 포함합니다.
- 목차는 특히 긴 매뉴얼에 필요합니다.
- 청중이 익숙하지 않을 수 있음을 설명 할 용어가 많은 경우 용어집 또는 색인이 필요합니다. 그러나 용어집은 권장되지 않습니다. 가장 좋은 선택은 매뉴얼 자체의 텍스트에서 혼동되는 용어를 설명하는 것입니다. 용어집을 포함하기로 선택한 경우 설명서 앞, 목차 바로 뒤에 배치하십시오.
- 표 또는 그림 목록은 설명서에 표 또는 그림이 몇 개 이상있는 경우에만 필요합니다.
- 설명이 필요하지만 매뉴얼의 다른 곳에서 설명 할 수없는 경우에는 부록이 필요합니다.
필요한 경고를 포함하십시오. 일반 경고 또는 예방 정보는 사망 또는 심각한 부상을 포함하여 제품의 부적절한 사용으로 인한 잠재적 위험에 대한 정보를 제공해야합니다. 이러한 경고는 사용자가 먼저 볼 수 있도록 매뉴얼 맨 앞, 첫 페이지 뒤에 배치해야합니다. 잠재적으로 위험한 단계가 제안 된 직후 또는 바로 전에 설명서 텍스트에 특정 경고도 포함되어야합니다.
- 예를 들어, 전기 제품에 대한 일반적인 경고는 비가 올 때 사용하지 말아야한다는 것입니다.
- 특정 지침은 장치를 전원 콘센트에 꽂기 전에 손과 장치가 모두 말랐는지 확인하는 것입니다.
- IFU의 나머지 지침과 경고를 구분하고 사용자의주의를 끌기 위해 이미지 (예 : 두개골 및 이미지) 또는 다른 색상의 텍스트 (예 : 빨간색 텍스트)를 제공합니다.
장치를 설명하십시오. 설명에는 장치의 목적에 대한 서면 설명과 장치의 모양에 대한 작은 그래픽 표현이 모두 포함되어야합니다. 그림은 장치에 포함 된 모든 스위치, 버튼 및 부착 가능한 부품에 레이블과 이름을 지정해야합니다.
설치 지침을 제공하십시오. 설치 섹션에는 제품 또는 장치 사용 준비 방법에 대한 기본 정보가 포함되어야합니다. 가정용 사용자가 어플라이언스를 구축하거나 설정할 수없는 경우 설치 섹션 상단에 굵은 글씨로 명시하십시오. 또한 다음을 포함해야합니다.
- 부품 목록
- 포장 풀기 지침
- 설치 경고
- 잘못된 설치의 결과
- 설치 중 어려움이있는 경우 누구에게 전화해야합니까?
작업에 대한 정보를 제공하십시오. 이 섹션은 사용자 설명서에서 가장 중요한 부분이며 장치 사용 방법에 대한 구체적이고 자세한 정보를 제공해야합니다. 전원 코드를 꽂거나 손을 씻는 등 장치 사용을위한 기본 준비부터 시작하십시오. 장치 사용 방법을 설명하는 논리적이고 번호가 매겨진 단계와 장치를 올바르게 사용할 때 사용자가 기대할 수있는 피드백 (예 : "클릭 소리가 들립니다 ...")을 계속합니다.
- 이 장의 끝 부분에서 사용자는 문제 해결 장을 참조하여 빠르게 설명 할 수없는 문제를 해결해야합니다.
- 필요한 곳에 이미지를 배치합니다. 일부 단계는 그림과 단어로 가장 잘 설명됩니다. 매뉴얼에서 사진이나 삽화의 사용을 고려하십시오.
- 이 섹션에서는 다른 섹션과 마찬가지로 부적절한 사용 또는 작동에 대한 관련 안전 경고를 포함해야합니다. 예를 들어 전기 톱 사용자에게 술을 마시거나 특정 약물을 복용하는 동안 전기 톱을 사용하지 않도록 경고 할 수 있습니다.
- 사용자가 혜택을 볼 것이라고 생각되면 기기의 적절한 사용과 작동을 보여주는 온라인 동영상 링크를 포함하는 것이 좋습니다. 이 섹션의 시작 부분 또는 각 단계의 끝에서 (한 단계 만 설명하는 비디오의 경우) 이러한 비디오를 녹화 할 수 있습니다.
끝에 제품 요약을 포함합니다. 요약은 기본 작동 단계를 제공하기 위해 색인 바로 앞의 매뉴얼 끝에 나타나야합니다. 이것은 운영 정보의 단순화되고 제거 된 버전이어야하며 한 페이지를 넘지 않아야합니다. 장치 또는 제품을 사용하는 방법을 요약합니다. 기본 경고, 제품 사용 방법을 설명하는 번호가 매겨진 단계, 사용자에게 도움을 요청하는 전화 번호 또는 이메일 주소를 포함합니다.
- 사용자가 요약 시트를 자주 제거하거나 참조 할 것으로 예상되는 경우 제거 가능한 라미네이트 카드 또는 두꺼운 판지에 인쇄하여 사용자가 쉽게 휴대하고 참조 할 수 있도록 할 수 있습니다.
- 또는 사용자가 빠르고 쉽게 참조 할 수 있도록 제품에 직접 요약을 적용 할 수 있습니다.

4/4 부 : 제품 유지 관리 설명

장치를 청소하는 방법을 설명하십시오. 장치 또는 제품을 청소해야하는 경우이를 수행하는 방법을 설명하십시오. 필요한 세척제를 나열하십시오. 독자에게 얼마나 자주 청소해야하는지 알려주십시오. 그런 다음 설명서의 다른 부분과 마찬가지로 청소 방법에 대한 단계별 지침을 번호가 매겨져 있습니다.
- 청소를 위해 제품을 분해하거나 특정 부품을 제거해야하는 경우 제품 분해 방법을 표시하십시오.
- 장치 청소 실패 결과에 대한 경고를 제공합니다. 예를 들어, "장치를 청소하지 않으면 성능이 최적이되지 않습니다."라고 말할 수 있습니다.
사용자가 기본 유지 관리를 수행하는 방법을 계산합니다. 제품 또는 장치가 성능 문제를 해결하기 위해 사용자가 수리 할 수있는 경우 사용자를 위해이를 수행하는 방법에 대한 번호가 지정된 지침을 제공하십시오. 예를 들어 300 시간 사용 후 배터리를 교체해야하는 경우 배터리를 교체해야하는지 확인하는 방법, 방전 된 배터리를 제거하는 방법 및 새 배터리를 설치하는 방법에 대한 지침을 제공하십시오.
- 공인 기술자 만 수행 할 수있는 특정 유지 관리 작업이있는 경우 설명서의 유지 관리 부분을 두 부분으로 나눕니다.
스토리지 옵션에 대해 논의하십시오. 필요한 경우 제품이나 장치를 올바르게 보관하는 방법을 설명서에 설명해야합니다. 또한 저장이 필요한 이유와 부적절한 저장의 결과에 대한 정보도 포함해야합니다. 예를 들어 다음과 같이 작성할 수 있습니다.
- 서늘하고 건조한 곳에 제품을 보관하십시오. 부적절한 보관은 습기 축적으로 인해 제품의 수명을 단축시킬 수 있습니다. "
- "제품을 열에 노출 시키거나 섭씨 50도 이상의 온도에 보관하지 마십시오.그렇게하면 연소로 이어질 수 있습니다. "
문제 해결 정보를 제공하십시오. 이 섹션을 일반적인 문제 및 해결 방법 목록으로 구성 할 수 있습니다. 논리적 제목 아래 유사한 문제를 그룹화하십시오. 이러한 방식으로 사용자는 특정 문제를 빠르게 찾을 수 있습니다.
- 예를 들어, 블루 스크린을 표시하는 컴퓨터에 몇 가지 문제가있는 경우 "일반적인 화면 문제"와 같은 부제목 아래에 그룹화하십시오.
- 또한이 섹션에는 고객 서비스를위한 전화 번호 및 / 또는 이메일을 포함해야합니다.

4/4 부 : 읽기 쉬운 매뉴얼 작성

다른 사용자 가이드를 읽으십시오. 자신의 제품에 대한 설명서를 작성하기 전에 다른 효과적인 사용 설명서를 확인하십시오. 구조, 단어 선택 및 문장 구조에주의하십시오. Apple, Google 및 Microsoft와 같은 주요 브랜드는보다 신중하게 작성된 사용자 안내서를 작성하는 데 도움이되는 강력하고 효과적인 사용자 안내서를 제공합니다.
- 읽기만 하지마 모두 사용자 설명서. 판매하는 유사 제품의 설명서를 읽으십시오. 예를 들어 유아용 제품을 판매하는 경우 기술적 인 것이 아닌 유아용 설명서를 읽으십시오.
표준을 선택하십시오. 맞춤법, 단어 선택 및 문구를 표준화하면 사용자 설명서가보다 사용자 친화적으로 만들어집니다. Chicago Manual of Style과 Microsoft Manual of Style은 소유자 매뉴얼을 작성할 때 유용한 스타일 가이드가 될 수 있습니다. 둘 중 하나가 설명서에 적합한 지 확인하십시오.
- 예를 들어, 설명서에서 "전원 스위치"와 "전원 버튼"을 모두 사용하는 대신 두 용어 중 하나를 선택하고 그대로 유지하십시오.
능동태를 사용하십시오. 능동태는 사용자의 관점에서 설명하는 글쓰기 방식입니다. 주제가 정의되지 않은 수동태 인 대안보다 이해하기 쉽습니다.
- Hemingway 앱 (www.hemmingwayapp.com)을 사용하여 글에서 수동적 인 구절을 식별하십시오.
- 이 두 가지 샘플 문장을 공부하십시오. 첫 번째는 능동적이고 두 번째는 수동적입니다.
  - 패키지를 천천히 조심스럽게 개봉해야합니다.
  - 포장은 천천히 조심스럽게 개봉해야합니다.
번호가 매겨진 지침을 작성하십시오. 숫자 순서로 된 지침은 독자가 해당 제품을 사용, 연결 또는 구축하는 과정에 더 집중할 수 있도록 도와줍니다. 길고 장황한 단락 또는 번호가 지정되지 않은 일련의 단락을 작성하는 대신 각각 명확하게 번호가 매겨진 간단하고 명확한 단계로 사용자 안내서를 작성하십시오.
명령문으로 각 단계를 시작하십시오. 명령형은 행동 지향 동사입니다. 동사로 각 단계를 시작하여 독자에게 단계를 완료하는 데 필요한 작업에 대한 힌트를 제공합니다. 예를 들어 작성중인 제품에 따라 "연결", "확인"또는 "슬라이드"와 같은 명령으로 단계를 시작할 수 있습니다. 그러나 시스템의 응답으로 단계를 시작하지 마십시오.
- 예를 들어, 화면이 파란색으로 바뀌고 깜박이기 시작하면 "화면이 깜박이고 파란색으로 바뀝니다."로 단계를 시작하지 마십시오. 시도 : "홈 키를 길게 누릅니다. 화면이 깜박이고 파란색으로 바뀝니다. "
사용할 어휘를 결정하십시오. 요요 매뉴얼을 작성한다면, 청중은 대부분 어린 아이들이 될 것입니다. 간단한 단어와 어휘를 사용하여 요요가 어떻게 작동하는지 설명하십시오. 주사 전자 현미경 매뉴얼을 작성할 때 청중은 매우 상세한 정보를 이해할 수있는 고도로 숙련 된 과학자로 구성되어 있으므로 전문 어휘 나 미묘한 설명을 사용하는 것을 주저하지 마십시오.
- 일반적으로 전문 용어와 전문 용어를 피하려고합니다.
- 최대한 폭 넓은 사용자층에 효과적이려면 초등학교 6 학년에서 7 학년까지의 수준으로 작성하십시오.
제품을 해외로 배송 할 때는 번역이 정확한지 확인하십시오. 번역사를 고용하여 제품을 배송하는 국가의 모국어로 사용 설명서를 번역하십시오. 온라인 번역 프로그램을 사용할 수도 있지만 원어민에게 번역을 읽고 오류를 확인하도록 요청하십시오.
- 청중에 여러 언어 그룹이 표시되는 경우 각 관련 언어로 된 사용 설명서 번역을 포함하십시오.
- 단어 대 단어 번역이 아닌 특정 용어에 대해 대상 언어에 다른 단어가있을 수 있으므로 번역자는 제품에 대해 잘 알고 있어야합니다.
짧은 문장으로 작성하십시오. 몇 개의 긴 단락 대신 짧은 단락을 많이 사용합니다. 각 섹션에서 논리적 구분을 찾고 한 문장 또는 두 문장 청크로 유용한 정보를 요약하십시오. 문장 수준에서도 마찬가지입니다. 문장을 길고 장황하기보다는 짧고 단순하게 유지하십시오.
- 단계가 너무 길어지면 더 작은 단계로 나눕니다. 이것은 단어 수를 줄이지는 않지만 줄 바꿈을 사용하면 읽기가 더 쉬워집니다.
매뉴얼에서 오류를 확인하십시오. 매뉴얼은 문법 및 철자 오류로 인해 신뢰성을 잃을 수 있습니다. 동료 또는 기술 작가가 매뉴얼을 편집하고 교정하도록합니다. 철자와 문법 외에도 교정자는 다음 사항에주의를 기울여야합니다.
- 수동태
- 불명확하거나 혼란스러운 언어
- 래핑 된 문장 구조
- 지나치게 긴 단락