본문 바로가기

자격증/정보처리기사 2과목

2-13장. 제품소프트웨어 패키징-제품소프트웨어 매뉴얼 작성

[ 목차 ]

1. 물리 데이터 저장소

 

 

1. 제품 소프트웨어 설치 메뉴얼

1) 사용자가 제품 구매 후 최초 설치 시 참조하는 메뉴얼

2) 제품 소프트웨 서괘, 설치 파일, 설치 절차 등이 포함

3) 기본 작성 항목

  1] 목차 및 개요 : 전체 내용 요약

  2] 문서 이력 정보 : 메뉴얼 변경 이력 정보

  3] 설치 도구 구성(설치 관련 파일-확장자 설명)

  4] 설치 위치 지정

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

 

2. 설치 관련 파일 확장자

1) exe : 실행 가능한 파일

2) dll (dynamic link library) : 장치의 드라이버 등 프로그램 설치 과정에서 필요한 경우 호출해서 사용하는 동적 링크 라이브러리

3) ini : windows 기반 컴퓨터의 기본 구성 값을 변경해야 하는 경우 사용되는 설정 초기화 파일

4) chm : html로 구성된 도움말 파일로 웹 브라우저에서 볼 수 있음

5) log : 설치 과정 및 결과가 기록되어 향후 문제 발생 시 진단하기 위한 자료로 사용

 

3. 설치 환경 체크 항목

1) 사용자 환경 : 사용자의 cpu, memory, os 등의 적합 환경

2) 응용 프로그램 : 설치 전 다른 응용프로그램 종료

3) 업그레이드 버전 : 업그레이드 이전 버전의 존재유무 확인

4) 백업 폴더 확인 : 데이터 저장 폴더를 확인하여 설치 시 폴더 동기화

 

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

1) 설치 방법을 순서대로 상세하게 설명하며 화면을 계속 캡처하여 사용자가 이해하기 쉽게 구성

2) 설치 화면은 exe. 등 install 파일을 실행하도록 화면을 첨부

3) 설치 실행 시 표시되는 내용 및 안내창에 대한 메시지를 설명

4) 구성요소

  1] 제품 소프트웨어 개요 : 주요 기능과 ui 설명, ui 및 호면 상의 버튼과 프레임 등을 도식화하여 설명

  2] 설치 파일 : 설치를 위한 관련 파일을 설명하고 exe, ini, log 파일 등 설치 파일을 설명

  3] 설치 절차 : 설치 절차를 설명하고 설치 디렉토리, 값에 대한 설명

  4] 설치 아이콘 : windows 구동용 설치 아이콘 설명

  5] 설치 삭제 : 삭제 시 삭제 방법 설명

  6] 설치 환경 : cpu, memory, os 등 설치에 필요한 환경 설명

  7] 설치 버전 및 작성자 : 릴리즈 버전 및 작성자 정보

  8] FAQ :  설치 시 자주 발생하는 어려움 요약

5) 정상 설치 완료 시 최종 메시지 출력과 사용자 안내를 통해 설치가 잘 되었음을 최종 통지

6) 설치 시 네트워크 문제로 인해 오류가 발생하지 않도록 사전에 connection을 체크

 

5. 설치 매뉴얼 작성 순서

1) 기능 식별 : 개요 및 기능들을 식별

2) UI분류 : 화면 단위로 작성될 UI를 분류

3) 설치/백업 파일 확인 : 설치 파일과 백업 파일명 확인 및 폴더 위치를 화긴

4) 삭제 절차 확인 : 제거 시 uninstall 파일을 설명

5) 이상 case 확인 : 설치 진행 시 이상 메시지 등에 대한 발생 시 조치 방안을 기술

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

 

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

1) 개발이 완료된 소프트웨어를 고객에게 전달하기 위한 형태로 패키징하고, 설치와 사용에 필요한 재반 절차 및 환경 등 전체 내용을 포함

2) 패티 개발과 업그레이드를 위해 버전 관리를 수행

3) 화면을 계속 캡처하여 사용자가 이해하기 쉽도록 구성

4) 주요 기능을 설명할 화면을 첨부

5) 함께 동작하는 어플리케이션이나 설치되어 충돌할 수 있는 응용 프로그램에 대해 안내

6) 사전에 실행해야 할 어플리케이션 기술

7) embedded 관련된 제품일 경우 해당 device에는 어떤 것이 잇는지, 연동되는 device는 무엇인지 설명

embedded system
1) 마이크로 프로세서(cpu)를 장착해 설계하여 효과적인 제어를 할 수 있는 시스템

 

7. 사용자 매뉴얼 작성 순서

1) 작성 지침 정의

  1] 사용자 매뉴얼을 작성하기 위한 지침을 설정

  2] 실제 사용자 환경에 필요한 정보를 제공할 수 있는 형태로 작성

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

  1] 제품 소프트웨어의 기능

  2] 구성 객체 목록

  3] 객체별 메소드

  4] 메소드의 파라미터 및 설명

  5] 실사용 예제

  6] 사용자 환경 셋팅 방법 

3) 구성 요소별 내용 작성 

4) 사용자 매뉴얼 검토

  1] 사용자 매뉴얼이 개발된 제품의 기능을 정확히 설명하는지 or 잘못된 정보가 없는지 검사

  2] 개발자와 함게 검토하면 기능 내용이나 인터페이스, 메소드나 메소드의 파라미터 등을 보다 정확히 반영할 수 있어 더욱 효과적

 

8. 사용자 매뉴얼 작성 항목

1) 목차 및 개요

  1] 메뉴얼 전체 내용을 순서대로 요약

  2] 주요 특징 정리

  3] 구성과 실행 방법, 메뉴에 대한 설명, 사용법

2) 문서 이력 정보 : 버전, 작성자, 작성일, 검토자, 일시, 검수인 등을 일자별로 기록

3) 기록항목

  1] 제품명칭 

  2] 모델명 : 버전을 포함한 소프트웨어 자체 모델명을 기재

  3] 문서번호 : 제품 소프트웨어 rev, 버전 날짜 등 고유한 문서번호 기재

  4] 제품번호 : 고유한 제품의 시리얼 넘버 기재

4) 기본사항

  1] 개요 : 주요 기능과 ui 설명, ui 및 화면 상의 버튼과 프레임 등을 도식화하여 설명

  2] 사용 : 사용하기 위한 최소 환경 설명, pc 사양과 os 버전 명시, 최초 동작을 위한 설명

  3] 관리 : 사용 종료 및 관리 등에 대한 내용 기재

  4] 구동환경 : 개발 언어 및 호환 os, 설치 마법사 이후 사용자가 구동하기 까지의 과정 요약

 

9. 국제 표준 제품 품질

1) 제품 품질 표준

  1] 품질 요구사항을 명세하고 품질을 평가하는 기준을 제공하는 특성 집합과 그들간의 상호관계

  2] 정의된 품질 모델을 사용해 소프트웨어 품질을 평가

  3] 품질 속성은 6가지 특성으로 구분 가능

      - 기능성 

      - 신뢰성

      - 사용성

      - 효율성

      - 유지 보수성

      - 이식성

  4] ISO/IEC 9126 : 품질 특성 및 측정 기준을 제시(국제 표준)하고 품질 속성을 6가지로 분류

      -1 : 품질모델, -2 : 외부품질, -3 : 내부품질, -4 : 사용품질

  5] 9126은 호환성, 보안성 강화를 위해 이후 25010으로 대체

기능성 
1) 실제 수행 결과와 품질 요구사항과의 차이를 분석
2) 적절성 : 적절한 기능 제공
3) 정밀성 : 정확도로 올바른 결과 산출
4) 상호 운용성 : 상호작용
5) 보안성 : 비인가된 접근 차단
6) 호환성 : 비슷한 환경에서 표준, 규정 준수

신뢰성
1) 일정 시간 또는 작동 시간 동안 의도하는 기능을 수행함을 보증
2) 성숙성 : 결함으로 인한 고장을 회피
3) 고장 허용성 : 결함에도 특정 수준 이상의 성능을 유지
4) 회복성 : 데이터를 복구하고 성능의 수준을 다시 확보

사용성
1) 사용자-컴퓨터 사이에 발생하는 행위를 정확하고 쉽게 인지
2) 이해성 : 소프트웨어의 논리적인 개념과 적용 가능성을 분간
3) 학습성 : 학습에 필요한 사용자의 노력 정도에 따른 특성
4) 운용성 : 운용과 운용 통제에 필요한 사용자의 노력 정도에 따른 특성

효율성
1) 할당된 시간, 한정된 자원으로 얼마나 빨리 처리 하는가
2) 시간 효율성 : 반응 시간, 처리 시간 및 처리율에 따른 소프트웨어 특성
3) 자원 효율성 : 자원의 양과 그 지속 시간에 따른 특성

유지 보수성
1) 요구사항을 개선하고 확장하는 데 있어 얼마나 용이한가
2) 분석성 : 고장 원인, 겨론 진단, 수정이 요구되는 부분 확인에 필요한 노력 정도
3) 변경성 : 결함 제거, 환경 변화에 따른 수정에 필요한 노력 정도
4) 안정성 : 예상치 못한 영향에 의한 위험 요소에 따른 특성
5) 시험성 : 변경 검증에 필요한 노력의 정도에 다른 특성

이식성
1) 다른 플랫폼에서도 추가 작업 없이 쉽게 적용 가능한가
2) 적용성 : 제공된 수단이나 다른 조치 없이 특정 환경으로 전환되는 능력
3) 설치성 : 특정 환경에 소프트웨어를 설치하는데 필요한 노력
4) 대체성 : 동일한 목적 달성을 위해 다른 소프트웨어를 대신 사용할 수 있는 능력

1) 내부 속성은 요구된 외부 행위를 성취하기 위한 선결과제이며 적절한 외부 행위는 사용 품질을 성취하기 위한 선결과제

외부품질
1) 제품이 지정된 조건하에 사용될 경우 명시된 요구와 내재된 요구를 충족하는 정도

내부품질
1) 명시된 요구와 내재된 요구를 충족할 수 있는 능력을 결정하는 제품속성의 총체
2) 내부적 소프트웨어 속성 기반

사용품질
1) 유효성, 작업효율, 만족도 등과 관련해 목표를 달성하기 위해사용자 요구를 충족하는 정도
2) 사용 관점

  6] ISO/IEC 14598

      - 소프트웨어 제품 평가 프로스세 및 평가 모듈을 제공

      - 획득자와 개발자 사이에서 소프트웨어 개발 과정 또는 제품의 품질에 대한 객관적인 평가 표준과 프로세스 제공

      - 소프트웨어 제품 평가 프로세스의 개요와 평가에 대한 안내지침 및 요구사항을 제공

      - 개발자에 대한 소프트웨어 제품 품질 향상과 구매자의 제품 품질 선정 기준을 제공

      - 9126 규정에 따름

14598 구성도

      - 개요 : 범위, 용어 정의, 9126과의 관계, 평가 프로세스와 평가모듈에 대한 로드맵 제공

      - 계획과 관리 : 제품 품질 측정 계획의 준비와 구현

      - 개발자용 프로세스 : 개발 단계에서 알아야 할 개발자 준수 사항

      - 구매자용 프로세스 : 제품을 구매하기 위한 계획 수립에 사용

      - 평가자용 프로세스 : 품질 전문가를 위한 프로세스

반복성 : 동일 평가자가 동일 사양으로 평가하면 동일한 결과가 나타남

재현성 : 다른 편가자가 동일 샤양을 평가하면 유사한 결과가 나타남
 
공정성 : 평가가 특정 결과에 편향되지 않음

객관성 : 평가 결과는 객관적 자료에 의해서만 평가

      - 평가 모듈 : 평가 모델에 대한 기본적 가이드와 이론적 모델을 제공하고 평가 모듈을 개발하고 문서화하고 검증하는 지침을 제공

  7] ISO/IEC 12119

      - 패키지 SW 품질 요구사항 및 테스트

      - 제품설명서 : 기본적 요구사항과 적절한 문서화 체계 평가

      - 사용자문서 : 기능, 성능, 범위가 정확하고 이해하기 쉬운 구조인가

      - 실행 프로그램 :설치되는 프로그램이 정확, 안전하게 실행되는가

      - 패키지의 속성을 설명하는 문서로 구매자가 제품이 필요한지 평가할 수 있는 정보 제공

      - 주로 패키지 소프트웨어에 대한 평가에 적용

12119 평가 절차

1) 제품 설명서 시험
2) 사용자 문서 시험
3) 실행 프로그램 시험
4) 시험 기록
5) 시험 보고서 작성

  8] ISO/IEC 25000

      - 여러 표준 문서는 오히려 혼란을 줄 수 있기 때문에 지금까지의 표준 문서를 통합, 재구성해 통일되고 일관성 있는 문서로 만든 것

 

2) 프로세스 품질 표준

  1] ISO/IEC 9000

      - 품질 경영과 품질 보증에 대한 국제 규격

  2] ISO/IEC 12207

      - 소프트웨어의 개발, 운영, 유지보수 등을 체계적으로 관리하기 위한 소프트웨어 생명 주기 표준을 제공

      - 기본 생명 주기 프로세스 : 획득(계약 준비), 공급(계약), 개발(소프트웨어 구현), 운영, 유지보수 프로세스

      - 지원 생명 주기 프로세스 : 품질 보증, 검증, 확인, 활동검토, 감사, 문서화, 형상 관리, 문제 해결 프로세스

      - 조직 생명 주기 프로세스 : 관리, 기반구조, 개선, 훈련 프로세스

  3] ISO/IEC 15504 = SPICE

      - 소프트웨어 프로세스 평가를 위한 프레임워크를 제공, 정보 시스템 분야에 특화된 품질 표준이자 인증 규격

      - 5개의 프로세스 범주로 구분된 40개 프로세스로 구성되어 있으며 6단계로 구분

      - 0. 불완전 단계 : 미구현 또는 미달성 단계로 프로세스가 구현되지 않고 목적을 달성하지 못함

      - 1. 수행 단계 : 수행 및 목적 달선 단계로 프로세스를 수행하고 목적을 달성하고 정의된 산출물을 생산

      - 2. 관리 단계 : 수행 계획 및 관리 단계로 정의된 자원 한도 내에서 작업 산출물을 인도

      - 3. 확립 단계 : 정의된 표준 프로세스를 사용하는 단계로 소프트웨어 공학 원칙으 기반으로 정의된 프로세스 수행

      - 4. 예측 단계 : 프로세스의 정량적 이해 및 통제 단계로 목적 달성을 위해 통제하고 양적 측정을 위해 일관된 수행

      - 5. 최적화 돤계 : 프로세스를 지속적으로 개선하는 단계로 수행을 최적화, 지속적 개선을 통해 업무 목적 만족화

고객-공급 프로세스
1) 소프트웨어를 개발하여 고객에게 전달하는 것을 지원
2) 소프트웨어를 정확하게 운영하고 사용하도록 하기 위한 프로세스로 구성
3) 구성 요소 : 인수, 공급, 요구도출, 운영 프로세스로 총 10개

공학 프로세스
1) 시스템과 소프으웨어 제품의 명세화, 구현, 유지보수하는 프로세스로 구성
2) 구성 요소 : 개발, 소프트웨어 유지 보수로 총 0개

지원 프로세스
1) 생명주기에서 다른 프로세스에 의해 이용되는 프로세스로 구성
2) 구성 요소 : 문서화, 형상, 품질 보증, 검증, 화긴, 리뷰, 감사, 품질 문제 해결로 총 8개

관리 프로세스
1) 생명주기에서 관리자에 의해 사용되는 프로세스로 구성
2) 구성 요소 : 관리, 프로젝트 관리, 품질/위험 관리로 총 4개

조직 프로세스
1) 조직의 업무 목적을 수립하고 업무 목표를 달성하는데 도움으 주는 프로세스로 구성
2) 구성 요소 : 조직 배치, 개성 활동 프로세스, 인력 관리, 기반 관리, 측정 도구, 재사용으로 총 9개

  4] ISO/IEC 15288

      - 시스템 생명주기 프로세스

      - 합의 프로세스, 조직 프로세스, 과제 프로세스, 기술 프로세스

  5] CMMI 

      - 조직의 프로세스 개선을 위해 개발되엇으며 표준 프로세스(요리 레시피)를 만들 수 있음

      - 소프트웨어 개발 조직의 업무 능력 및 조직의 성숙도를 평가하는 모델

      - 프로세스가 표준화 되어 있으면 일관된 표준을 따라 누구라도 비슷한 결과를 생산 가능

      - 프로젝트 목표 및 계획을 정량적으로 수립 가능하고 목표 달성 예측 가능하며 생산성, 품질이 향상

      - 1. 초기단계 : 프로세스가 없으며 예측, 통제가 불가능

      - 2. 관리단계 : 규칙화된 프로세스를 가지며 기본적인 프로젝트 관리 체계를 수립

      - 3. 정의 단계 : 표준화된 프로세스를 가지며 조직 차원의 표준 프로세스를 통한 프로젝트 지원

      - 4. 정량적 관리단계 : 예측 가능한 프로세스를 가지며 정량적으로 프로세스가 측정, 통제

      - 5. 최적화 된계 : 지속적 개선 프로세스를 가지며 프로세스 개선 활동 수행