048 소프트웨어 설치 매뉴얼 작성- 3장 제품 소프트웨어 패키징 - 2과목 소프트웨어 개발

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

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

- 사용자 기준으로 작성

- 시작부터 완료까지 전 과정을 설명

- 설치 과정에서 나오는 오류 메시지, 예외를 별도로 설명

- 목차 및 개요, 서문, 기본 사항 등이 기본적을 포함

- 목차에는 전체 설치 과정을 순서대로 요약 하고 페이지 표시

- 개요에는 설치 매뉴얼의 주요 특징, 구성, 설치 방법, 순서 등 설명

 

2. 서문

- 문서 이력, 설치 매뉴얼 주석, 설치 도구 구성, 설치 환경 등을 기술

- 설치 매뉴얼 주석 : 주의 사항과 참고 사항을 기술

- 주의 사항 : 설치할 때 사용자가 반드시 알아야 하는 내용

- 참고 사항 : 설치에 영향을 미칠 수 있는 환경이나 상황

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

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

                          : 설치 과정 및 결과가 기록되는 log 폴더 설명

- 설치 환경 체크 항목 : 사용자 환경, 으용 프로그램, 업그레이드 버전, 백업 폴더 확인

 

3. 기본 사항

- 소프트웨어에 관한 기본적 설명 항목들

1. 소프트웨어 개요

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

- UI 및 화면 그림으로 설명

 

2. 설치 관련 파일

- 소프트웨어 설치에 필요한 파일 설명

- exe, ini, log 등 파일 설명

 

3. 설치 아이콘 

- 설치 아이콘 설명

 

4. 프로그램 삭제

- 삭제 방법 설명

 

5. 관련 추가 정보

- 소프트웨어 이외의 관련 설치 프로그램 정보

- 소프트웨어 제작사 등의 추가 정보 기술

 

4. 설치 매뉴얼 작성 방법

- 사용자가 설치 과정을 이해하기 쉽도록 캡처로 상세히 설명

- 설치 화면 및 UI, 설치 이상 메시지, 설치 완료 및 결과, FAQ, 설치 시 점검 사항, 네트워크 환경 및 보안, 고객 지원 방법, 준수 정보 및 제한 보증 등을 기술

 

5. 설치 매뉴얼 작성 순서

1. 기능 식별 - 소프트웨어의 개발 목적과 주요 기능을 흐름 순으로 정리, 기록

2. UI 분류 - 설치 매뉴얼에 작성할 순서대로 UI를 분류 후 기록

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

4. Uninstall 절차 확인

5. 이상 Case 확인

6. 최종 매뉴얼 적용