관리 메뉴

클라이언트/ 서버/ 엔지니어 "게임 개발자"를 향한 매일의 공부일지

[소프트웨어 개발] 3장 제품 소프트웨어 패키징 3 - 제품 소프트웨어 매뉴얼 작성 본문

자격증 공부/정보처리기사 필기

[소프트웨어 개발] 3장 제품 소프트웨어 패키징 3 - 제품 소프트웨어 매뉴얼 작성

huenuri 2024. 7. 31. 13:06

이제 제품 매뉴얼을 작성하는 방법에 대해서 학습해 보기로 한다. 매뉴얼을 작성하는 건 특별히 중요한 내용은 많지 않고 한번 읽어보기만 해도 될 것 같았다.
그다음 장으로 소개되는 국제 표준 제품 품질은 조금 중요한 부분도 있는 것 같아 이 부분을 중점적으로 학습해 볼 것이다.


 

 

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

 

개념

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

 

 

설치 매뉴얼

 

개념

  • 사용자가 제품을 구매한 후 최초 설치 시 참조
  • 설치 시작부터 완료할 때까지의 전 과정을 빠짐없이 순서대로 설명

 

기본 작성 항목

1. 목차 및 개요

2. 문서 이력 정보

3. 설치 매뉴얼 주석

4. 설치 도구의 구성

5. 설치 위치 지정

 

 

설치 환경 체크 항목

1. 사용자 환경 : CPU 및 메모리, 운영체제 등 적합 환경

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

3. 업그레이드 버전 : 업그레이드 이전 버전 존재 유무

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

 

 

설치 메뉴얼 구성 요소

1. 제품 소프트웨어 개요 : 제품 SW 주요 기능 및 UI 설명

2. 설치 관련 파일 : 관련 파일 설명

3. 설치 절차 : 상세 절차 설명

4. 설치 아이콘 : 윈도즈 구동용 아이콘 설명

5. 삭제 방법

6. 설치 버전 및 작성자

7. 고개 지원 방법 및 FAQ

8. 준수 정보 및 제한 보증

 

 

작성 프로세스

1. 개요 및 기능 식별 : 제품의 전체적인 기능

2. UI 분류 : 설치를 위한 환면 단위 메뉴 분류

3. 설치 파일 / 백업 파일 확인 : 제품을 설치할 파일 및 백 업 파일명 확인

4. 삭제 절차 확인

5. 이상 유형 확인

6. 최종 매뉴얼 적용

 

 

 

사용자 매뉴얼

개념

  • 개발이 완료된 제품 SW를 고객에게 전달하기 위한 형태로 패키징
  • 설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용을 포함하는 문서
  • 개발된 컴포넌트 사용 시에 알아야 할 내용을 기술.
  • 패키지의 기능 · 인터페이스, 포함하고 있는 메서드나 오퍼레이션과 메서드의 파라미터 등의 설명이 포함됨

 

작성 항목

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

 

 

 

 

 

국제 표준 제품 품질 특성

 

1. 특성 개념

  • 제품에 대하여 명확하게 정의된 특성을 의미. 품질을 평가하는 기준 항목
  • 품질에 관련된 국제 표준화는 ISO/IEC, ITU-T, IEEE를 중심으로 진행
  • 제품 품질 표준과 프로세스 품질 표준으로 나누어짐

 

2. 국제 제품 품질 표준

 

국제 제품 품질 표준

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

ISO(International Organization for Standardization)
여러 나라의 표준 제정 단체들이 대표로 이루어진 국제 표준화 기구. 나라마다 다른 산업, 통상 표준의 문제점을 해결하고자 국제적으로 통용되는 표준을 개발하고 보급

IEC(International Electronical Committee)
국제전자기술위원회의 약자로 전기, 전자 및 관련 기술을 위한 국제 표준을 준비하고 발행하는 세계 기구

ITU-T(International Telecommunication Standardization Sector)
국제 전기통신연합 전기통신표주화부문의 하나로 통신 분야의 표준을 책정하며 스위스 제네바 시에 위치

IEEE(Institute of Electrical and Electronics Engineers)
전기 전자 기술자 협회를 뜻하는 말로 전기전자공학 전문가들의 국제조직

 

 

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

1. 기능성 : 명시된 요구와 내재된 요구를 만족하는 기능을 제공하는 SW 제품의 능력

2. 신뢰성 : 성능 수준을 유지할 수 있는 SW 제품의 능력

3. 사용성 : 사용자에 의해 이해되고 학습, 사용, 선호될 수 있음

4. 효율성 : 자원의 양에 따라 요구된 성능을 제공

5. 유지보수성 : SW 제품이 변경되는 능력

6. 이식성 : 하나 이상의 하드웨어 환경에서 운용되기 위해 쉽게 수정

 

 

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

1. 반복성 : 동일 사양으로 평가하면 동일한 결과가 나와야 한다

2. 재현성 : 동일 사양을 평가하면 유사한 결과가 나와야 한다

3. 공정성 : 평가가 특정 결과에 편향되지 않아야 함

4. 객관성 : 평가 결과는 객관적 자료에 의해서만 평가되어야 함

개발자 관점에서 고려해야 할 항목은 정확성, 신뢰성, 효율성, 무결성, 유연성, 이식성, 사용성, 상호운용성이다.

 

 

 

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

국제 품질 수준 문제는 숫자 위주로 학습하는 것이 좋다.

1. ISO/IEC 9001 : 설계/개발, 생산, 설치 및 서비스 과정에 대한 품질 보증 모델

필요한 품질 시스템 순기활동과 그에 따른 공급자와 구매자 각각의 관리 책임을 명시하고 있음. 운영 중인 품질 시스템이 이 표준에 적합할 경우 품질 인증을 부여

2. ISO/IEC 12207 : 소프트웨어 획득, 공급, 개발, 운영, 유지보수를 체계적으로 관리하기 위한 SW 생명 주기 단계별 필요 프로세스를 규정한 국제 표준

기본/지원/조직 프로세스

3. ISO/IEC 15504 : SW 프로세스를 평가하고 개선함으로써 품질 및 생산성을 높이고자 하는 국제 표준

ISO/IEC 12207에 준거하여 구분하고 있으며, 각 프로세스 영역별로 카테고리와 기본 프로세스로 정의

  • 수행단계 구분 : 불완전(0) -> 수행(1) -> 관리(2) -> 확립(3) -> 예측(4) -> 최적화(5)

4. CMMi : 기존 CMM 모델을 통합하고 ISO15504를 준수하는 SW 개발 능력/ 성숙도 평가 및 프로세스 개선 활동의 지속적인 품질 개선 모델

적용 및 평가 방식은 조직 차원의 성숙도를 평가하는 단계적 표현과 프로세스 영역별 능력도를 평가하는 연속적 표현이 있음

 

 

4. 소프트웨어 품질 평가 통합 모델, ISO/IEC 25000

  • SW 품질 특성(ISO/IEC 9126) 및 품질 평가 방법(ISO/IEC 14598)을 통합한 SW 품질 평가 모델 국제 표준
  • SQuaRE(System and Software Quality Requirements and Evaluation)라고 함

 

 

구조

1. 2500n : 품질 관리

  • SQuaRE 표준의 가이드라인과 품질평가 관리에 관한 표준 제시

2. 2501n : 품질 모델

  • 제품 폼질 평가의 일반 모델 제시
  • 구 표준에는 없는 데이터 품질 모델 제장

3. 2502n : 품질 측정

  • 품질측정 메트릭 정의
  • 소프트웨어 내부 · 외부 · 사용품질 · 측정, 품질 측정 요소 등을 다룸

4. 2502n : 품질 평가

  • 품질평가 절차를 정의

 

 

 

5. 소프트웨어 공학의 기본 원칙

1) 개념

하드웨어를 동작시켜 사용자가 작업을 편리하게 수행하도록 하는 프로그램 및 자료 구조

 

2) 소프트웨어 위기

개념

  • 여러 원인에 의해 SW 개발 속도가 하드웨어 개발 속도를 따라가지 못함에 따라 사용자들의 요구사항을 충족시키지 못하는 현상

원인과 극복 방안

  1. 위기 : 특징에 대한 이해 부족, 관리 부재, 복잡도 및 크기 증가, 제품 수명주기 단축
  2. 극복 방안 : 공학적 접근, 표준화, 자동화 도구, 품질 보증

 

 

3) 소프트웨어 공학

개념

  • 소프트웨어 개발, 운용, 유지보수 및 파기에 대한 체계적인 접근 방법
  • 신뢰성 있는 소프트웨어를 경제적인 비용으로 획득하기 위해 공학적 원리를 정립 · 이를 이용
  • 소프트웨어 위기를 극복하기 위한 방안으로 연구된 학문

원칙

  • 현대적인 프로그래밍 기술을 계속적으로 적용
  • 개발된 소프트웨어 품질이 유지되도록 지속적 검증 수행
  • SW 개발 관련 사항 및 결과에 대한 명확한 기록 유지

 

공학적으로 잘된 소프트웨어 특성

  • 유지보수가 용이
  • 신뢰성이 높음
  • 충분한 테스팅을 거침

 

관련 법칙

 

브룩스 법칙

  • 지체되는 SW 개발 프로젝트에 인력을 추가하는 것은 개발을 늦출 뿐
  • 인력이 추가되어 개발 생선성이 향상되지 않고, 오히려 그 인력 때문에 방해가 됨

파레토 법칙

  • 전체 결과의 80%가 전체 원인의 20%에서 일어나는 현상
  • SW 테스트 원리 중 20% 모듈에서 80%의 결함이 발견된다는 '결함 집중'의 원리 내포

롱테일 법칙

  • 사소해 보이는 80%의 다수가 20%의 소수 핵심보다도 뛰어난 가치를 창출
  • 파레토 법칙의 반대 법칙

 

 

 

학습을 마치고

소프트웨어 품질을 구성하는 요소와 법칙, SW 공학 등에 대해서 학습해 보았다. 처음 들어보는 용어들이 많아서 헷갈리기도 하고, 아직 암기가 되지 않아 문제를 풀 때 어려운 부분도 있었다.
그래도 3단원 학습이 거의 끝나가서 정말 기뻤다. 다음번에 학습할 부분은 소프트웨어 버전 관리인데 이것만 하면 3장은 마치게 된다.

오후에는 PPT를 제작하는 방법에 대해서 강의가 있지만 대부분 아는 내용이고, 지금은 들어야 별로 집중이 안될 것 같아 따로 정처리 공부를 하는 중이다.