제품 소프트웨어 패키징 3

제품 소프트웨어 매뉴얼

01. 제품 소프트웨어 설치 매뉴얼

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

• 제품 소프트웨어의 개발 단계부터 적용한 기준이나 패키징 이후 설치 및 사용자 측면의 주요 내용을 문서로 기록한 것
• 사용자 중심의 기능 및 방법을 나타낸 설명서와 안내서를 의미
• 실제 개발자들이 많이 겪어 보지 못하는 영역이어서 개발보다도 더 어려움을 겪는 작업
• 매뉴얼 작성 프로그램이나 틀을 이용하기도 함

2) 제품 소프트웨어 설치 메뉴얼의 기본 사항

• 사용자가 제품 구매 후 최초 설치 시에 참조하는 매뉴얼
• 설치 매뉴얼은 개발자가 아닌 사용자의 기준으로 작성함
• 설치 시작부터 완료할 때까지의 전 과정을 빠짐없이 순서대로 설명
• 설치 매뉴얼에는 목차, 개요, 기본사항 등이 기본적으로 포함되어야 함
• 제품 소프트웨어 소개, 설치 파일, 설치 절차 등이 포함되어야 함
• 각 단계별 메시지 및 해당 화면을 순서대로 전부 캡처하여 설명
• 설치 과정에서 표시될 수 있는 예외 상황에 관련 내용을 별도로 구분하여 설명

3) 제품 소프트웨어 설치 매뉴얼 작성 순서

1. 기능 식별
   • 제품 소프트웨어의 개요 및 기능들을 식별
   • 제품 소프트웨어 자체의 목적 및 내용을 설명할 수 있도록 함
   • 제품의 전체적인 주요 기능을 흐름 순으로 정리하여 설명
2. UI 분류
   • 화면 단위로 작성될 UI를 분류
   • 화면 중심으로 UI와 메뉴를 순서대로 분류
   • 사전에 작성된 UI 정의서를 항목별로 분류
   • 설치 매뉴얼 기준의 양식을 목차에 맞게 UI를 분류
3. 설치 파일 / 백업 파일 확인
   • 설치 파일 및 백업 파일 등 관련 파일을 확인
   • 실제로 제품을 설치할 파일 및 백업 파일명을 확인
   • 실제로 제품을 설치할 파일 및 백업 파일명의 폴더 위치 확인
   • 실행, 환경, 로그, 백업 등의 다양한 파일들을 확인하고 기능을 숙지
4. Uninstall 절차 확인
   • 추후 Uninstall을 위한 절차 확인
   • 제품 제거 시를 고려하여 Uninstall 파일을 설명
   • 제품 제거 시의 단계를 순서대로 기술
   • Uninstall 이후 설치 전 상태로의 원본을 최종 확인
5. 이상 Case 확인
   • 설치 진행 시 이상 메시지 등에 대한 Case를 발생시키고 확인
   • 설치 시 발생하는 이상 현상에 맞는관련 테스트를 수행
   • 다양한 이상 현상 발생 시 이에 따른 메시지를 정리
   • 다양한 이상 현상의 내용에 맞는 메시지가 간결하고 정상적으로 표시되는지 확인
6. 최종 매뉴얼 적용
   • 최종 설치 정상 완료 시 결과를 캡처 후 최종 매뉴얼에 적용
   • 설치 최종 완료 후 이에 대한 메시지 및 최종 결과 확인
   • 최종 매뉴얼을 정리 검토하고 최종적으로 정상 결과 적용

---

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

1) 사용자 매뉴얼 작성의 개념

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

2) 사용자 매뉴얼 준비 절차

1. 작성 지침 정의
   • 사용자 매뉴얼을 작성하기 위한 지침 설정
   • 실제 사용자 환경에 필요한 정보를 제공할 수 있는 형태로 매뉴얼을 작성
2. 사용자 매뉴얼 구성 요소 정의
   • 제품 소프트웨어의 기능 정의
   • 구성 객체 목록 정의
   • 객체별 메소드 정의
   • 메소드의 파라미터 및 설명 정의
   • 실제 사용 예제 정의
   • 사용자 환경 설정 방법 정의
3. 구성 요소별 내용 작성
   • 제품 소프트웨어 구성 요소별로 내용 작성
4. 사용자 매뉴얼 검토
   • 사용자 매뉴얼이 개발된 제품의 기능을 제대로 설명하는지 검토
   • 제품 사용 시 부족한 정보가 없는지 등을 검사
   • 개발된 프로그램을 사용자 지침서의 내용에 따라 수행하여 맞지 않는 부분이 있는지를 점검
   • 점검 사항을 반영하여 사용자 지침서를 수정하거나 보완

3) 사용자 매뉴얼과 사용자 환경

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

4) 제품 소프트웨어 사용자 매뉴얼 작성 절차

1. 기능 식별
   • 제품 소프트웨어의 개요 및 사용자 기능들을 식별
   • 제품 소프트웨어 자체의 목적 및 내용을 설명할 수 있도록 함
   • 제품의 전체적인 기능을 흐름 순으로 설명
2. 사용자 화면 분류
   • 화면 단위로 작성될 사용자 화면 분류
   • 화면 중심으로 UI와 메뉴를 순서대로 분류
   • 사전에 작성된 UI 정의서를 항목별로 분류
   • 사용자 매뉴얼 기준의 양식을 목차에 맞게 UI 분류
3. 사용자 파일 확인
   • 로그 파일 및 백업 파일명 확인
   • 실제로 제품을 설치할 파일 및 백업 파일명 확인
   • 실제로 제품을 설치할 파일 및 백업 파일명의 폴더 위치 확인
   • 실행, 환경, 로그, 백업 등의 다양한 파일들을 확인하고 기능을 숙지
4. 초기화 절차 확인
   • 사용 초기화를 위한 절차 확인
   • 사용자가 제품을 제거할 때를 고려하여 Uninstall 파일을 설명
   • 사용자 환경 및 로그 파일 초기화 단계를 순서대로 기술
   • 설치 전 상태로의 원상 복구 단계 절차를 기술
5. 이상 Case 확인
   • 사용 시 이상 메시지 등에 대한 조치 사항 확인
   • 설치 시 발생하는 이상 현상의 테스트 수행
   • 이상 현상 발생 시 이에 따른 대응 방향 및 매뉴얼 정리
   • 이상 현상의 내용에 맞는 메시지가 간결하고 정상적으로 표시되는지 확인
6. 최종 매뉴얼 적용
   • 사용자 대응을 위한 결과 및 코드를 캡처 후 최종 매뉴얼에 적용
   • 메시지에 대한 문의 답변 및 대응 사항 정리
   • 결과에 대한 코드 값 정리
   • 최종 완성된 사용자 매뉴얼을 검토하고 추가 지원 방향 기술

5) 제품 소프트웨어 사용자 매뉴얼 작성 시 고려사항

• 화면을 캡처하여 사용자가 이해하기 쉽도록 기술
• 주요 기능을 설명할 화면 첨부
• 제품 소프트웨어를 설치하기 전에 설치해야 할 응용 프로그램 목록 기술
• 제품 소프트웨어를 설치 시 충돌될 수 있는 다른 응용 프로그램 목록 기술
• 제품 소프트웨어아 Embedded 관련된 소프트웨어인 경우에 연동되는 장치의 종류 기술

---

03. 제품 소프트웨어 배포본

1) 제품 소프트웨어 배포본의 개념

• 개발된 컴포넌트(또는 패키지)에 대해 제품화하고 배포 정보를 포함함
• 버전, 시스템이 설치 및 운영을 위한 요구사항, 설치 방법, 변화된 기능, 알려진 오류 및 대처 방법 등을 포함하여 배포함
• 반드시 공식적인 인증 절차를 통하여 사용자에게 배포되어야 함

2) 제품 소프트웨어 배포본 시 고려사항

• 최종 완성된 제품으로 안정성을 고려하여 배포
• 신규 및 변경을 고려하여 배포본에는 고유 버전 및 배포 단위의 기준을 정함
• 미디어를 제작할 때에는 저작권 및 보안을 고려하여 제작
• 자체의 고유 시리얼 넘버를 반드시 부착하여 복제 및 사후 지원을 고려하여 제작