소프트웨어 설치 매뉴얼이란?
사용자가 소프트웨어를 설치하는 과정에 필요한 내용을 기록한 설명서와 안내서이다.
문서 이력
표 : 버전 - 작성자 - 작성일 - 검토자 - 일시 - 검수인
설치 매뉴얼의 주석
주의 사항과 참고 사항을 기술한다.
주의 사항 : 소프트웨어를 설치할 때 사용자가 반드시 알고 있어야 하는 중요한 내용을 기술한다.
참고 사항 : 설치에 영향을 미칠 수 있는 사용자의 환경이나 상황에 대한 내용을 기술한다.
설치 도구의 구성
exe, dll, ini, chm 등의 설치 관련 파일에 대해 설명한다.
폴더 및 설치 프로그램 실행 파일에 대해 설명한다.
설치 과정 및 결과가 기록되는 log 폴더에 대해 설명한다.
설치 환경 체크 항목
사용자 환경 : CPU, Memory, OS 등
응용 프로그램 : 설치 전 다른 응용 프로그램 종료
업그레이드 버전 : 업그레이드 이전 버전에 대한 존재 유무 확인
백업 폴더 확인 : 데이터 저장 폴더를 확인하여 설치 시 폴더를 동기화 시킴
기본적으로 설명 되어야 할 항목들
소프트웨어 개요
소프트웨어의 주요 기능 및 UI 설명
UI 및 화면 상의 버튼, 프레임 등을 그림으로 설명
설치 관련 파일
소프트웨어 설치에 필요한 파일 설명
exe, ini, log 등의 파일 설명
설치 아이콘(Installation)
설치 아이콘 설명
프로그램 삭제
설치된 소프트웨어의 삭제 방법 설명
관련 추가 정보
소프트웨어 이외의 관련 설치 프로그램 정보
소프트웨어 제작사 등의 추가 정보 기술
설치 화면 및 UI
설치 실행 : exe 등의 설치 파일을 실행할 수 있도록 관련 실행 화면에 대한 이미지를 첨부하여 설명한다.
메인 화면 및 안내창 : 설치 시 나타나는 메인 화면과 각 과정에서 의 안내창에 대한 이미지를 첨부하여 설명한다.