049 소프트웨어 사용자 매뉴얼 작성 - 3장 제품 소프트웨어 패키징 - 2과목 소프트웨어 개발

1. 소프트웨어 사용자 매뉴얼 개요

- 사용자가 소프트웨어를 사용하는 과정에서 필요한 내용을 문서로 기록한 설명서

- 소프트웨어에 필요한 절차, 환경 등을 포함해 작성

- 배포 후 발생될 수 있는 오류에 대한 패치나 기능에 대한 업그레이트를 위한 매뉴얼 버전 관리

- 개별적으로 동작이 가능한 컴포넌트 단위로 매뉴얼 작성

- 컴포넌트 명세서와 컴포넌트 구현 설계서를 토대로 작성

-> 컴포넌트 명세서 - 컴포넌트의 개요 및 내부 클래스의 동작, 외부와의 통신 명세 등을 정의 함

-> 컴포넌트 구현 설계서 - 구현에 필요한 컴포넌트 구조도, 컴포넌트 목록, 인터페이스 명세로 구성

 

2. 서문

- 문서 이력, 사용자 매뉴얼의 주석, 기록 보관을 위해 필요한 내용을 기술

- 사용자 매뉴얼의 주석 : 주의 사항과 참고 사항을 기술한다

- 주의 사항 : 사용자가 반드시 알아야 하는 중요한 내용

- 참고 사항 : 특별한 사용자의 환경이나 상황에 대한 내용

- 기록 보관 내용 : 기술 지원이나 추가 정보를 얻기 위한 소프트웨어 등록 정보

                          : 소프트웨어 등록시 필요한 정보는 소프트웨어 명칭, 모델명, 문서 번호, 제품 번호, 구입 날짜 등이다.

 

3. 기본 사항

1. 소프트웨어 개요 

- 소프트웨어의 주요 기능 및 UI 설명

- UI 및 화면 상의 버튼, 프레임 등을 그림으로 설명

2. 소프트웨어 사용 환경 

- 소프트웨어 사용을 위한 최소 환경 설명

- CPU, 메모리 등의 PC 사양, 운영체제 버전 설명

- 최초 구동에 대한 설명

- 소프트웨어 사용 시 발생할 수 있는 충동이나 개인정보, 보안 주의사항

3. 소프트웨어 관리

- 소프트웨어의 사용 종료 및 관리 등에 관한 내용 설명

4. 모델, 버전별 특징 

- 모델 및 버전별로 UI 및 기능의 차이점을 요약

5. 기능, 인터페이스 특징

- 제품 기능과 인터페이스 특징을 요약

6. 소프트웨어 구동 환경

- 호환 가능 운영체제 설명

 

4. 사용자 매뉴얼 작성 방법

- 사용자가 사용 방법을 이해하기 쉽도록 상황별로 캡처해서 설명

- 사용자 화면, 주요 기능 분류, 응용 프로그램 및 설정, 장치 연동, 네트워크 환경, 프로파일 안내, 고객 지원 방법, 준수 정보 및 제한 보증 등에 대한 내용 기술

 

5. 사용자 매뉴얼 작성 순서

1. 작성 지침 정의

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

3. 구성 요소별 내용 작성

4. 사용자 매뉴얼 검토