소프트웨어 사용자 매뉴얼의 개요

소프트웨어 사용자 매뉴얼은 사용자가 소프트웨어를 사용하는 과정에서 필요한 내용을 문서로 기록한 설명서와 안내서이다.

• 사용자 매뉴얼은 사용자가 소프트웨어 사용에 필요한 절차, 호나경 등의 제반 사항이 모두 포함되도록 작성한다.
• 소프트웨어 배포 후 발생될 수 있는 오류에 대한 패치나 기능에 대한 업그레이드를 위해 매뉴얼의 버전을 관리한다.
• 개별적으로 동작이 가능한 컴포넌트 단위로 매뉴얼을 작성한다.
• 사용자 매뉴얼은 컴포넌트 명세서와 컴포넌트 구현 설계서를 토대로 작성한다.
• 사용자 매뉴얼에는 목차 및 개요, 서문, 기본 사항 등이 기본적으로 포함되어야한다.
• 사용자 매뉴얼의 목차에는 매뉴얼 전체 내용을 순서대로 요약한 후 관련 내용의 시작 페이지를 함께 기술한다.
• 사용자 매뉴얼의 개요에는 소프트웨어의 주요 특징, 매뉴얼의 구성과 실행 방법, 사용법, 항목별 점검 기준, 항목별 설정 방법 등에 대한 내용을 기술한다.

서문

서문에는 문서 이력, 사용자 매뉴얼의 주석 기록 보관을 위해 필요한 내용을 기술한다.

• 문서 이력

버전	작성자	작성일	검토자	일시	검수인
v0.1	박정호	2021-04-12	황종근	2021-04-15	박인식
변경내용	최초작성
v1.1	신동석	2021-04-20	황종근	2021-04-21	박인식
변경내용	제품 등록 방법 변경

• 사용자 매뉴얼의 주석: 주의 사항과 참고 사항을 기술한다.
• 주의 사항: 소프트웨어를 사용할 때 사용자가 반드시 알고 있어야 하는 중요한 내용을 기술한다.
• 참고 사항: 특별한 사용자의 환경이나 상황에 대한 내용을 기술한다.
• 기록 보관 내용
  소프트웨어를 사용하면서 필요한 기술 지원이나 추가 정보를 얻기 위한 소프트웨어 등록 정보를 기술한다.
  소프트웨어 등록 시 필요한 정보는 소프트웨어 명칭, 모델명, 문서 번호, 제품번호, 구입 날짜 등이다.

기본 사항

소프트웨어와 관련하여 기본적으로 설명되어야 할 항목들을 다음과 같다.

항목	설명
소프트웨어 개요	소프트웨어의 주요 기능 및 UI 설명, UI 및 화면 상의 버튼, 프레임 등을 그림으로 설명
소프트웨어 사용 환경	소프트웨어 사용을 위한 최소 환경 설명, CPU 메모리 등의 PC 사양 운영체제(OS) 버전 설명, 최초 구동에 대한 설명, 소프트웨어 사용 시 발생할 수 있는 프로그램 충돌이나 개인정보 보안 등에 관한 주의사항을 설명한다.
소프트웨어 관리	소프트웨어의 사용 종료 및 관리 등에 관한 내용 설명
모델, 버전별 특징	모델 및 버전별로 UI 및 기능의 차이점을 간략하게 요약한다.
기능, 인터페이스의 특징	제품의 기능과 인터페이스의 특징을 간략하게 요약한다.
소프트웨어 구동 환경	개발에 사용한 언어 및 호환 가능한 운영체제(OS)에 대해 설명한다, 설치 후 구동하기까지의 과정을 운영체제(OS)별로 설명한다.

사용자 매뉴얼 작성 방법

사용자 매뉴얼은 사용자가 사용 방법을 이해하기 쉽도록 상황별로 누락 없이 캡처하여 순서대로 상세히 설명한다.

• 사용자 매뉴얼에는 사용자 화면 및 UI, 주요 기능 분류, 응용 프로그램 및 설정, 장치 연동, Network 환경, Profile 안내, 고객 지원 방법, 준수 정보 및 제한 보증 등에 대한 내용을 기술한다.

사용자 화면 및 UI

• 주의 사항과 참고 사항을 기술한다.
• 주의 사항: 소프트웨어를 사용할 때 사용자가 반드시 알고 있어야 하는 중요한 내용을 설명한다.
• 참고 사항: 특별한 사용자의 환경이나 상황에 대한 내용을 설명한다.

주요 기능 분류

• 기능이 실행되는 화면을 순서대로 캡처하여 기능에 대한 사용법을 설명한다.
• 기능이 구현되는 과정에서 참고할 사항이나 주의할 사항에 대한 메모를 추가한다.

응용 프로그램 및 설정

• 소프트웨어 구동 시 함께 실행해도 되는 응용 프로그램, 또는 함께 실행되면 안 되는 응용 프로그램에 대해 설명한다.
• 소프트웨어가 구동될 때 먼저 실행되어야 할 응용 프로그램이 있다면 설명한다.
• 소프트웨어가 정상적으로 구동되기 위한 설정이나 기본값에 대해 설명한다.

장치 연동

소프트웨어가 특정 장치에 내장되는 경우 연동되는 장치에 대해 설명한다.

Network 환경

Network에 접속되어 사용되는 소프트웨어인 경우 정상적인 연결을 위한 설정값 등을 설명한다.

Profile 안내

• Profile은 소프트웨어의 구동 환경을 점검하는 파일로, 사용자가 Profile의 경로를 변경하거나 위치를 이동하지 않도록 안내한다.
• Profile과 같이 소프트웨어 구동에 필수적인 파일에 대해 설명한다.

고객 지원 방법

• 사용과 관련하여 기술적인 지원이나 소프트웨어에 대한 서비스를 원할 경우 국가, 웹 사이트, 전화번호, 이메일 등 문의할 수 있는 연락처를 안내한다.

준수 정보 & 제한 보증

• Serial 보존, 불법 등록 사용 금지 등에 대한 준수 사항을 안내한다.
• 저작권자 소유권 정보, SW 허가권 정보, 통신 규격, 개발 언어, 연동 프로그램, 문서 효력, 지적 소유권 정보 등과 관련된 정보를 안내한다.

사용자 매뉴얼 작성 순서

소프트웨어 사용자 매뉴얼은 다은과 같은 순서로 작성한다.

작성 지침 정의 ➡️ 사용자 매뉴얼 구성 요소 정의 ➡️ 구성 요소별 내용 작성 ➡️ 사용자 매뉴얼 검토

작성 지침 정의

• 사용자 매뉴얼을 작성하기 위한 지침을 기록한다.
• 작성 지침은 사용자 환경에 필요한 정보를 제공할 수 있는 형태로 기록한다.

사용자 매뉴얼 구성 요소 정의

• 소프트웨어의 기능, 구성 객체 목록, 객체별 메소드, 메소드의 파라미터, 실제 사용
  예) 사용자 환경 셋팅 방법 등을 기록한다.

구성 요소별 내용 작성

• 사용자 매뉴얼 구성 요소별로 내용을 기록한다.

사용자 매뉴얼 검토

• 작성된 구성 요소별 내용이 올바른지, 부족한 부분은 없는지 등을 검토하여 수정 및 보완한다.