본문 바로가기
정보처리기사/필기

[정보처리기사] Part02-03-2. 제품 소프트웨어 메뉴얼 작성

by 채연2 2022. 7. 15.

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

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

- 제품 소프트웨어 소개, 설치 파일, 설치 절차 등 포함

 

   ● 제품 SW 설치 기본 작성 항목

      - 목차 및 개요 : 매뉴얼 전체 내용에 대한 요약

      - 문서 이력 정보 : 매뉴얼 변경 이력 정보

      - 설치 도구 구성 : exe/dll/ini/chm 등 설치 관련 파일 설명

      - 설치 위치 지정 : 설치 폴더와 설치 프로그램 실행 파일 설명

 

   ● 제품 SW 설치 환경 체크 항목

      - 사용자 환경 : 사용자 CPU 및 Memory, OS 등 적합 환경

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

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

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

 

   ● 작성 순서

      1. 기능 식별

          - 제품 SW 개요 및 기능들 식별

 

      2. UI 분류

          - 화면 단위로 작성될 UI 분류

 

      3. 설치/백업 파일 확인

          - 설치 파일 및 백업 파일명 확인 및 폴더 위치 확인

 

      4. Uninstall 절차 확인

          - 제품 제거 시 uninstall 파일 설명

 

      5. 이상 Case 확인

          - 설치 진행 시 이상 메세지 등에 대한 발생 시 조치 방안 기술

 

      6. 최종 매뉴얼 적용

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

 

   ● 구성

      - 제품 SW 설치 방법 순서대로 상세히 설명

      - 주로 화면 계속 캡쳐하여 사용자 이해 쉽도록 구성

      - 설치 화면은 exe 등 install 파일 실행하도록 화면 첨부

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

 

      - 제품 소프트웨어 개요

      - 설치 파일

      - 설치 절차

      - 설치 아이콘

      - 설치 삭제

      - 설치 환경

      - 설치 버전 및 작성자

      - FAQ

 

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

      - 개발 완료된 SW를 고객에게 전달 위한 형태로 패키징하고, 설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용 포함

      - 제품 SW에 대한 패치 개발과 업그레이드 위해 버전 관리 수행

 

      ○ 항목

         - 화면 캡쳐 최대한 활용하여 사용자 이해 용이하도록 구성

         - 주요 기능 설명할 화면 첨부

         - 제품 SW 동작 시 함께 동작하는 App이나 설치되어 충돌 가능성 있는 응용 P/G에 대해 보여줌

         - 제품 SW 동작 시 사전에 실행해야 할 App 기술

         - 제품 SW가 Embedded 관련 제품일 경우 해당 제품에는 어떤 것이 있는지, 연동되는 제품에는 무엇이 있는지 설명

         ▶ 목차 및 개요

             - 매뉴얼 전체 내용 순서대로 요약

             - 제품 SW 주요 특징에 대해 정리

             - 사용자 매뉴얼에서의 구성과 실행 방법, 메뉴 설명, 사용법

 

         ▶ 문서 이력 정보

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

 

         ▶ 기록 항목

            ▷ 제품 명칭

                - 제품 SW 명칭 기재

            ▷ 모델명

                - 버전 포함한 제품 SW 자체 모델명 기재 ( ex. SS-SPM-258901567)

            ▷ 문서 번호

                - 제품 SW Rev. 버전 날짜 등 고유 문서번호 기재

            ▷ 제품 번호

                - 고유 제품 시리얼 넘버 기재

 

         ▶ 기본 사항

            ▷ 개요

                - 제품 SW 주요 기능 및 UI 설명

                - UI 및 화면 상 버튼, 프레임 등 도식화하여 설명

            ▷ 사용

                - 제품 SW 사용 위한 최소 환경 설명

                - PC 사양, OS 버전 명시

                - 제품 SW 최초 동작 위한 설명

            ▷ 관리

                - 제품 SW 사용 종료 및 관리 등 내용 기재

            ▷ 구동 환경

                - 개발 언어 및 호환 OS

                - 설치 마법사 이후 사용자가 구동하기 까지의 과정 요약

 

      ○ 작성 순서

         1. 작성 지침 정의

            - 실제 사용자 환경에 필요한 정보 제공 가능한 형태로 작성될 수 있도록

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

            - 제품 SW 기능, 구성 객체 목록, 객체별 메소드, 메소드 파라미터 및 설명, 실제 사용 예제, 사용자 환경 셋팅 방법

         3. 구성 요소 별 내용 작성

         4. 사용자 매뉴얼 검토

            - 개발된 제품 기능을 정확히 설명하는지 잘못된 정보 없는지 검사

 


* 국제 표준 제품 품질 특성

1. 제품 품질 국제 표준

    - IT 프로젝트 진행하거나, 완성된 IT 제품에 대해 기능성, 신뢰성 등 평가하는 기준 되는 국제 표준

 

   ● SW 품질 관련 국제 표준

       - ISO/IEC 9126

          ▷ 9126-1 (품질모델), 9126-2 (외부품질), 9126-3 (내부품질), 9126-4 (사용품질)

          ▶ SW 품질 측정/평가 위해 SW 품질요소와 특성 정의

          ▶ 기능성 (Functionality)

             - SW가 특정 조건에서 사용될 때 명시된 요구와 내재된 요구 만족하는 기능 제공하는 SW 제품 능력

             - 품질 부특성 : 적절성, 정확성, 상호운용성, 보안성, 준수성 등

          ▶ 신뢰성 (Reliability)

             - 명세된 조건에서 사용될 때 성능 수준 유지 가능한 SW 제품 능력

             - 옳고 일관된 결과 얻기 위해 요구된 기능 수행 가능한 정도

             - 주어진 시간 동안 주어진 기능을 오류 없이 수행하는 정도

             - 품질 부특성 : 성숙성, 결함 허용성, 회복성, 준수성 

          ▶사용성 (Usability)

             - 명시된 조건에서 사용될 때 사용자에 의해 이해/학습/사용/선호될 수 있는 SW 제품 능력

             - 품질 부특성 : 이해성, 학습성, 운용성, 친밀성, 준수성 

          ▶ 효율성 (Effciency)

             - 명시된 조건에서 사용될 때 사용되는 자원 양에 따라 요구된 성능 제공하는 SW 제품 능력

             - 품질 부특성 : 실행 효율성, 자원 효율성, 준수성 

          ▶ 유지보수성 (Maintainability)

             - SW 제품 변경되는 능력

             - 환경과 요구사항 및 기능적 명세에 따른 SW 수정, 개선, 개작 등에 의해 변경

             - 품질 부특성 : 분석성, 변경성, 안정성, 시험성, 준수성 등

          ▶ 이식성 (Portability)

             - 기존 환경에서 다른 환경으로 전이 가능한 SW 제품 능력

             - 품질 부특성 : 적응성, 설치성, 공존성, 대체성, 준수성 등

 

       - ISO/IEC 14598

          ▷ 14598-1 (개요), 14598-2 (계획,관리), 14598-3 (개발자용 프로세스), 14598-4 (구매자용 프로세스)

          ▷ 14598-5 (평가자용 프로세스), 14598-6 (평가모듈)

          ▶ 개발자에 대한 SW 제품 품질 향상과 구매자 제품 품질 선정 기준 제공하는 표준

          ▶ 패키지 SW와 Si 개발 SW에 있어서 개발 과정 또는 개발 완료된 제품 품질에 대한 평가 표준과 프로세스 제공

          ▶ ISO 9126 규정에 따름

 

          ▶ 특징

             - 반복성 (Repeatability) : 특정 제품을 동일 평가자가 동일 사양으로 평가하면 동일 결과 나와야 함

             - 재현성 (Reproducibility) : 특정 제품을 다른 평가자가 동일 사향으로 평가하면 유사 결과 나와야 함

             - 공정성 (Impartiaility) : 평가가 특정 결과에 편향되지 않아야 함

             - 객관성 (Objectivity) : 평과 결과는 객관적 자료에 의해서만 평가되어야 함

 

       - ISO/IEC 12119

          ▷ 소프트웨어 패키지 (제품 설명서, 사용자 문서, 프로그램과 데이터)

          ▶ SW 패키지 제품에 대한 품질 요구사항 및 테스트 국제 표준

          

          ▶ 평가 절차

             1. 제품 설명서 시험

                 - 제품 설명서에 관한 요구사항, 권고 사항 수행 시험

                 - 일관성, 제품 소개 명시 내용, 각 품질 특성 내용 시험

             2. 사용자 문서 지침

                 - 사용자 문서에 관한 요구사항, 권고 사항 수행 시험

                 - 완전성, 정확성, 일관성, 이해성, 개괄 용이성

             3. 실행 프로그램 시험

                 - P/G, 데이터에 관한 요구사항, 권고 사항 수행 시험

                 - 문서대로 실행 여부 신뢰성

             4. 시험 기록

                 - 시험 반복 및 충분한 정보 포함한 기록 작성

             5. 시험 보고서 작성

                 - 시험 목적과 결과 요약

 

       - ISO/IEC 25000 (SQuaRE)

          ▷ 2500n (9126-1), 2501n (9126-2), 2502n (9126-3), 2503n (9126-4), 2504n (9126-5)

          ▷ 2500n (SQuaRE), 2501n (품질 모형(모델)), 2502n (품질 메트릭), 2503n (품질 요구사항), 2504n (품질 평가)

          ▶ ISO/IEC 9126 + ISO/IEC 14598 + ISO/IEC 12119 통합 및 ISO/IEC 15288 참고한 SW 제품 품질에 대한 통합적인 국제 표준

 

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

    ● SW 프로세스 관련 국제 표준

       - ISO/IEC 9000 (품질 경영과 품질 보증)

          ▷ 9001 (설계, 개발, 서비스), 9002 (생산과 설치), 9003 (최종검사 및 시험), 9004 (지침 표준)

          ▶ 품질 경영과 품질 보증에 관한 국제 규격

          ▶ ISO/IEC 9000 family 선택과 사용 지침

 

       - ISO/IEC 12207

          ▷ 기본 생명주기 프로세스 : 획득, 공급, 개발, 운영, 유지보수

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

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

          ▶ SW 생명 주기 동안에 대한 품질 국제 표준

          ▶ SW Life Cycle Process

 

       - ISO/IEC 15504 (SPICE)

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

          ▶ SW 프로세스 평가/개선함으로써 품질 및 생산성 높이고자 하는 국제 표준

          ▶ SW Process 요소 (개발/지원/조직 등)의 계획, 통제, 개선 capability와 process 규명

 

       - ISO/IEC 15288

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

          ▶ 시스템 생명주기 프로세스 국제 표준

 

       - CMMI

          ▷ 단계적 표현, 연속적 표현

          ▶ 기존 CMM 모델 통합하고 ISO 15504 준수하는 SW 개발 능력/성숙도 평가 및 프로세스 개선 활동의 지속적인 품질 개선 모델

 

 

 

 

 

320x100

댓글