[2과목-3장-045] 소프트웨어 사용자 매뉴얼 작성

사용자가 SW를 사용하는 과정에서 필요한 내용을 문서로 기록한 설명서와 안내서

- SW 사용에 필요한 제반 사항이 모두 포함되도록 작성

- 배포 후 발생 가능한 오류에 대한 패치 or 기능 업그레이드를 위해 매뉴얼 버전을 관리함

- 컴포넌트 단위로 매뉴얼 작성

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

- 목차 및 개요, 서문, 기본 사항 등이 기본적으로 포함돼야 함

- 목차) 전체 내용 순서대로 요약 > 관련 내용 시작 페이지 함께 기술

- 개요) SW 주 특징, 매뉴얼 구성과 실행 방법, 사용법, 항목별 점검 기준, 항목별 설정 방법 등의 내용 기술

 

1. 서문

1) 문서 이력

2) 사용자 매뉴얼의 주석

(1) 주의 사항

(2) 참고 사항

3) 기록 보관 내용

- 필요 기술 지원 or 소프트웨어 등록 정보 기술

- 등록 시 필요한 정보: SW 명칭, 모델명, 문서 번호, 제품 번호, 구입 날짜 등

 

2. 기본 사항

1) 소프트웨어 개요

2) 소프트웨어 사용 환경

3) 소프트웨어 관리

4) 모델, 버전별 특징

5) 기능, 인터페이스의 특징

6) 소프트웨어 구동 환경

 

3. 작성 방법

1) 사용자 화면 및 UI

(1) 주의 사항

(2) 참고 사항

2) 주요 기능 분류

3) 응용 프로그램 및 설정

- SW 구동 시 함께 실행해도 되는 응용 프로그램 or 실행하면 안되는 응용 프로그램에 대해 설명

- 먼저 실행되어야 할 응용 프로그램 있다면 설명

- 설정, 기본값에 대해 설명

4) 장치 연동

- SW가 특정 장치에 내장되는 경우 > 연동되는 장치에 대해 설명

5) Network 환경

- Network에 정상적인 연결을 위한 설정값 등 설명

6) Profile 안내

- Profile: SW 구동 환경을 점검하는 파일

- 외의 구동에 필수적인 파일들에 대해 설명

7) 고객 지원 방법

8) 준수 정보 & 제한 보증

 

4. 작성 순서

1) 기능 식별

2) 사용자 화면 분류

3) 사용자 환경 파일 확인

4) 초기화 절차 확인

5) 이상 Case 확인

6) 최종 매뉴얼 적용