12. 제품 소프트웨어 매뉴얼 작성
제품 소프트웨어 매뉴얼 작성
개념
사용자가 제품 구매 후 최초 설치 시 참조하게 되는 메뉴얼
제품 소프트웨어 소개, 설치 파일, 설치 절차 등이 포함
설치 매뉴얼
작성의 기본 사항
개발자의 기준이 아닌 사용자의 기준으로 작성
최초 설치 실행부터 완료까지 순차적으로 진행
각 단계별 메시지 및 해당 화면을 순서대로 전부 캡처하여 설명
설치 중간에 이상 발생 시 해당 메시지 및 에러에 대한 내용을 분류하여 설명
작성 항목
목차 및 개요
- 매뉴얼 전체의 내용을 순서대로 요약
- 설치 매뉴얼의 주요 특징에 대해 정리
- 설치 매뉴얼에서의 구성과 설치 방법, 순서 등에 대해 기술
문서 이력 정보
- 설치 매뉴얼 변경 이력 정보
주석
- 주의 사항 : 사용자가 제품 설치 시 반드시 숙지해야 하는 중요한 정보
- 참고 사항 : 설치 관련하여 영향을 미치는 특별한 사용자 환경 및 상황에 대한 내용
환경 체크 목록
사용자 환경 : 사용자의 CPU, Memory, OS 등의 적합 환경
응용 프로그램 : 설치 전 다른 응용 프로그램의 종료
업그레이드 버전 : 업그레이드 이전 버전에 대한 존재 유무 확인
백업 폴더 확인 : 데이터 저장 폴더를 확인하여 설치 시 폴더 동기화
구성요소
제품 소프트웨어 개요
- 제품 소프트웨어의 주요 기능 및 UI 설명
- UI 및 화면 상의 버튼, 프레임 등을 도식화하여 설명
설치 관련 파일
- 제품 소프트웨어를 설치하기 위한 관련 파일 설명
- 설치 구동을 위한 exe 실행
- ini나 log 파일 같은 관련 파일
설치 절차
- 소프트웨어 설치 방법을 순서대로 상세히 설명
설치 아이콘
- Windows 구동용 설치 아이콘 설명
프로그램 삭제
- 해당 소프트웨어 삭제 시 원래대로 삭제하는 방법을 설명
설치 환경
- CPU, Memory, OS 등 환경 설명
설치 버전 및 작성자
- 소프트웨어 릴리즈 버전 및 작성자 정보
고객 지원 방법 및 FAQ
- 실제 설치 시 자주 발생하는 어려움들을 FAQ로 정리
- 유선 및 E-mail, Website URL
작성 순서
기능 식별
UI 분류
설치 파일 & 백업 파일 확인
Uninstall 절차 확인
이상 Case 확인
최종 매뉴얼 적용
사용자 매뉴얼
개요
개발이 완료된 제품 소프트웨어를 고객에게 전달하기 위한 형태로 패키징하고, 설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용을 포함하는 매뉴얼
개발된 컴포넌트 사용 시에 알아야 할 내용을 기술하며 패키지의 기능, 패키지의 인터페이스, 포함하고 있는 메서드나 오퍼레이션과 메서드의 파라미터 등의 설명이 포함
작성 절차
작성 지침 정의
사용자 매뉴얼 구성 요소 정의
구성 요소별 내용 작성
사용자 매뉴얼 검토
작성 항목
목차 및 개요
- 매뉴얼 전체의 내용을 순서대로 요약
- 제품 소프트웨어의 주요 특징에 대해 정리
- 사용자 매뉴얼에서의 구성과 실행 방법, 메뉴에 대한 설명을 비롯하여 사용법, 각 항목에 따른 점검 기준, 그리고 설정 방법 등에 대해 기술
문서 이력 정보
- 사용자 매뉴얼 변경 이력 정보
주석
- 주의 사항 : 사용자가 반드시 숙지해야하는 중요한 정보
- 참고 사항 : 특별한 사용자 환경 및 상황에 대한 내용의 주석 표시
기록 항목
- 제품 명칭, 모델명, 기록 항목에 대한 문서 번호, 제품 번호, 구입 날짜 등을 기재
기본 사항
- 소프트웨어 개요, 사용방법, 모델 & 버전 별 특징, 기능 및 인터페이스 특징, 구동 환경 등을 기재
고객 지원 방법 및 FAQ
- 소프트웨어 사용 시 자주 발생하는 어려움들을 FAQ로 정리
- 유선 및 E-mail, Website URL
준수 정보 & 제한 보증
- 시리얼 보존, 불법 등록 사용금지 등의 준수 사항 권고
- 저작권 정보 관련 작성
국제 표준 제품 품질 특성
- 소프트웨어 개발 공정 각 단계에서 산출되는 제품이 사용자 요구를 만족하는지 검증하기 위한 국제 표준
소프트웨어
ISO / IEC 9126
- 소프트웨어 품질의 특성 및 품질평가 메트릭 정의
품질 특성
9126-1 : 품질 모델
9126-2 : 외부 품질
9126-3 : 내부 품질
9126-4 : 사용 품질
기능성 | Functionality
- 사용자가 요구한 조건이 정확히 동작하는가에 대한 능력
- 부특성 : 적합성, 정확성, 상호 운용성, 보안성, 준수성
신뢰성 | Reliability
- 기능을 수행할 때, 오류나 오차가 없이 일관된 결과가 도출 되는 능력
- 부특성 : 성숙성, 결함 허용성, 복구성
효율성 | Efficiency
- 기능을 수행할 때 적절한 자원(CPU, Memory)을 활용하는 능력
- 부특성 : 시간 반응성, 자원 활용성, 준수성
유지보수성 | Maintainability
- 변경 및 오류 수정이 쉽게 될 수 있는 능력
- 부특성 : 분석성, 변경성, 안정성, 시험성, 준수성
이식성 | Portability
- 현재 운영되는 환경에서 다른 환경으로 이전이 용이한 능력
- 부특성 : 적응성, 설치성, 공존성, 대체성, 준수성
ISO / IEC 14598
ISO / IEC 9126 기반 사용 절차
소프트웨어 제품의 품질을 측정하거나 평가하기 위한 방법과 절차를 규정
평가 특성
14598-1 : 개요
14598-2 : 계획과 관리
14598-3 : 개발자용 프로세스
14598-4 : 구매자용 프로세스
14598-5 : 평가자용 프로세스
14598-6 : 평가 모듈 및 문서화
반복성 | Repeatability
- 특정 제품에 대해 동일 평가자가 동일 사양에 대해 평가 했을 때 동일한 결과가 나와야 함
재현성 | Reproducibility
- 특정 제품에 대해 다른 평가자가 동일 사양에 대해 평가 했을 때 동일하다고 여길 수 있는 결과가 나와야 함
공정성 | Impartiality
- 평가가 특정 결과에 편향되지 않아야 함
객관성 | Objectivity
- 평가 결과가 평가자의 감정이나 의견에 의해 영향을 받지 않아야 함
ISO / IEC 12119
- 패키지 SW 품질 요구사항 및 테스트
구성 요소
소프트웨어 패키지
제품 설명서
- 소프트웨어 패키지의 속성을 설명하는 문서
- 제품 구입에 앞서 제품이 필요한지를 평가할 수 있는 정보 제공
사용자 문서
- 인쇄 또는 비인쇄 형태의 사용 가능한 전체 문서들의 집합
실행 프로그램
- 요구사항이 명확하게 정의된 대상
ISO / IEC 25000
S/W 품질 평가 통합 모델
ISO 9126과 소프트웨어 평가절차 모델 ISO 14598을 통합
평가 모델
ISO / IEC 2500n
- 품질 일반 부분
- 2500 안내서
- ISO / IEC 14598-2 통합
ISO / IEC 2501n
- 품질 모델
- ISO / IEC 9126-1 통합
- 소프트웨어 품질 특성을 다룸
ISO / IEC 2502n
- 품질 측정 부분
- ISO / IEC 9126-2, 3, 4 통합
- 내부 측정, 외부 측정, 사용품질 측정, 품질 측정 요소
ISO / IEC 2503n
- 품질 요구사항 부분
- ISO / IEC 14598 통합
- 개발자 관점, 구매자 관점, 평가자 관점
프로세스
소프트웨어 개발 프로세스 등 소프트웨어 관련 업체의 프로세스 관리능력을 평가하고 프로세스를 개선하는 데 활용할 수 있는 표준
미국이 1987년 S/W 프로세스 성숙도(maturity)를 평가하기 위한 기준인 SW-CMM(Software Capability Maturity Model)을 제정하여 보급해 온 이래 국제표준화기구(ISO)도 관련 표준의 제정을 추진해 오고 있음
ISO / IEC 9001
- 조직의 품질 경영 및 품질 보증
ISO / IEC 12207
- 소프트웨어 개발 관련 생명주기
| 생명주기 프로세스 | 세부 프로세스 |
|---|---|
| 기본 | 획득, 공급, 개발, 운영, 유지보수 |
| 지원 | 문서화, 형상관리, 품질보증, 검증, 확인, 합동검토, 감사, 문제해결 |
| 조직 | 관리, 기반구조, 개선, 교육훈련 |
ISO / IEC 15504 | SPICE
ISO에서 표준으로 지정된 프로세스 수행능력 평가 표준 프레임워크
소프트웨어 개발 관련해 선정된 프로세스 평가 모델
| 수준 | 단계 | 설명 | |
|---|---|---|---|
| 0 | 불안정 단계 | Incomplete | 미구현 또는 목표 미달성 |
| 1 | 수행 단계 | Performed | 프로세스 수행 및 목적 달성 |
| 2 | 관리 단계 | Managed | 프로세스 수행 계획 및 관리 |
| 3 | 확립 단계 | Established | 표준 프로세스의 사용 |
| 4 | 예측 단계 | Predictable | 프로세스의 정량적 이해 및 통제 |
| 5 | 최적화 단계 | Optimizing | 프로세스의 지속적인 개선 |
CMM | Capability Maturity Model
소프트웨어 개발 업체들의 업무능력평가 기준을 세우기 위한 평가 모형
1991년 미국 국방부의 의뢰를 받아 카네기멜론 대학이 만든 평가 모델
소프트웨어 개발 능력 측정 기준과 소프트웨어 개발 조직의 성숙도 수준을 평가
조직의 소프트웨어 개발 관련 전체 프로세스 평가
| 수준 | 단계 | 설명 | |
|---|---|---|---|
| 1 | 초기 단계 | Initial | - 소프트웨어를 개발하고 있으나 관리는 하고 있지 않은 상태- 프로세스의 성과를 예측할 수 없는 상태 |
| 2 | 반복 단계 | Repeatable | - 이전의 성공적인 프로젝트의 프로세스를 반복하고 있는 상태- 같은 것을 반복적으로 실행하며 어느 정도의 통계적 관리가 가능한 상태 |
| 3 | 정의 단계 | Defined | - 프로세스 작업이 잘 정의 & 이해되고, 프로세스 데이터에 의한 프로젝트 관리도 실행하고 있는 상태- 프로세스의 기초가 정립되어 계속 진보되고 있는 상태 |
| 4 | 관리 단계 | Managed | - 프로세스 성과를 측정 & 분석하여 개선시키고, 이를 바탕으로 관리하고 있는 상태- 정량적 프로세스 관리, 소프트웨어 품질 관리 |
| 5 | 최적화 단계 | Optimizing | 질적 & 양적으로 지속적인 개선이 이루어지고 있는 상태 |
CMMI | Capability Maturity Model Integration
시스템과 소프트웨어 영역을 하나의 프로세스 개선 툴로 통합시켜 기업의 프로세스 개선 활동에 광범위한 적용성을 제공하는 모델
소프트웨어, 시스템, 프로덕트를 포함하는 세 분야를 통합 평가하는 모델
다양한 CMM 모델을 통합한 프로세스 개선 프레임워크
| 수준 | 단계 | 설명 | |
|---|---|---|---|
| 1 | 초기 단계 | Initial | 구조화된 프로세스를 갖고 있지 않은 조직 |
| 2 | 관리 단계 | Managed | - 기본적인 프로세스를 갖고 있는 조직- 기본 프로세스에 따라 업무가 수행되고 기본적인 관리 활동들로부터 구체적인 특정 영역으로 프로세스의 체계가 확대 발전하는 조직 |
| 3 | 정의 단계 | Defined | 조직 차원의 표준 프로세스를 보유하고 있으며 프로젝트를 수행할 경우 프로젝트의 특성에 따라 적절하게 조정하여 사용 |
| 4 | 정량적 관리 단계 | Quantitatively Managed | 프로세스들을 톨계적이고 정량적으로 관리하는 조직 |
| 5 | 최적화 단계 | Optimizing | 질적 & 양적으로 지속적인 개선이 이루어지고 있는 상태 |