제품 소프트웨어 패키징 매뉴얼 작성 및 버전 등록 2/4

제품 소프트웨어 패키징 매뉴얼 작성 및 버전 등록

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

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

• 사용자가 소프트웨어 사용에 필요한 내용, 제반 절차, 환경 등의 내용을 포함하는 문서

제품 소프트웨어 사용자 매뉴얼 작성 항목

1. 목차 및 개요

• 매뉴얼 전체 내용을 순서대로 요약
• 제품 소프트웨어의 주요 특징 정리
• 사용자 매뉴얼에서의 구성과 실행 방법, 메뉴에 대한 설명을 비롯하여 사용법, 각 항목에 따른 점검 기준, 설정 방법 등에 대해 기술

2. 문서 이력 정보

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

3. 사용자 매뉴얼 주석

• 주의 사항 : 사용자가 반드시 숙지해야 하는 중요한 정보의 주석 표시
• 참고 사항 : 특별한 사용자 환경 및 상황에 대한 내용의 주석 표시

4. 기록 항목

• 제품 명칭, 모델명, 문서 번호, 제품 번호 등의 기록 항목이 있음

5. 기본사항

• 제품 소프트웨어 기본사항에는 개요, 사용 방법 및 관리 방법, 모델, 버전별 특징, 제품 소프트웨어 기능 및 인터페이스 특징, 구동 환경 등이 있음

6. 고객 지원 방법 및 FAQ

• 설치 관련하여 기술적인 지원이나 제품 서비스를 받을 수 있는 유선 및 이메일, 홈페이지 주소
• 설치 시 자주 발생하는 오류 및 처리 방법에 대한 요약 설명

7. 준수 정보 & 제한 보증

• 시리얼 보존, 불법 사용 금지 등의 준수 사항 권고
• 저작권 정보 관련 사항 작성

제품 소프트웨어 사용자 매뉴얼 작성 프로세스

1. 작성 지침 정의

• 사용자 매뉴얼을 작성하기 위한 지침 설정
• 사용자 매뉴얼은 실제 사용자 환경에 필요한 정보를 제공할 수 있는 형태로 작성

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

• 제품 소프트웨어의 기능, 구성 객체 목록, 객체별 메서드, 파라미터, 실제 사용 예제, 사용자 환경 세팅 방법 등 사용자 매뉴얼 구성요소를 정의

3. 구성 요소별 내용 작성

• 제품 소프트웨어 구성 요소별로 내용 작성

4. 사용자 매뉴얼 검토

• 작성된 사용자 매뉴얼이 개발된 제품의 기능을 제대로 설명하는지, 제품 사용 때 부족한 정보가 없는지 등을 검사
• 해당 기능별 관련 개발자와 함께 기능 내용이나 인터페이스, 메서드나 메서드의 파라미터 등을 검토
• 점검 사항을 반영하여 사용자 지침서 수정, 보완