[2과목-3장-044] 소프트웨어 설치 매뉴얼 작성

개발 초기에서부터 적용된 기준 or 사용자가 SW를 설치하는 과정에 필요한 내용을 기록한 설명서와 안내서

- 사용자 기준으로 작성

- 전 과정을 빠짐없이 순서대로 설명

- 오류 메시지 및 예외 상황에 대한 내용을 별도로 분류하여 설명

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

- 목차) 전체 설치 과정 요약, 관련 내용 시작 페이지 함께 기술

- 개요) 주요 특징, 구성, 설치 방법 순서 등 기술

 

1. 서문

1) 문서 이력

2) 설치 매뉴얼의 주석

(1) 주의 사항

(2) 참고 사항

3) 설치 도구의 구성

- exe, dll, ini, chm 등의 설치 관련 파일에 대해 설명

- 폴더 및 설치 프로그램 실행 파일에 대해 설명

- log 폴더에 대해 설명 (설치 과정 및 결과가 기록됨)

4) 설치 환경 체크 항목

(1) 사용자 환경

(2) 응용 프로그램

(3) 업그레이드 버전

(4) 백업 폴더 확인

 

2. 기본 사항

1) 소프트웨어 개요

2) 설치 관련 파일

3) 설치 아이콘

4) 프로그램 삭제

5) 관련 추가 정보

 

3. 설치 매뉴얼 작성 방법

설치 화면을 누락 없이 캡처, 순서대로 상세히 설명

1) 설치 화면 및 UI

- 설치 실행

- 메인 화면 및 안내창

2) 설치 이상 메시지 설명

- 설치 과정별로 참고 사항, 주의 사항에 대한 메모 추가

3) 설치 완료 및 결과

- 설치 완료 화면 수록

4) FAQ

5) 설치 시 점검 사항

- 사용자 계정 및 설치 권한에 대해 확인할 수 있도록 설명

6) Network 환경 및 보안

- 사전에 필요한 네트워크 연결 상태를 점검하도록 안내

- 보안, 방화벽으로 문제 발생 않도록 관련 내용 안내

7) 고객 지원 방법

8) 준수 정보 & 제한 보증

- Serial 보존, 불법 등록 사용 금지 등에 대한 준수 사항 안내

- 저작권자 소유권 정보, SW 허가권 정보, 통신 규격, 개발 언어, 연동 프로그램, 문서 효력, 지적 소유권 정보 등 관련 내용 안내

 

4. 설치 매뉴얼 작성 순서

1) 기능 식별

2) UI 분류

3) 설치 파일 / 백업 파일 확인

4) Uninstall 절차 확인

5) 이상 Case 확인

6) 최종 매뉴얼 적용