[자격증] 정보처리기사 실기 : 32강 제품소프트웨어패키징 (제품 소프트웨어 매뉴얼 작성하기)

 정보

• 업무명     : 정보처리기사 실기 : 32강 제품소프트웨어패키징 (제품 소프트웨어 매뉴얼 작성하기)

• 작성자     : 이상호

• 작성일     : 2020-05-16

• 설   명      :

• 수정이력 :

 

 

 내용

[제품 소프트웨어 설치 매뉴얼 구성 수립 및 작성]

[1] 제품 소프트웨어 설치 매뉴얼의 개요

• 1. 제품 소프트웨어의 매뉴얼의 파악 

  • 제품 소프트웨어의 매뉴얼은 제품 소프트웨어 개발단계부터 적용한 기준이나 패키징 이후 설치 및 사용자 측면의 주요 내용 등을 문서로 기록한 것이며, 사용자 중심의 기능 및 방법을 나타낸 설명서와 안내서를 의미한다. 

  • 실제 개발자들이 많이 겪어 보지 못하는 영역이어서 개발보다도 더 어려움을 겪는 작업이다. 

  • 요즘은 매뉴얼 작성 프로그램이나 툴을 이용하기도 하지만 전통적으로 작성 내용에 맞추어 항목별로 작성하게 된다. 

• 2. 설치 매뉴얼 작성의 기본 사항 

  • (1) 설치 매뉴얼은 개발자의 기준이 아닌 사용자의 기준으로 작성한다. 

  • (2) 최초 설치 실행부터 완료까지 순차적으로 진행한다. 

  • (3) 각 단계별 메시지 및 해당 화면을 순서대로 전부 캡처하여 설명한다. 

  • (4) 설치 중간에 이상 발생 시 해당 메시지 및 에러에 대한 내용을 분류하여 설명한다.

[2] 제품 소프트웨어 설치 매뉴얼의 작성 항목

• 제품 소프트웨어 설치 매뉴얼은 기본적인 개요 및 서문 이외에도 상세한 설치 항목에 대 해서 순서대로 설명해 가는 것이 중요하다. 

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

    • (1) 목차 및 개요 

      • (가) 목차 매뉴얼 전체의 내용을 순서대로 요약 

      • (나) 개요 

        • 설치 매뉴얼의 주요 특징에 대해 정리 

        • 설치 매뉴얼에서의 구성과 설치 방법, 순서 등에 대해 기술함

    • (2) 서문 

      • (가) 문서 이력 정보

• (나) 설치 매뉴얼의 주석 

  • 주의 사항: 사용자가 제품 설치 시 반드시 숙지해야 하는 중요한 정보 주석 표시 

  • 참고 사항: 설치 관련하여 영향을 미치는 특별한 사용자 환경 및 상황에 대한 내용 주석 표시 

• (다) 설치 도구의 구성 

  • 프로그램 파일 구성(설치 파일 및 폴더) exe / dll / ini / chm 등 해당 설치 관련 파일 설명 

  • 폴더 및 설치 프로그램 실행 파일 설명 

  • 설치 이후에 설치 결과를 기록하는 Log 폴더 설명 제품 설치와 관련하여 아래의 환경 체크 항목들을 공지한다.

• (3) 기본 사항 

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

  • 이때 간략한 기능 및 UI를 첨부하고, 요약한다.

• 2. 제품 소프트웨어 설치 매뉴얼 작성 방법 상세 가이드 

  • (1) 설치 매뉴얼 내용 

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

      • (가) 설치 화면 및 UI 

        • 설치 실행: exe 등의 Install 파일을 실행하도록 화면 첨부 메인 화면 및 안내창: 이미지로 해당 내용을 직접 첨부하 여 설치 시 나타나는 내 용 설명 

        • 표시되는 내용 및 안내창의 메시지 설명 

      • (나) 설치 이상 시 메시지 설명 

        • 설치가 잘못되었거나 잘못된 환경일 경우 메시지

        • 해당 이상 내용에 따른 메시지를 설명

        • 설치 단계별 참고 사항, 주의 사항 등을 메모로 추가

• (다) 설치 완료 및 결과 

  • 정상 설치 완료 시 최종 메시지 출력 

  • 정상 결과 및 사용에 대한 안내를 함으로써 설치가 잘되었음을 최종 통지 

• (라) FAQ 

  • 실제 설치 시 자주 발생하는 어려움들을 FAQ로 정리하여 제품이 설치되지 않을 때를 대비한다.

• (마) 설치 시 점검 사항 

  • 설치 전 사용자 환경에 맞추어 점검할 내용들을 설명한다. 

  • 사용자 계정 및 설치 권한에 대해 확인할 수 있도록 한다. 

  • 설치 중간에 에러 발생 시 체크할 사항을 설명한다. 

• (바) Newwork 환경 및 보안 

  • 설치 시 Newwork 문제로 인해 오류가 발생하지 않도록 사전에 Connection을 체크 한다. 

  • 보안 및 방화벽 등의 문제로 설치가 안될 경우에 대비해 환경을 체크할 수 있도록 가이드한다. 

 

• (2) 고객 지원 방법(Customer Support) 

  • 유선 및 E-mail, Website URL 

  • 설치 관련하여 기술적인 지원이나 제품 서비스를 원하시면, 아래의 표를 참조하거나 해당 구입사에 문의하십시오 .  주의: 요청 시 제품 번호가 필요합니다

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

  • Serial 보존, 불법 등록 사용 금지 등의 준수 사항 권고 

  • 저작권 정보 관련 작성(출처: Android, Microsoft)

    • 1. 저작권자 소유권 정보 

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

    • 2. SW 허가권 관련 명시 

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

    • 3. 확장 플랫폼, 응용 Application 

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

    • 4. 통신 규격 

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

    • 5. 저장 장치 

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

    • 6. 개발 언어 

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

    • 7. 연동 프로그램 

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

    • 8. 문서 효력 

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

    • 9. 지적 소유권 정보 

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

 

[수행]

 

[1] 제품 소프트웨어의 개요 및 기능들을 식별한다.

• 1. 제품 소프트웨어 개발 목적 및 설명 

  • 제품 소프트웨어 자체의 목적 및 내용을 설명할 수 있도록 한다. 

• 2. 제품 소프트웨어의 주요 기능적 설명 

  • 제품의 전체적인 기능을 흐름순으로 정리하여 설명한다.

 

[2] 화면 단위로 작성될 UI를 분류한다. 

• 1. 설치를 위한 화면 단위 및 메뉴 분류 

  • 화면 중심으로 UI와 메뉴를 순서대로 분류한다. 

• 2. UI 정의서에 기초한 메인 항목 분류 

  • 사전에 작성된 UI 정의서를 항목별로 분류한다.

• 3. 설치 매뉴얼에 작성될 순서대로 UI를 분류 

  • 설치 매뉴얼 기준의 양식을 목차에 맞게 UI를 분류한다.

 

[3] 설치 파일 및 백업 파일 등 관련 파일을 확인한다.

• 1. 설치 파일 및 백업 파일명 확인 

  • 실제로 제품을 설치할 파일(exe) 및 백업 파일명을 확인한다. 

• 2. 설치 파일 및 백업 파일명 폴더 위치 

  • 실제로 제품을 설치할 파일(exe) 및 백업 파일명의 폴더 위치를 확인한다. 

• 3. 파일 별 기능(실행, 환경, Log, 백업) 

  • 실행, 환경, Log, 백업 등의 다양한 파일 들을 확인하고 기능을 숙지한다.

 

[4] 추후 Uninstall을 위한 절차를 확인한다.

• 1. Uninstall진행 시 실행 파일 

  • 제품의 제거시를 고려하여 Uninstall 파일을 설명한다. 

• 2. Uninstall 진행 시 단계 

  • 제품의 제거 시의 단계를 순서대로 기술한다. 

• 3. Uninstal l이후 정상 상태로의 원복 

  • Uninstall 이후 설치 전 상태로의 원복을 최종 확인한다. 

 

[5] 설치 진행 시 이상 메시지 등에 대한 Case를 발생 시키고, 확인한다.

• 1. 설치에 대한 이상 Case Test 

  • 설치 시 발생하는 이상 현상을 발생하고 관련 테스트를 수행한다. 

• 2. 다양한 Case명 발생 메시지 

  • 다양한 이상 현상 발생 시 이에 따른 메시지를 정리한다. 

• 3. Case별로 발생하는 메시지가 정상적인지 확인 

  • 다양한 이상 현상의 내용에 맞는 메시지가 간결하고 정상적으로 표시되는지 확인한다.

 

[6] 최종 설치 정상 완료 시 결과를 캡처 후 최종 매뉴얼에 적용한다.

• 1. 설치 최종 완료 시 결과 확인 

  • 설치 최종 완료 후 이에 대한 메시지 및 최종 결과를 확인한다. 

• 2. 결과에 대한 화면 및 해당 메시지 캡처 

  • 최종 설치 정상 완료를 확인하고 이에 대한 메시지를 캡처한다. 

• 3. 최종 매뉴얼을 확인하고 마지막에 정상 결과 적용 

  • 최종 매뉴얼을 정리 검토하고 최종적으로 정상 결과를 적용한다. 

 

[제품 소프트웨어 설치 매뉴얼 구성 수립 및 작성]

[1] 제품 소프트웨어 사용자 매뉴얼의 개요

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

• 1. 사용자 매뉴얼 작성의 기본 사항 

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

 

• 사용자 매뉴얼 작성은 명세서나 구현 설계서로부터 다음과 같은 단계를 거쳐서 최종 작성된다.

• (3) 기본 사항 

  • 기본적으로 제품 소프트웨어와 관련하여 설명할 항목들은 다음과 같다. 이때 간략한 기능 및 UI를 첨부하고, 요약한다. 

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

  • (1) 사용자 매뉴얼 내용 

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

      • (가) 사용자 화면 및 UI 

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

      • (나) 주요 기능 분류 

        • 설명할 기능을 포함할 화면을 첨부 

        • 동작하는 기능을 화면의 순서대로 차례로 분류

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

  • 제품 소프트웨어 동작 시 함께 동작하는 Application이나 설치되어 충돌될 수 있 는 응용 프로그램에 대해 보여 준다. 

  • 제품 소프트웨어 동작 시 사전에 실행해야 할 Application이 있으면 기술한다. 

  • 제품 소프트웨어의 설정(Settings)과 관련한 사항이나 기본값에 대한 내용을 설명 한다. 

• (라) 장치 연동 

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

• (마) Network 환경 

  • 제품 소프트웨어와 관련한 Network 정보 표시(Status) 

  • Network에 정상 연결되었는지, 이를 위한 관련 설정값은 무엇이 있는지 기술 

• (바) Profile 설명 

  • 제품 소프트웨어 구동 시 체크하는 환경 파일 - 환경 파일의 경로 변경, 이동 금지 

  • 필수 파일의 내용 간략히 설명 

• (2) 액세서리(Accessory): SW Toolkit, Device 

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

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

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

  • Serial 보존, 불법 등록 사용금지 등의 준수 사항 권고 

  • 저작권 정보 관련 작성(출처: Android, Microsoft)

    • 1. 저작권자 소유권 정보 

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

    • 2. SW 허가권 관련 명시 

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

    • 3. 확장 플랫폼, 응용 Application 

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

    • 4. 통신 규격 

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

    • 5. 저장 장치 

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

    • 6. 개발 언어 

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

    • 7. 연동 프로그램 

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

    • 8. 문서 효력 

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

    • 9. 지적 소유권 정보 

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

 

[제품 소프트웨어 매뉴얼의 배포용 미디어 제작]

[1] 제품 소프트웨어 배포본의 개요

• 제품 소프트웨어 배포본은 최종 완성 단계에서 사용자가 정상 사용할 수 있도록 반드시 공식적인 인증 절차를 통하여 사용자에게 배포되도록 한다. 

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

  • 제품 소프트웨어 배포본은 개발된 컴포넌트 또는 패키지에 대해 제품화하고 배포 정보를 포함하여 진행하는 것으로 버전, 시스템이 설치 및 운영을 위한 요구 사항, 설치 방법, 달라진 기능, 알려진 버그 및 대처 방법 등을 포함하여 배포한다.
    

• 2. 제품 소프트웨어 배포본의 중요 사항 

  • (1) 제품 소프트웨어의 배포본은 최종 완성된 제품으로 안정성을 고려하여 배포한다. 

  • (2) 신규 및 변경을 고려하여 배포본에는 고유 버전 및 배포 단위의 기준을 정한다. 

  • (3) 배포용 미디어를 제작할 때에는 저작권 및 보안에 유의하여 제작한다. 

  • (4) 배포본은 자체의 고유 시리얼 넘버(Serial Number)를 반드시 부착하여 복제 및 사 후 지원을 고려하여 제작한다. 

 

[2] 제품 소프트웨어 매뉴얼의 배포용 미디어 제작

• 제품 소프트웨어 배포용 미디어 제작 시 필수 항목이 포함되어 있는지를 사전에 확인하고 제작한다. 그리고 여러 미디어에 따라 특성에 맞추어 제작한다. 

• 1. 제품 소프트웨어의 설치 파일 및 매뉴얼의 미디어 기본 구성 

  • 배포용 미디어 제작 시 다음과 같은 항목을 포함하여 제작한다. 

• 2. 배포용 미디어 제작 방법 

• 배포용 미디어는 온라인, 오프라인으로 각각 제작할 수 있으며, 각 유형별로 특성에 맞추어 제작한다. 

  • (1) 오프라인 미디어 

    • CD와 같은 오프라인 상으로 제품을 배포 가능하도록 제작한다. CD에는 반드시 고유의 시리얼 넘버(Serial Number)를 포함하여 복제 등의 불법 유통을 방지한다. 시리얼 넘버(Serial Number)는 이를 체계적으로 등록 관리 해야 하며, 미디 어 제작과는 별개로 이에 대한 관리 시스템을 사전에 확보해야 한다. 배포본에는 패키 지 설치 기준의 Install 버전을 작성하고, Document 파일은 사용자 매뉴얼 및 설치 매 뉴얼이 전부 포함될 수 있도록 한다

• (2) 온라인 미디어 

  • 최근에는 온라인 상에도 제품의 업그레이드나 패치 버전 등을 만들어 배포한다. 업그레이드나 오류 패치, 기능 수정 등은 빈번하게 일어날 수 있으므로, 사용자의 편의를 위해 정식 버전에 한하여 제품 지원을 계속한다. 따라서 온라인 상에서 제작되는 미디어는 그 특성에 맞도록 실행 파일로 통합하여 제 작한다. 또 이때에는 이전 버전 및 추가 버전에 대해서도 통합 관리를 해야 한다. 

  • 온라인 상으로 제작되어 제공되는 내용들은 다음과 같다. 

    • (가) 기능 업그레이드 

    • (나) 제품 패치 

    • (다) 기능적 오류 수정 

    • (라) OS 등의 업그레이드에 따른 호환성 제공

 

[연습문제]

• 설치 매뉴얼 작성의 기본 사항이 잘못된 것은? 

  • (1) 설치 매뉴얼은 개발자의 기준이 아닌 사용자의 기준으로 작성한다. 

  • (2) 최초 설치 실행부터 완료까지 순차적으로 진행한다. 

  • (3) 각 단계별 메시지 및 해당 화면을 순서대로 일부 캡처하여 설명한다. 

  • (4) 설치 중간에 이상 발생 시 해당 메시지 및 에러에 대한 내용을 분류하여 설명한다.
    
    

 

• 최근에는 온라인 상에도 제품의 업그레이드나 패치 버전 등을 만들어 배포한다. 온라인 상으로 제작되어 제공되는 내용들이 아닌 것은?

  • (가) 기능 업그레이드 

  • (나) 제품 패치, 제품소스

  • (다) 기능적 오류 수정 

  • (라) OS 등의 업그레이드에 따른 호환성 제공

 

 참고 문헌

[논문]

• 없음

[보고서]

• 없음

[URL]

• 없음

 

 문의사항

[기상학/프로그래밍 언어]

• sangho.lee.1990@gmail.com

[해양학/천문학/빅데이터]

• saimang0804@gmail.com

 

 

 

 

 

 

 

 

 

 

 

본 블로그는 파트너스 활동을 통해 일정액의 수수료를 제공받을 수 있음