제품 소프트웨어 매뉴얼 개념 및 작성 항목

소프트웨어의 매뉴얼은 제품 소프트웨어 개발 단계부터 적용한 기준이나 패키징 이후 설치 및 사용자 측면의 주요 내용 등을 문서로 기록한 것이다. 사용자 중심의 기능 및 방법을 나타낸 설명서와 안내서를 의미한다. 제품 소프트웨어 매뉴얼은 설치 매뉴얼과 사용자 매뉴얼이  있다. 제품 소프트웨어 설치 매뉴얼은 사용자가 제품을 구매한 후 최초 설치 시 참조하는 매뉴얼이다. 설치 과정에서 표시될 수 있는 예외상황에 관련 내용을 별도로 구분하여 설명한다. 설치 시작부터 완료할 때까지의 전 과정을 빠짐없이 순서대로 설명한다. 제품 소프트웨어 설치 매뉴얼 기본 작성 항목을 목차 및 개요, 문서 이력 정보, 설치 매뉴얼 주석, 설치 도구의 구성, 설치 위치 지정이 있다. 목차 및 개요의 대한 설명. 매뉴얼 전체 내용을 순서대로 요약한다. 설치 매뉴얼의 주요 특징, 구성과 설치 방법, 순서 등에 대해 기술한다. 문서 이력 정보는 매뉴얼 변경 이력에 대한 정보를 번전별로 표시하는 것이다. 설치 매뉴얼 주석은 사용자가 제품 설치 시 반드시 숙지해야 하는 중요한 정보 주석을 표시하는 '주의 사항'과 설치 관련하여 영향을 미치는 특별한 사용자 환경 및 상황에 대한 내용을 주석 표시하는 '참고 사항'이 있다. 설치 도구의 구성은 exe/ dll/ ini/ chm 등 해당 설치 관련 파일을 설명하고 폴더 및 설치 프로그램 실행 파일을 설명하는 것이다. 설치 위치 지정은 설치 폴더와 설치 프로그램 실행 파일을 설명하는 것이다. 설치를 위한 환경 체크 항목은 사용자 환경 (CPU 및 메모리, 운영체제 등의 적합 환경 확인), 응용 프로그램 (설치 전 다른 응용 프로그램의 종료 확인), 업그레이드 버전 (업그레이드 이전 버전에 대한 존재 유무 확인), 백업 폴더 확인 (데이터 저장 폴더를 확인하여 설치 시 폴더 동기화)이 있다. 제품 소프트웨어 설치 매뉴얼은 설치 방법을 순서대로 상세하게 설명할 수 있도록 설치 화면을 캡처하여 사용자가 이해하기 쉽도록 구성한다. 설치 실행 시 표시되는 내용 및 안내 창에 대한 메시지를 설명한다. 제품 소프트웨어 설치 매뉴얼 구성요소에는 제품 소프트웨어 개요, 설치 관련 파일, 설치 절차, 설치 아이콘, 설치 버전 및 작성, 고객 지원 방법 및 FAQ, 준수 정보 & 제한 보증이 있다. 정상 설치 완료 시 최종 정상 설치 완료 메시지 출력과 사용자 안내를 출력함으로써 설치가 잘 되었음을 통지한다. 제품 소프트웨어 설치 매뉴얼 작성 프로세스는 개요 및 기능 식별, UI 문류, 설치 파일/백업 파일 확인, 삭제 절차 확인, 이상 유형 확인, 최종 매뉴얼 적용 순의 절차로 구성되어 있다. 제품 소프트웨어 사용자 매뉴얼은 개발이 완료된 제품 소프트웨어를 고객에게 전달하기 위한 형태로 패키징하고, 설치와 사용에 필요한 제반 절차 및 환경 등 전체 내용을 포함하는 문서이다. 제품 소프트웨어 사용자 매뉴얼에는 개발된 컴포넌트 사용 시에 알아야 할 내용을 기술하며 패키지의 기능, 패키지의 인터페이스, 포함하고 있는 메서드나 오퍼레이션과 메서드의 파라미터 등의 설명이 포함되어 있다. 파라미터란 매개변수를 뜻하는 말로 메서드 수행에 필요한 입력값을 저장하는 변수이다. 제품 소프트웨어 사용자 매뉴얼 작성 항목에는 목차 및 개요, 문서 이력 정보, 사용자 매뉴얼 주석, 기록항목, 기본사항, 고객 지원 방법 및 FAQ, 준수 정보 & 제한 보증이 있다. 제품 소프트웨어 기본사항에는 개요, 사용방법, 관리방법, 모델, 버전별 특징, 기능, 인터페이스 특징, 구동환경 등이 있다. 고객 지원 방법 및 FAQ에는 설치와 관련해 기술적인 지원이나 제품 서비스를 받을 수 있는 유선, 이메일, 홈페이지 주소를 넣고 설치 시에 자주 발생하는 오류 및 처리방법에 대한 요약 설명이 들어간다. 준수 정보 & 제한 보증은 저작권 정보 관련 사항을 작성하고 시리얼 보존, 불법 사용 금지 등의 준수 사항을 권고하는 내용을 넣는다. 제품 소프트웨어 사용자 매뉴얼은 사용자가 이해하기 쉽도록 화면을 캡처하여 구성하고, 주요 기능에 대해서는 설명 화면을 첨부한다. 제품 소프트웨어 동작 시 함께 동작하는 애플리케이션이나 설치되어 충돌될 수 있는 응용 프로그램에 대해 설명한다. 제품 소프트웨어 사용자 매뉴얼 작성 프로세스는 명세서나 구현 설계서로부터 아래와 같은 단계를 거쳐 최종 작성된다. 작성 지침 정의, 사용자 매뉴얼 구성요소의 정의, 구성요소별 내용 작성, 사용자 매뉴얼 검토 순이다. 작성 지침 정의란 사용자 매뉴얼을 작성하기 위하여 지침을 설정하고 실제 사용자 환경에 필요한 정보를 제공할 수 있도록 작성하는 것이다. 사용자 매뉴얼 구성요소 정의는 제품 소프트웨어의 기능, 구성 객체 목록, 객체별 메서드, 메서드의 파라미터, 실제 사용 예제, 사용 환경 세팅 방법 등의 사용자 매뉴얼 구성요소를 정의하는 단계이다. 구성요소별 내용 구성은 제품 소프트웨어 구성요소별로 내용을 작성한다. 사용자 매뉴얼 검토는 작성된 사용자 매뉴얼이 개발된 제품의 기능을 제대로 설명하는지, 제품 사용 시에 부족한 정보가 없는지 등을 검사하고 해당 기능별 관련 개발자와 함께 기능 내용이나 인터페이스, 메서드, 메서드의 파라미터 등을 검토한다. 또 점검 사항을 반영하여 사용자 지침서를 수정하고 보완하는 단계이다. 다음 포스팅에서는 국제 표준 제품 품질 개념과 특성에 대해 다루어 보도록 하겠다.