정보처리기사실기 - 제품소프트웨어 패키징 : 제품 소프트웨어 사용자 매뉴얼 구성 수립 및 작성

정보처리기사실기 - 제품소프트웨어 패키징 : 제품 소프트웨어 사용자 매뉴얼 구성 수립 및 작성

 

제품 소프트웨어 사용자 매뉴얼

 

• 사용자 관점으로 진행되며 이를 위한 제품 기능 및 고객 지원까지 포함
• 제품 소프트웨어의 특성을 먼저 이해하고 작성

 

① 사용자 매뉴얼 작성의 기본 사항

 

• 개발이 완료된 제품 소프트웨어를 고객에게 전달하기 위한 형태로 패키징
• 설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용을 포함 하는 매뉴얼 작성
• 제품 소프트웨어에 대한 패치 개발과 업그레이드를 위해 버전 관리 수행
• 개발된 컴포넌트 사용 시에 알아야 할 내용을 기술하며 패키지의 기능, 패키지의 인터페이스, 포함하고 있는 메서드나 오퍼레이션과 메서드의 파라미터 등의 설명 포함
• 컴포넌트 명세서와 컴포넌트 구현 설계서를 바탕으로 사용 설명서 작성

 

※ 사용자 매뉴얼 작성 단계

작성 단계	단계별 설명
(1) 작성 지침 정의	사용자 매뉴얼을 작성하기 위한 지침 설정 실제 사용자 환경에 필요한 정보를 제공할 수 있는 형태로 작성
(2) 사용자 매뉴얼 구성요소 정의	제품 소프트웨어의 기능 구성 객체 목록 객체별 메서드 메서드의 파라미터 및 설명 실제 사용 예제 사용자 환경 세팅 방법
(3) 구성 요소별 내용 작성	제품 소프트웨어 구성 요소별로 내용 작성
(4) 사용자 매뉴얼 검토	작성된 사용자 매뉴얼이 개발된 제품의 기능을 제대로 설명하는지 제품 사용 시 모자라는 정보가 없는지 등 검사 해당 기능별 관련 개발자와 함께 검토하면 기능 내용이나 인터페이스, 메서드나 메서드의 파라미터 등이 보다 정확히 반영할 수 있어서 더욱 효과적 개발된 프로그램을 사용자 지침서의 내용에 따라 수행 프로그램과 맞지 않는 부분이 있는지 점검 점검 사항을 반영하여 사용자 지침서를 수정, 보완

 

② 사용자 매뉴얼과 사용자 환경

 

• 제품 소프트웨어는 개발자가 아닌 사용자 중심으로 진행 
• 신규 및 변경 개발 소스를 식별, 이를 모듈화하여 상용 제품으로 패키징 
• 고객의 편의성을 위해 신규/변경 이력을 확인, 이를 버전 관리 및 릴리즈 노트를 통해 지속적으로 관리 
• 사용자의 실행 환경을 이해, 범용 환경에서 사용이 가능하도록 일반적인 배포 형태로 분류하여 패키징 진행

 

 

제품 소프트웨어 사용자 매뉴얼 작성 항목

 

• 실제 사용자를 위한 전체적인 서문 및 사용자 환경, 사용법을 위주로 작성

 

① 제품 소프트웨어 사용자 매뉴얼의 기본 작성 항목

 

(1) 목차 및 개요

 

(가) 목차

 

• 매뉴얼 전체의 내용을 순서대로 요약

 

(나) 개요

 

• 제품 소프트웨어의 주요 특징에 대해 정리 ex) Windows 기반의 PC에서 제공하는 운영 체제와 SW의 중요한 특징에 대한 여러 기능을 갖는 소프트웨어
• 사용자 매뉴얼에서의 구성과 실행 방법, 메뉴에 대한 설명을 비롯하여 사용법, 각 항목에 따른 점검 기준, 설정 방법 등에 대해 기술

 

(2) 서문

 

(가) 사용자 매뉴얼 문서 이력 정보

버전	작성자	작성일	검토자	일시	검수인
v0.1	홍길동	2015-10-01
변경 내용	최초 작성

 

(나) 사용자 매뉴얼의 주석

 

• 주의 사항 : 사용자가 반드시 숙지해야 하는 중요한 정보의 주석 표시
• 참고 사항 : 특별한 사용자 환경 및 상황에 대한 내용의 주석 표시

 

(다) 기록 보관

 

• 제품 등록과 관련한 기록에 대한 내용 기재
• 향후 필요한 경우나 도움이 되는 추가 제품 정보를 받기 위한 내용 기재
• 인터넷을 이용한 지원이 가능하도록 Website URL 기재
• 제품 소프트웨어 CD-ROM 등을 통해 우편 또는 팩스로 지원을 보낼 수 있는 양식 제공

 

※ 사용자 매뉴얼 기록 항목

매뉴얼 기록 항목	기재할 내용
제품 명칭	제품 소프트웨어의 명칭 기재
제품 소프트웨어의 모델명(버전명)	버전을 포함한 제품 소프트웨어의 자체 모델명을 기재
기록 항목에 대한 문서 번호	제품 소프트웨어 Rev. 버전 날짜 등의 고유한 문서번호 기재
제품 번호	고유한 제품의 시리얼 넘버(Serial Number) 기재
구입 날짜	사용자가 직접 기재할 수 있도록 빈 공란으로 공백 처리

 

(3) 기본 사항

기본사항	항목 설명
제품 소프트웨어 개요	제품 소프트웨어의 주요 기능 및 UI 설명 UI 및 화면 상의 버튼, 프레임 등을 도식화하여 설명
제품 소프트웨어 사용	제품 소프트웨어를 사용하기 위한 최소 환경 설명 PC 사양(CPU, Memory), OS 버전 명시 제품 소프트웨어 최초 동작을 위한 설명(실행 파일, Website URL 등) 주의 사항 : 제품 소프트웨어 동작 시 프로그램 충돌사항 혹은 안전하게 이용하기 위한 주의 사항(개인정보, 보안 등에 관련된 사항까지 명시)
제품 소프트웨어 관리	제품 소프트웨어의 사용 종료 및 관리 등에 대한 내용 기재
모델, 버전별 특징	제품 구별을 위한 모델, 버전별 UI 및 기능의 차이 간단히 기술
기능, I/F의 특징	제품의 기능 및 Interface의 특징 간단히 기술
제품 소프트웨어 구동 환경	개발 언어 및 호환 OS 설치 마법사(Setup Wizard) 이후 사용자가 구동하기 까지의 과정 요약(Windows, Linux)

 

② 제품 소프트웨어 사용자 매뉴얼 작성 방법 상세 가이드

 

(1) 사용자 매뉴얼 내용

 

• 제품 소프트웨어의 사용 방법을 다양한 측면별로 나누어 상세하게 설명
• 주로 화면을 계속 캡처하여 사용자가 이해하기 쉽도록 구성 

 

(가) 사용자 화면 및 UI

 

• 주의 사항 : 사용자가 반드시 숙지해야 하는 중요한 정보의 주석 표시
• 참고 사항 : 특별한 사용자 환경 및 상황에 대한 내용의 주석 표시

 

(나) 주요 기능 분류

 

• 설명할 기능을 포함할 화면 첨부
• 동작하는 기능을 화면의 순서대로 차례로 분류

 

(다) 응용 프로그램(Programs)/설정(Settings)

 

• 제품 소프트웨어 동작 시 함께 동작하는 Application이나 설치되어 충돌될 수 있는 응용 프로그램에 대해 보여줌
• 제품 소프트웨어 동작 시 사전에 실행해야 할 Application이 있으면 기술
• 제품 소프트웨어의 설정(Settings)과 관련한 사항이나 기본값에 대한 내용을 설명

 

(라) 장치 연동

 

• 제품 소프트웨어가 Embedded 관련된 제품일 경우에 해당 Device에는 어떤 것이 있는지, 연동되는 Device에는 무엇이 있는지 설명

 

(마) Network 환경

 

• 제품 소프트웨어와 관련한 Network 정보 표시(Status)
• Network에 정상 연결되었는지, 이를 위한 관련 설정값은 무엇이 있는지 기술

 

(바) Profile 설명

 

• 제품 소프트웨어 구동 시 체크하는 환경 파일 : 환경 파일의 경로 변경, 이동 금지
• 필수 파일의 내용 간략히 설명

 

(2) 액세서리(Accessory)

 

• SW Toolkit
• Device

 

(3) 고객 지원 방법(Customer Support)

국가	Website	전화	Email
한국	www.Website.com	02)123-4567	support@Website.com

• 유선 및 E-mail, Website URL 기술적인 지원이나 제품 서비스를 원하시면 아래의 표를 참조하거나 해당 구입 사에 문의하십시오
• 주의 : 요청 시 제품 번호가 필요

 

(4) 준수 정보 & 제한 보증(Compliance Information & Limited Warranty)

 

• Serial 보존, 불법 등록 사용금지 등의 준수 사항 권고
• 저작권 정보 관련 작성(출처: Android, Microsoft)

 

※ 저작권 정보 관련 작성

 

① 저작권자 소유권 정보

 

• Copyright ⓒ 제품 소프트웨어 ® Corporation, 2015. 모든 권리는 저작권자의 소유입니다.

 

② SW 허가권 관련 명시

 

• Android는 Google Inc의 등록 상표입니다. 이 상표 사용 허가권은 Google 에 있습니다. Google ™, Google 로고, Android ™, Android 로고 및 Gmail ™은 Google Inc의 상표입니다. 이 상표의 사용 허가권은 Google에 있습니다.
• Microsoft, MS, Windows, MS Office는 미국, 대한민국 또는 기타 국가에서 의 Microsoft Corporation의 등록 상표 또는 상표입니다. 여기서 언급된 기타 다른 제품과 회사 이름은 각각 그 소유자의 상표일 수 있습니다.

 

③ 확장 플랫폼, 응용 Application

 

• 본 제품은 다양한 응용 프로그램 소프트웨어에 의해 확장될 수 있는 Linux에 기반을 둔 Android 플랫폼을 탑재하고 있습니다.

 

④ 통신 규격

 

• Wi-Fi 및 Wi-Fi CERTIFIED 로고는 Wireless Fidelity Alliance에 등록된 상표입니다. Bluetooth 및 Bluetooth 로고는 Bluetooth SIG, Inc가 소유한 상표입니다.

 

⑤ 저장 장치

 

• MicroSD ™은 SD Card Association의 상표입니다.

 

⑥ 개발 언어

 

• Java, JME 및 기타 Java 기반 마크는 미국 및 기타 국가에서 Sun Microsystems, Inc의 상표 또는 등록 상표입니다.

 

⑦ 연동 프로그램

 

• 연동 프로그램은 ABC, Inc의 등록 상표입니다. All rights reserved(모든 권리 보유). 연동 프로그램은 ABC, Inc의 상표 또는 등록 상표입니다. All rights reserved(모든 권리 보유).

 

⑧ 문서 효력

 

• 본 문서의 어떠한 부분도 ViewSonic Corporation의 사전 서면 허가 없이 어떠한 목적 및 수단으로도 복사, 재생산 또는 전달될 수 없습니다.

 

⑨ 지적 소유권 정보

 

• 본 제품에 속하는 모든 기술 및 제품에 대한 권리는 관련 소유자의 재산 입니다.