2-3-4장. 소프트웨어 설치 매뉴얼 작성 - C

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

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

 

• 설치 매뉴얼은 사용자 기준으로 작성

• 설치 시작부터 완료할 때까지의 전 과정을 빠짐없이 순서대로 설명

• 설치 과정에서 표시될 수 있는 오류 메시지 및 예외 상황에 관한 내용을 별도로 분류하여 설명

• 소프트웨어 설치 매뉴얼에는 목차 및 개요, 서문, 기본 사항 등이 기본적으로 포함되어야 함

• 소프트웨어 설치 매뉴얼의 목차에는 전체 설치 과정을 순서대로 요약한 후 관련 내용의 시작 페이지를 함께 기술

• 소프트웨어 설치 매뉴얼의 개요에는 설치 매뉴얼의 주요 특징, 구성과 설치 방법, 순서 등의 내용을 기술

서문

• 문서 이력

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

  • 주의 사항 : 소프트웨어를 설치할 때 사용자가 반드시 알고 있어야 하는 중요한 내용을 기술

  • 참고 사항 : 설치에 영향을 미칠 수 있는 사용자의 환경이나 성황에 대한 내용을 기술

• 설치 도구의 구성

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

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

  • 설치 과정 및 결과가 기록되는 log 폴더에 대해 설명

• 설치 환경 체크 항목

  • 사용자 환경 : CPU, 메모리, OS 등

  • 응용 프로그램 : 설치 전 다른 응용 프로그램 종료

  • 업그레이드 버전 : 업그레이드 이전 버전에 대한 존재 유무 확인

  • 백업 폴더 확인 : 데이터 저장 폴더를 확인하여 설치 시 폴더를 동기화

기본 사항

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

 

• 소프트웨어 개요 

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

  • UI 및 화면 상의 버튼, 프레임 등을 그림으로 설명

• 설치 관련 파일 

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

  • exe, ini, 등의 파일 설명

• 설치 아이콘 

  • 설치 아이콘 설명

• 프로그램 삭제 

  • 설치된 소프트웨어의 삭제 방법 설명

• 관련 추가 정보

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

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

설치 매뉴얼 작성 방법

설치 매뉴얼은 사용자가 설치 과정을 이해하기 쉽도록 설치 화면을 누락 없이 캡처하고 순서대로 상세히 설명한다.

 

• 설치 매뉴얼에는 설치 화면 및 UI, 설치 이상 메시지, 설치 완료 및 결과, FAQ, 설치 시 점검 사항, Network 환경 및 보안, 고객 지원 방법, 준수 정보 및 제한 보증 등에 대한 내용을 기술한다.

설치 매뉴얼 작성 순서