3장. 소프트웨어 설치 매뉴얼 작성

1. 소프트웨어 설치 매뉴얼의 개요

소프트웨어 설치 매뉴얼은 개발 초기에서부터 적용된 기준이나 사용자가 소프트웨어를 설치하는 과정에 필요한 내용을 기록한 설명서와 안내서이다.

• 설치 매뉴얼은 사용자 기준으로 작성한다.
• 설치 시작부터 완료할 때까지의 전 과정을 빠짐없이 순서대로 설명한다.
• 설치 과정에서 표시될 수 있는 오류 메시지 및 예외 상황에 관한 내용을 별도록 분류하여 설명한다.
• 소프트웨어 설치 매뉴얼에는 목차 및 개요, 서문, 기본 사항 등이 기본적으로 포함되어야 한다.
• 소프트웨어 설치 매뉴얼의 목차에는 전체 설치 과정을 순서대로 요약한 후 관련 내용의 시작 페이지를 함께 기술한다.
• 소프트웨어 설치 매뉴얼의 개요에는 설치 매뉴얼의 주요 특징, 구성과 설치 방법, 순서 등의 내용을 기술한다.

---

2. 서문

서문에는 문서 이력, 설치 매뉴얼의 주석, 설치 도구의 구성, 설치 환경 체크 항목을 기술한다.

• 문서 이력(버전, 작성자, 작성일, 검토자, 일시, 검수인, 변경내용)
• 설치 매누얼의 주석 : 주의 사항과 참고 사항을 기술한다
  • 주의 사항 : 소프트웨어를 설치할 때 사용자가 반드시 알고 있어야 하는 중요한 내용을 기술한다.
  • 참고 사항 : 설치에 영향을 미칠 수 있는 사용자의 환경이나 상황에 대한 내용을 기술한다.
• 설치 도구의 구성
  • exe, dll, ini, chm 등의 설치 관련 파일에 대해 설명한다.
  • 폴더 및 설치 프로그램 실행 파일에 대해 설명한다.
  • 설치 과정 및 결과가 기록되는 log 폴더에 대해 설명한다.
• 설치 환경 체크 항목

항목	내용
사용자 환경	CPU, Memory, OS(운영체제) 등
응용 프로그램	설치 전 다른 응용 프로그램 종료
업그레이드 버전	업그레이드 이전 버전에 대한 존재 유무 확인
백업 폴더 확인	데이터 저장 폴더를 확인하여 설치 시 폴더를 동기화시킴

---

3. 기본 사항

소프트웨어와 관련하여 기본적으로 설명되어야 할 항목들은 다음과 같다.

항목	설명
소프트웨어 개요	- 소프트웨어의 주요 기능 및 UI 설명 - UI 및 화면 상의 버튼, 프레임 등을 그림으로 설명
설치 관련 파일	- 소프트웨어 설치에 필요한 파일 설명 - exe, ini, log 등의 파일 설명
설치 아이콘(Installation)	설치 아이콘 설명
프로그램 삭제	설치된 소프트웨어의 삭제 방법 설명
관련 추가 정보	- 소프트웨어 이외의 관련 설치 프로그램 정보 - 소프트웨어 제작사 등의 추가 정보 기술

---

4. 설치 매뉴얼 작성 순서

소프트웨어 설치 매뉴얼은 다음과 같은 순서로 작성한다.

1. 기능 식별 : 소프트웨어의 개발 목적과 주요 기능을 흐름 순으로 정리하여 기록한다.
2. UI 분류 : 설치 매뉴얼을 작성할 순서대로 UI를 분류한 후 기록한다.
3. 설치 파일 / 백업 파일 확인 : 폴더 위치, 설치 파일, 백업 파일 등의 개별적인 기능을 확인하여 기록한다.
4. Uninstall 절차 확인 : 직접 Uninstall을 수행하면서 그 순서를 단계별로 자세히 기록한다.
5. 이상 Case 확인 : 설치 과정에서 발생할 수 있는 다양한 Case를 만들어 확인하고 해당 Case에 대한 대처법을 자세하게 기록한다.
6. 최종 매뉴얼 적용
   • 설치가 완료된 화면과 메시지를 캡쳐하여 추가한다.
   • 완성된 매뉴얼을 검토하고 고객 지원에 대한 내용을 기록한다.