제품 소프트웨어 패키징 매뉴얼 작성 및 버전 등록 1/4

제품 소프트웨어 패키징 매뉴얼 작성 및 버전 등록

제품 소프트웨어 매뉴얼 작성

제품 소프트웨어 매뉴얼 개념

• 사용자 측면에서 패키징 이후 설치, 제품 소프트웨어를 사용하는 데 필요한 주요 내용을 기록한 문서
• 사용자 중심의 기능 및 방법을 나타낸 설명서와 안내서를 의미

제품 소프트웨어 설치 매뉴얼 작성

제품 소프트웨어 설치 매뉴얼 개념

• 사용자가 제품을 구매한 후 설치 시 참조하는 문서

제품 소프트웨어 설치 매뉴얼 기본 작성 항목

목차 및 개요

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

문서 이력 정보

• 매뉴얼 변경 이력에 대한 정보를 버전별로 표시

설치 매뉴얼 주석

• 주의 사항 : 사용자가 제품 설치 시 반드시 숙지해야 하는 중요한 정보 주석 표시
• 참고 사항 : 설치 관련하여 영향을 미치는 특별한 사용자 환경 및 상황에 대한 내용 주석 표시

설치 도구의 구성

• exe / dll / ini / chm 등 해당 설치 관련 파일 설명
• 폴더 및 설치 프로그램 실행 파일 설명

제품 소프트웨어 설치 환경 체크 항목

• 사용자 환경 : CPU 및 메모리, 운영체제(OS) 등의 적합 환경 확인
• 응용 프로그램 : 설치 전 다른 응용 프로그램의 종료 확인
• 업그레이드 버전 : 업그레이드 이전 버전에 대한 존재 유무 확인
• 백업 폴더 확인 : 데이터 저장 폴더를 확인하여 설치 시 폴더 동기화

제품 소프트웨어 설치 매뉴얼 구성요소

제품 소프트웨어 개요

• 제품 소프트웨어의 주요 기능 및 UI 설명
• UI 및 화면상의 버튼, 프레임 등을 도식화하여 설명

설치 관련 파일

• 제품 소프트웨어를 설치하기 위한 관련 파일 설명
• 설치 구동을 위한 exe 실행 파일
• ini나 log 파일 같은 관련 파일

설치 절차

• 제품 소프트웨어 설치를 위한 상세 절차 설명
• 설치 디렉토리, 위치 설명

설치 아이콘

• 윈도즈(Windows) 구동용 설치 아이콘 설명

삭제 방법

• 제품 소프트웨어 삭제 시 원래대로 삭제하는 방법 설명

설치 버전 및 작성자

• 제품 소프트웨어 릴리즈 버전 및 작성자 정보

고객 지원 방법 및 FAQ

• 설치 관련하여 기술적인 지원이나 제품 서비스를 받을 수 있는 유선 및 이메일, 홈페이지 주소
• 설치 시 자주 발생하는 오류 및 처리 방법에 대한 요약 설명

준수 정보 & 제한 보증

• 시리얼 보존, 불법 등록 사용 금지 등의 준수 사항 권고
• 저작권 정보 관련 사항 작성

제품 소프트웨어 설치 매뉴얼 작성 프로세스

1. 개요 및 기능 식별

• 제품 소프트웨어 개발 목적 및 제품의 전체적인 기능 식별

2. UI 분류

• 설치를 위한 화면 단위 및 메뉴 분류
• UI 정의서에 기초한 메인 항목 분류
• 설치 매뉴얼에 작성될 순서대로 UI 분류

3. 설치 파일 / 백업 파일 확인

• 실제로 제품을 설치할 파일 및 백업 파일명 확인
• 제품을 설치할 파일 및 백업 파일명의 폴더 위치 확인
• 실행, 환경, 로그, 백업 등의 다양한 파일들을 확인하고 기능을 숙지

4. 삭제 절차 확인

• 제품의 제거를 고려하여 삭제 파일 절차 확인
• 삭제 이후 설치 전 상태로의 원복을 최종 확인

5. 이상 유형 확인

• 설치에 대한 이상 유형에 대한 테스트 수행
• 다양한 이상 현상 발생 시 이에 따른 메시지 정리
• 유형별로 발생하는 메시지가 정상적인지 확인

6. 최종 매뉴얼 적용

• 최종 설치 정상 완료 시 결과를 캡처 후 최종 매뉴얼에 적용