8일차 : 3-2 제품 소프트웨어 매뉴얼 작성

Dev_HG·2020년 7월 5일

정보처리기사

1. 제품 소프트웨어 메뉴얼 작성

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

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

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

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

제품 소프트웨어 설치 매뉴얼이란 사용자가 제품을 구매한 후 최초 설치시 참조하는 매뉴얼이다.
제품 소프트웨어 설치 메뉴얼에는 제품 소프트웨어 소개, 설치 파일, 설치 절차 등이 포함 된다.

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

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

제품 소프트웨어 설치 매뉴얼이란 사용자가 제품을 구매한 후 최초 설치시 참조하는 매뉴얼이다.
제품 소프트웨어 설치 매뉴얼에는 제품 소프트웨어 소개, 설치 파일, 설치 절차 등이 포함된다.

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

제품 소프트웨어 설치 매뉴얼 기본 작성 항목에는 목차 및 개요, 문서 이력정보, 설치 매뉴얼 주석, 설치 도구의 구성, 설치 위치 지정으로 구성되어 있다.

1. 목차 및 개요

매뉴얼 전체 내용을 순서대로 파악
설치 매뉴얼의 주요 특징, 구성과 설치 방법, 순서 등에 대해 기술

2. 문서 이력 정보

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

3. 설치 매뉴얼 주석

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

4. 설치 도구의 구성

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

5. 설치 위치 지정

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

[설치를 위한 환경 체크 항목]

1. 사용자 환경

CPU 및 메모리, 운영체제(OS) 등의 적합 환경 확인

2. 응용 프로그램

설치 전 다른 응용 프로그램의 종료 확인

3. 업그레이드 버전

업그레이드 이전 버전에 대한 존재 유무 확인

4. 백업 폴더 확인

데이터 저장 폴더를 확인하여 설치 시 폴더 동기화

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

제품 소프트웨어 설치 매뉴얼은 설치 방법을 순서대로 상세하게 설명할 수 있도록 설치 화면을 캡처하여 사용자가 이해하기 쉽도록 구성한다.
설치 실행 시 표시되는 내용 및 안내 창에 대한 메시지를 설명

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

1. 제품 소프트웨어 개요

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

2. 설치 관련 파일

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

3. 설치 절차

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

4. 설치 아이콘

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

5. 삭제 방법

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

6. 설치 버전 및 작성자

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

7. 고객 지원 방법 및 FAQ

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

8. 준수 정보 & 제한 보증

시리얼 보존, 불법 등록 사용 금지 등의 준수 사항 권고
저작권 정보 관련 사항 작성
정상 설치 완료 시 최종 정상 설치 완료 메시지 출력과 사용자 안내를 출력 함으로써 설치가 잘 되었음을 통지한다.

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

제품 소프트웨어 설치 매뉴얼 작성은 개요 및 기능 식별, UI 분류, 설치 파일/ 백업 파일 확인, 삭제 절차 확인, 이상 유형 확인, 최종 매뉴얼 적용 순의 절차로 구성되어 있다.

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

1. 개요 및 기능 식별

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

2. UI 분류

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

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

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

4. 삭제 절차 확인

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

5. 이상 유형 확인

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

6. 최종 매뉴얼 적용

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

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

1. 제품 소프트웨어 사용자 매뉴얼 개념

제품 소프트웨어 사용자 매뉴얼은 개발이 완료된 제품 소프트웨어를 고객에게 전달하기 위한 형태로 패키징하고, 설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용을 포함하는 문서이다.
제품 소프트웨어 사용자 매뉴얼에는 개발된 컴포넌트 사용 시에 알아야 할 내용을 기술하며 패키지의 기능, 패키지의 인터페이스, 포함하고 있는 메서드나 오퍼레이션과 메서드의 파라미터 등의 설명이 포함되어 있다.
cf: 메서드(Method) : 메서드는 클래스에서 정의된 여러 종류의 변수들을 사용하여 정해진 기능들을 실행할 수 있도록, 코드들을 선언한 것으로 다른 곳에서 인자를 주어 호출할 수도 잇고, 정해진 자료형을 반환할 수 있다.

cf: 파라미터(Parameter) : 파라미터란 매개변수를 뜻하는 말로 메서드 수행에 필요한 입력값을 저장하는 변수이다.

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

1. 목차 및 개요

매뉴얼 전체 내용을 순서대로 요약
제품 소프트웨어의 주요 특징 정리
사용자 매뉴얼에서의 구성과 실행 방법, 메뉴에 대한 설명을 비롯하여 사용법, 각 항목에 따른 점검 기준, 설정 방법 등에 대해 기술

2. 문서 이력 정보

버전, 작성자, 작성일, 검토자, 일시, 검수인 등을 일자별로 기록

3. 사용자 매뉴얼 주석

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

4. 기록항목

제품 명칭, 모델명, 문서 번호, 제품 번호 등의 기록 항목이 있음

5. 기본사항

제품 소프트웨어 기본사항에는 개요, 사용방법 및 관리방법, 모델, 버전 별 특징, 제품 소프트웨어 기능 및 인터페이스 특징, 구동환경 등이 있음

6. 고객 지원 방법 및 FAQ

설치 관련하여 기술적인 지원이나 제품 서비스를 받을 수 있는 유선 및 이메일, 홈페이지 주소

7. 준수 정보 & 제한 보증

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

=> 제품 소프트웨어 사용자 매뉴얼은 사용자가 이해하기 쉽도록 화면을 캡쳐하여 구성하고, 주요 기능에 대해서는 설명 화면을 첨부한다.
=> 제품 소프트웨어 동작 시 함께 동작하는 애플리케이션이나 설치되어 충돌 될 수 있는 응용프로그램에 대해 설명 한다.

3. 제품 소프트웨어 사용자 매뉴얼 작성 프로세스

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

1. 작성 지침 정의

사용자 매뉴얼을 작성하기 위한 지침 설정
사용자 매뉴얼은 실제 사용자 환경에 필요한 정보를 제공할 수 있는 형태로 작성

2. 사용자 매뉴얼 구성요소 정의

제품 소프트웨어의 기능, 구성 객체 목록, 객체별 메서드, 메서드의 파라미터, 실제 사용 예제, 사용자 환경 세팅 방법등의 사용자 매뉴얼 구성요소를 정의

3. 구성요소별 내용 작성

제품 소프트웨어 구성요서별로 내용 작성

4. 사용자 매뉴얼 검토

작성된 사용자 매뉴얼이 제품의 기능을 제대로 설명하는지, 제품 사용 시 부족한 정보가 없는지 등을 검사
해당 기능별 관련 개발자와 함계 기능 내용이나 인터페이스, 메서드나 메서드의 파라미터 등을 검토
점검 사항을 반영하여 사용자 지침서 수정,보완

2. 국제 표준 제품 품질 특성

1. 국제 표준 제품 품질 특성 개념

국제 표준 제품 품질 특성은 제품에 대하여 명확하게 정의된 특성을 의미 하며, 품질을 평가하는 기준 항목이다.
품질에 관련된 국제 표준화는 ISO/IEC, ITU-T, IEEE를 중심으로 진행되고 있다.
제품 품질 표준과 프로세스 품질 표준으로 나눌 수 있다.
cf : ISO(International Organization for Standardization)
여러 나라의 표준 제정 단체들의 대표들로 이루어진 국제 표준화 기구이다. 나라마다 다른 산업, 통상 표준의 문제점을 해결하고자 국제적으로 통용되는 표준을 개발하고 보듭
cf : IEC(International Electronical Committee)
국제전자기술위원회의 약자로 전기, 전자 및 관련 기술을 위한 국제 표준을 준비하고 발행하는 세계 기구이다.
cf: ITU-T(International Telecommunication Union Telecommunication Standardization Sector)
국제전기통신연합 전기통신 표준화부문의 하나로 통신 분야의 표준을 책정하며 스위스 제네바 시에 위치해 있다.
cf : IEEE(Institute of Electrical and Electronics Engineers)
전기 전자 기술자 협회를 뜻하는 말로 전기전자공학 전문가들의 국제조직이다.

2. 국제 표준 제품 품질 특성

1. 국제 제품 품질 표준

IT 프로젝트를 진행하거나, 완성된 IT 제품에 대해 기능성, 신뢰성 등을 평가하는 기준이 되는 국제 표준이다.
ISO/IEC 9126은 품질 특성 및 측정 기준을 정의하고 있는 표준으로 1991년에 제정된 후 1994년부터 품질 특성과 내부 품질과 외부 품질을 조정하고 , 품질 측정 절차를 별도의 ISO/IEC 14598 표준으로 분리하였다.

1. ISO/IEC 9126

ISO/IEC 9126의 품질 모델은 소프트웨어 품질을 측정하고, 평가하기 위해서 소프트웨어의 품질요소와 특성을 정의
품질 특성은 기능성, 신뢰성, 사용성, 효율성, 유지보수성, 이식성으로 나눔

2. ISO/IEC 14598

소프트웨어 제품 평가 프로세스 및 평가 모듈을 제공
패키지 소프트웨어와 SI 개발 소프트웨어에 있어서 개발과정 또는 개발이 완료된 제품의 품질에 대한 평가 표준과 프로세스를 제공

3. ISO/IEC 12119

소프트웨어 패키지 제품에 대한 품질 요구사항 및 테스트 국제 표준
제품 설명서, 사용자 문서, 실행 프로그램

4. ISO/IEC 25000

SQuaRE로도 불리며, ISO/IEC 9126과 ISO/IEC 14598, ISO/IEC 12119를 통합하고, ISO/IEC 15288을 참고한 소프트웨어 제품 품질에 대한 통합적인 국제표준
개발 공정 각 단계에서 산출되는 제품이 요구사항을 만족하는지 검증하기 위해 품질 측정 및 평가를 위한 모델

2. ISO/IEC 9126의 소프트웨어 품질 특성

기능성, 신뢰성, 사용성, 효율성, 유지보수성, 이식성이 있다

1. 기능성(Functionality)

소프트웨어가 특정 조건에서 사용될 때 명시된 요구와 내재된 요구를 만족하는 기능을 제공하는 소프트웨어 제품의 능력
품질 부특성에는 적합성, 정확성, 상호 운용성, 보안성, 준수성 등이 있음

2. 신뢰성(Reliability)

명세된 조건에서 사용될 때 성능 수준을 유지할 수 있는 소프트웨어 제품의 능력
옳고 일관된 결과를 얻기 위하여 요구된 기능을 수행할 수 있는 정도이고, 주어진 시간 동안 주어진 기능을 오류 없이 수행하는 정도
품질 부특성에는 성숙성, 결함 허용성, 회복성, 준수성 등이 있음

3. 사용성(Usability)

명시된 조건에서 사용될 경우, 사용자에 의해 이해되고, 학습되고, 사용되고 선호될 수 있는 소프트웨어 제품의 능력을 말함
품질 부특성에는 이해성, 학습성, 운용성, 친밀성, 준수성 등이 있음

4. 효율성(Effciency)

명시된 조건에서 사용될 경우, 사용자에 의해 이해되고, 학습되고, 사용되고 선호될 수 있는 소프트웨어 제품의 능력을 말함
품질 부특성에는 이해성, 학습성, 운용성, 친밀성, 준수성 등이 있음

5. 유지보수성(Maintainability)

소프트웨어 제품이 변경되는 능력
변경에는 환경과 요구사항 및 기능적 명세에 따른 소프트웨어의 수정, 개선, 혹은 개작 등이 포함
품질 부특성에는 분석성, 변경성, 안정성, 시험성, 준수성 등이 있음

6. 이식성(Portability)

한 환경에서 다른 환경으로 전이될 수 있는 소프트웨어 제품의 능력
품질 부특성에는 적응성, 설치성, 공존성, 대체성, 준수성 등이 있음

3. ISO/IEC 14598의 소프트웨어 품질 특성

ISO/IEC 14598은 개발자에 대한 소프트웨어 제품 품질 향상과 구매자의 제품 품질 선정 기준을 제공하는 표준

1. 반복성(Repeatability)

특정 제품을 동일 평가자가 동일 사양으로 평가하면 동일한 결과가 나와야 한다는 특성

2. 재현성(Reproductibility)

특정 제품을 다른 평가자가 동일 사양을 평가하면 유사한 결과가 나와야 한다는 특성

3. 공정성(Impartiality)

평가가 특정 결과에 편향되지 않아야 한다는 특성

4. 객관성(Objectivity)

평가 결과는 객관적 자료에 의해서만 평가되어야 한다는 특성

3. 국제 프로세스 품질 표준

IT 프로젝트를 진행하거나 IT를 운영함에 있어 프로세스가 수립되어 있고 체계적으로 운용되고 있는지를 평가하는 기준이 되는 국제 표준

1. ISO/IEC 9001

설계/개발, 생산, 설치 및 서비스 과정에 대한 품질 보증 모델
필요한 풀짐 시스템 순기활동과 그에 다른 공급자와 구매자 각각의 관리책임을 명시하고 잇으며 운영 중인 품질 시스템이 이 표준에 적합할 경우 품질 인증을 부여
[세부 사항]
ISO 9000 - 3 (ISO 9001 표준을 소프트웨어 산업에 맞게 변형한 국제 표준)

2. ISO/IEC 12207

소프트웨어의 획득, 공급, 개발, 운영, 유지보수를 체계적으로 관리하기 위한 소프트웨어 생명주기 단계별 필요 프로세스를 규정한 국제 표준
[세부 사항]
기본/지원/조직 프로세스

3. ISO/IEC 15504(SPICE)

소프트웨어 프로세스를 평가하고 개선함으로써 품질 및 생산성을 높이고자 하는 국제표준
소프트웨어 프로세스 영역을 ISO/IEC 12207에 준거 하여 기본/지원/조직 프로세스로 구분하고 있으며 각 프로세스 영역별로 프로세스 카테고리와 기본 프로세스 정의
[세부 사항]
수행단계 구분 : 불완전(0) -> 수행(1) -> 관리(2) -> 확립(3) -> 예측(4) -> 최적화(5)

4. CMMi

기존 CMM 모델을 통합하고 ISO15504(SPICE)를 준수하는 소프트웨어 개발 능력/성숙도 평가 및 프로세스 개선 활동의 지속적인 품질 개선 모델
적용 및 평가 방시은 조직차원의 성숙도를 평가하는 단계별 표현과 프로세스 영역별 능력도를 평가하는 연속적 표현이 있음
[세부 사항]
프로세스 영역
목표
실행
공통특징

cf : CMMI의 단계별 표현