제품 소프트웨어 메뉴얼 작성
▼소프트웨어 매뉴얼
★소프트웨어 매뉴얼 개념
제품 소프트웨어 개발 단계부터 적용한 기준이나 패키징 이후 설치와 사용자 측면의 주요 내용 등을 기록한 문서로 설치 매뉴얼과 사용자 매뉴얼로 구분한다.
★소프트웨어 설치 매뉴얼
소프트웨어 실사용자가 제품을 최초 설치 시 참조하는 매뉴얼이며, 제품 소프트웨어 소개, 설치 파일, 설치 절차 등이 포함된다. 설치 과정에서 표시될 수 있는 예외 상황에 관련 내용을 별도로 구분하여 설명한다.
설치 시작부터 완료할 떄까지의 전 과정을 빠짐없이 순서대로 설명한다. 설치 매뉴얼은 사용자 기준으로 작성되며, 목차, 개요, 기본사항 등이 기본적으로 포함되어야 한다.
★소트프웨어 설치 매뉴얼 구성
| 목차 및 개요 | 작성하는 매뉴얼 전체 내용을 순서대로 요약하여 작성한다. 설치 매뉴얼의 주요 특징, 구성과 설치 방법, 순서등에 대해 기술한다. |
| 문서 이력 정보 | 매뉴얼 변경 이력에 대한 정보를 버전별, 시간순으로 작성한다. |
| 설치 매뉴얼 주석 | 주의사항: 사용자가 제품 설치 시 반드시 숙지해야 하는 중요한 정보 주석으로 안내를 작성한다. 참고사항: 설치 관련하여 영향을 미치는 특별한 사용자 환경 및 상황에 대한 내용 주석으로 안내를 작성한다. |
| 설치 도구의 구성 | exe/dll/ini/chm 등 해당 설치 관련 파일에 대한 안내를 작성한다. 폴더 및 설치 프로그램 실행 파일에 대한 안내를 작성한다. |
| 설치 위치 지정 | 설치 홀더와 설피 프로그램 실행 파일을 설정한다. |
★소프트웨어 설치 매뉴얼 기본 사항
제품 소프트웨어 개요, 설치 관련파일, 설치 아이콘, 프로그램 삭제, 관련 추가 정보.
★ 소프트웨어 설치 환경 체크 항목
사용자 환경, 설치 시 실행 중인 다른 프로그램 종료 확인, 업그레이드 버전 존재 여부 확인, 백업 폴더 확인
★소프트웨어 설치 매뉴얼 작성프로세스
▼소프트웨어 사용자 매뉴얼
★사용자 매뉴얼
소프트웨어 설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용을 포함하는 매뉴얼을 작성하며, 제품 소프트웨어에 대한 패치 개발 과 업그레이드를 위한 버전 관리를 수행한다. 소프트웨어 사용 방법을 기술하며 패키지의 기능 패키지의 인터페이스를 포함하고 있는 메소드나 오퍼레이션과 메소드의 파라미터 등의 설명이 포함되어야 한다.
★사용자 매뉴얼 구성
| 사용자 화면 및 UI | 주의사항: 사용자가 반드시 숙지해야 하는 중요한 정보를 작성한다. 참고 사항: 특별한 사용자 환경 및 상황에 대한 예외사항을 작성한다. |
| 주요 기능 분류 | 설명할 기능을 포함할 화면을 스크린샷하여 작성한다. 동작하는 기능을 화면의 순서대로 차례로 분류하여 작성하며, 기능 동작 시 참고사항, 주의 사항 등을 메모로 추가한다. |
| 웅용 프로그램/ 설정 | 제품 실행 시 영향을 받거나 주는 스프트웨어에 대하여 설명한다. 동작시 사전에 실행해야할 소프트웨어가 있다면 기술하고, 동작에 필요한 기본 설정과 기본 설정값을 안내한다. |
| 장치 연동 | 제품 소프트웨어가 Embedded(장치 내에 내장) 관련된 제품일 경우 해당 장치에 어떤 것이 있는지와 연동되는 장치에 어떤 것이 있는지와 연동되는 장치에는 무엇이 있는지 설명한다. |
| 네트워크 환경 | 제품 소프트웨어와 관련한 네트워크 정보를 표시 하고 네트워크에 정상 연결되었는지 이를 위한 설정 값은 무엇이 있는 지 설명한다. |
| 프로필 설명 | 제품 소프트웨어 구동시 체크하는 환경파일이므로 환경파일의 경로 변경, 이동을 금지하는 인내를 설명한다. 구동 시, 필요한 필수 파일의 내용을 간략히 설명한다. |
| 고객지원 방법 | 설치 및 사용에 관련된 기술적 지원을 받을 수 있는 유선, 이메일, 폼페이지 등의 정보를 기재한다. |
| 준수 정보 및 제한 보증 | 시리얼 코드를 불법등록 사용하지 못하도록 준수 사항을 안내한다. 저작권자의 지적 재산권, 허가권, 통신 규격, 개발 언어, 연동 프로그램, 문서효력 등의 정보를 안내한다. |
★사용자 매뉴얼 작성 프로세스
작성 지침 정의 -> 구성 요소 정의 -> 구성 요소별 내용 작성 -> 사용자 매뉴얼 검토
★소프트웨어 국제 표준 품직 특성
- IT 프로젝트를 진행하거나, 완성된 IT 제품에 대해 기능성, 신뢰성 등을 평가하는 기준이 되는 국제 표준
- ISO/IEC 9126은 품질 특성 및 측정 기준을 정의하고 있는 표준으로 1991년에 제정된 후 1994년부터 품질 특성과 내부 품질과 외부 품질을 조정하고, 품질 측정 절차를 별도의 ISO/IEC 14598 표준으로 분리함
| 품질 표준 | 설명 |
| ISO/IEC 9126 | - ISO/IEC 9126의 품질 모델은 소프트웨어 품질을 측정하고, 평가하기 위해서 소프트웨어의 품질 요소와 특성을 정의 - 품질 특성을 기능성, 신뢰성, 사용성, 효율성, 유지보수성, 이식성으로 나눔 |
| ISO/IEC 14598 | - 소프트웨어 제품 평가 프로세스 및 평가 모듈을 제공 - 패키지 소프트웨어와 SI 개발 소프트웨어에 있어서 개발 과정 또는 개발이 완료된 제품의 품질에 대한 평가 표준과 프로세스를 제공 |
| ISO/IEC 12119 | - 소프트웨어 패키지 제품에 대한 품질 요구사항 및 테스트 국제 표준 - 대상 : 제품 설명서, 사용자 문서, 실행 프로그램 |
| ISO/IEC 25000 | - SQuaRE로도 불리며, ISO/IEC 9126과 ISO/IEC 14598, ISO/IEC 12119를통합하고, ISO/IEC 15288을 참고한 소프트웨어 제품 품질에 대한 통합적인 국제표준 - 개발 공정 각 단계에서 산출되는 제품이 요구사항을 만족하는지 검증하기 위해 제품 품질 측정 및 평가를 위한 모델 |
출처: https://computer-science-student.tistory.com/137
국제 제품 품질 표준
국제 제품 품질 표준 IT 프로젝트를 진행하거나, 완성된 IT 제품에 대해 기능성, 신뢰성 등을 평가하는 기준이 되는 국제 표준 ISO/IEC 9126은 품질 특성 및 측정 기준을 정의하고 있는 표준으로 1991
computer-science-student.tistory.com
ISO/IEC 9126의 소프트웨어 품질 특성
- 기능성, 신뢰성, 사용성, 효율성, 유지보수성, 이식성이 있다.
ISO/IEC 14598의 소프트웨어 품질 특성
- 개발자에 대한 소프트웨어 제품 품질 향상과 구매자의 제품 품질 선정 기준을 제공하는 표준으로 주요 특성은 반복성, 재현성, 공정성, 객관성이 있다.
- 소프트웨어 품질 측정을 위해 개발자 관점에서 고려해야 할 항목은 정확성, 신뢰성, 효율성, 무결성, 유연성, 이식성, 재사용성, 상호운용성이다.
국제 프로세스 품질 표준
IT 프로젝트를 진행하거나 IT를 운영함에 있어 프로세스가 수립되어 있고 체계적으로 운용되고 있는지를 평가하는 기준이 되는 국제 표준이다.
- ISO/IEC 9001, ISO/IEC 12207, ISO/IEC 15504(SPICE), CMMi
★소프트웨어 품질목표
Correctness(정확성) : 사용자의 요구기능을 충족시키는 정도
Reliability(신뢰성) : 요구된 기능을 오류없이 수행하는 정도
Efficiency(효율성) : 요구된 기능을 수행하기 위한 시스템능력과 필요한 자원의 소요정도
Portability(이식성) : 다양한 하드웨어 환경에서도 운용 가능하도록 쉽게 수정할 수 있는 정도
Integrity(무결성) : 허용되지 않는 사용이나 자료의 변경을 제어하는 정도
Usability(유용성) : 쉽게 사용할 수 있는 정도
Flexibility(유연성) : 새로운 요구사항에 맞게 얼마만큼 쉽게 수정할 수 있는지의 정도
Reusability(재사용성) : 이미 만들어진 프로그램을 다른 목적으로 사용할 수 있는지의 정도
Interoperability(상호운용성) : 다른 소프트웨어와 정보를 교환할 수 있는 정도
▼릴리즈 노트 작성하기
★릴리즈 노트(Release Note)
애플리케이션 최종 사용자인 고객에게 제공하는 정리된 배포 문서이며 애플리케이션 릴리즈 노트에는 상세 서비스를 포함하여 수정/변경된 문서이다. 사용자에게 최종 배포된 릴리즈 노트를 보면 테스트가 어떻게 진행되는지, 개발팀의 제공 사양을 얼마나 준수했는지를 확인해 볼 수 있다. 전체적인 버전 관리 및 릴리즈 정보를 체계적으로 관리할 수 있다.
릴리즈 노트는 현재 시제로 개발팀에서 직접 작성하여야 하며, 명확하고 정확하고 완벽한 정보를 제공해야하며, 개발자와 테스터가 함꼐 협업해야하고 최초 및 변경, 개선 항목까지 연결되어 다음 항목에 대한 정보들이 릴리즈 노트를 통해 작성되어야 한다.
★ 릴리즈 노트 작성 항목
| Header | 릴리즈 노트 이름, 소프트웨어 이름, 릴리즈 버전, 릴리즈 날짜, 릴리즈 노트 날짜, 릴리즈 노트 버전 등 |
| 개요 | 소프트웨어 및 변경사항 전체에 대한 간략한 내용 |
| 목적 | 해당 릴리즈 버전에서의 새로운 기능이나 수정된 기능의 목록과 릴리즈 노트의 목적에 대한 간략한 개요 |
| 문제 요약 | 수정된 버그에 대한 간략한 설명 또는 릴리즈 추가 항목에 대한 요약 |
| 재현 항목 | 버그 발견에 대한 과정 설명 |
| 수정/개선 내용 | 버그를 수정/개선한 내용을 간략히 설명 |
| 사용자 영향도 | 사용자가 다른 기능들을 사용하는데 있어 해당 릴리즈 버전에서의 기능 변화가 미칠 수 있는 영향에 대한 설명 |
| SW 지원 영향도 | 해당 릴리즈 버전에서의 기능 변화가 다른 응용 프로그램들을 지원하는 프로세스에 미칠 수 있는 영향에 대한 설명 |
| 노트 | SW/HW 설치 항목, 업그레이드, 소프트웨어 문서화에 대한 참고 항목 |
| 면책 조항 | 회사 및 소프트웨어와 관련하여 참조할 사항 |
| 연락처 | 사용자 지원 및 문의 응대를 위한 연락처 정보 |
★릴리즈 노트 작성순서
1) 모듈 식별
- 모듈벌 빌드 수행 후 릴리즈 노트에 작성될 내용 확인
2) 릴리즈 정보 확인
- 릴리즈 노트 이름, SW 이름, 릴리즈 버전 및 날짜, 노트 날짜 및 버전 등 확인
3) 릴리즈 노트 개요 작성
- 소프트웨어 및 변경사항 전체에 대한 간략한 내용 작성
4) 영향도 체크
- 버그/이슈 관련 내용 또는 해당 릴리즈 버전에서 기능 변화가 다른 소프트웨어나 기능을 사용하는데 미칠 수 잇는 영향에 대해 기술
5) 정식 릴리즈 노트 작성
- Header, 개요 영향도 체크 항목을 포함하여 정식 릴리즈 노트 작성
6) 추가 개선 항목 식별
- 추가 버전 릴리즈 노트 작성이 필요한 경우, 작성