제품소프트웨어패키징
- 사용자가 제품 소프트웨어를 설치하는 데 참조할 수 있도록 제품 소프트웨어 설치 매뉴얼의 기본 구성을 수립하고 작성
- 사용자가 제품 소프트웨어를 설치하고 사용하는데 필요한 제품 소프트웨어의 설치 파일 및 매뉴얼을 배포용 미디어로 제작
제품소프트웨어 매뉴얼 종류
- 설치 매뉴얼
- 사용자 매뉴얼
제품 소프트웨어 설치 매뉴얼 개념
- 사용자가 제품 구매 후 최초 설치 시 참조하는 매뉴얼
- 제품 소프트웨어 소개, 설치 파일, 설치 절차 등이 포함
설치 매뉴얼
1. 설치 매뉴얼 작성의 기본 사항
- 설치 매뉴얼을 개발자의 기준이 아닌 사용자의 기준으로 작성
- 최초 설치 진행부터 완료까지 순차적으로 진행
- 각 단계별 메시지 및 해당화면을 순서대로 전부 캡처하여 설명
- 설치 중간에 이상 발생 시 해당 메시지 및 에러에 대한 내용을 분류하여 설명
2. 제품 소프트웨어 설치 매뉴얼의 작성 항목
- 목차 및 개요
- 목차는 매뉴얼 전체의 내용을 순서대로 요약
- 개요에는 설치 매뉴얼의 주요 특징에 대한 정리와 설치 매뉴얼에서의 구성과 설치 방법, 순서 등에 기술
- 서문
- 문서 이력 정보
- 매뉴얼 변경 이력 정보
- 설치 도구 구성
- exe/dll/ini/chm 등 설치 관련 파일 설명
- 폴더 및 설치 프로그램 실행 파일 설명
- 설치 이후에 설치 결과를 기록하는 Log 폴더 설명
- 문서 이력 정보
- 기본사항
- 기본적으로 제품 소프트웨어 관련하여 설명되어야 할 항목
3. 제품 소프트웨어 설치 환경 체크 항목
- 제품 설치와 관련하여 아래의 환경 체크 항목을 공지
- 사용자 환경
- 사용자의 CPU 및 Memory, OS 등의 적합 환경
- 응용프로그램
- 설치 전 다른 응용 플그램의 종료
- 업그레이드 버전
- 업그레이드 이전 버전에 대한 존재 유무 확인
- 백업 폴더 확인
- 데이터 저장 폴더를 확인하여 설치 시 폴더 동기화
- 사용자 환경
4. 제품 소프트웨어 설치 매뉴얼 기본 사항
- 제품 소프트웨어와 관련하여 설명되어야 할 기본 항목
- 간략한 기능 및 UI를 첨부하고 요약함
- 제품 소프트웨어 개요
- 설치 관련 파일
- 설치 절차
- 설치 아이콘
- 프로그램 삭제
- 설치 환경
- 설치 버전 및 작성자
- FAQ
5. 제품 소프트웨어 설치 매뉴얼 내용 상세 가이드
- 설치 화면 및 UI
- 설치 실행
- 표시되는 내용 및 안내창의 메시지 설명
- 설치 이상 시 메시지 설명
- 설치가 잘못되었거나 잘못된 환경일 경우 메시지
- 해당 이상 내용에 따른 메시지를 설명
- 설치 단계별 참고 사항, 주의 사항등을 메모로 추가
- 설치 완료 및 결과
- 정상 설치 완료 시 최종 메시지 출력
- 정상 결과 및 사용에 대한 안내를 함으로써 설치가 잘 되 었음을 최종 통지
- FAQ
- 실제 설치 시 자주 발생하는 어려움들을 FAQ로 정리하여 제품이 설치되지 않을 때를 대비
- 설치 시 점검 사항
- 설치 전 사용자 환경에 맞추어 점검할 내용들을 설명
- 사용자 계정 및 설치 권한에 대한 확인
- 설치 중간에 에러 발생 시 체크할 사항을 설명
- Network 환경 및 보안
- 설치 시 Network 문제로 인해 오류가 발생하지 않도록 사전에 Connection 체크
- 보안 및 방화벽 등의 문제로 설치가 안될 경우에 대비해 환경 체크할 수 있도록 가이드
6. 제품 소프트웨어 고객 지원 방법 상세 가이드
- 유선 및 E-mail, Website URL
7. 준수 정보 & 제한 보증
- Serial 보존, 불법 등록 사용 금지 등의 준수 사항 권고
- 저작권 정보 관련 작성
8. 제품 소프트웨어 설치 매뉴얼 작성 순서
- 기능식별
- UI분류
- 설치/백업 파일 확인
- Uninstall 절차 확인
- 이상 Case 확인
- 최종 매뉴얼 적용
제품 소프트웨어 사용자 매뉴얼 개념
-
개발이 완료된 제품 소프트웨어를 고객에게 전달하기 위한 형태로 패키징하고, 설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용을 포함하는 매뉴얼 작성
-
제품 소프트웨어에 대한 패치 개발과 업그레이드를 위해 버전 관리 수행
제품 소프트웨어 사용자 매뉴얼 작성 단계
- 작성 지침 정의
- 사용자 매뉴얼 구성요소의 정의
- 제품 소프트웨어 기능
- 구성 객체 목록
- 객체별 메서드
- 메서드의 파라미터 및 설명
- 실제 사용 예제
- 사용자 환경 세팅 방법
- 구성 요소별 내용 작성
- 사용자 매뉴얼 검토
제품 소프트웨어 사용자 매뉴얼의 작성 항목
- 목차 및 개요
- 서문
- 기본 사항
제품 소프트웨어 사용자 매뉴얼 기본 사항
- 간략한 기능 및 UI를 첨부하고 요약
- 제품 소프트웨어 개요
- 제품 소프트웨어 사용
- 제품 소프트웨어 관리
- 모델, 버전별 특징
- 기능, I/F 특징
- 제품 소프트웨어 구동 환경