[정보처리기사 필기] 제품 소프트웨어 패키징 - 040. 소프트웨어 사용자 매뉴얼 작성

1. 소프트웨어 사용자 매뉴얼의 개요

• 사용자가 소프트웨어를 사용하는 과정에서 필요한 내용을 문서로 기록한 설명서와 안내서 
• 사용자가 소프트웨어 사용에 필요한 절차, 환경 등의 제반 사항이 모두 포함되도록 작성
• 소프트웨어 배포 후 발생될 수 있는 오류에 대한 패치, 기능에 대한 업그레이드를 위해 매뉴얼의 버전을 관리
  • 패치 Patch : 이미 제작하여 배포된 프로그램의 오류 수정이나 성능 향상을 위해 프로그램의 일부 파일을 변경하는 것
• 개별적으로 동작이 가능한 컴포넌트 단위로 매뉴얼을 작성
  • 컴포넌트 : 독립적인 업무 또는 기능을 수행하는 단위, 실행 코드 기반으로 작성된 모듈
• 컴포넌트 명세서와 컴포넌트 구현 설계서를 토대로 작성
  • 컴포넌트 명세서 : 컴포넌트의 개요 및 내부 클래스의 동작, 외부와의 통신 명세 등을 정의한 문서
  • 컴포넌트 설계서 : 컴포넌트 구현에 필요한 컴포넌트 구조도, 컴포넌트 목록, 컴포넌트 명세, 인터페이스 명세로 구성된 설계서
• 목자 및 개요, 서문, 기본 사항 등이 기본적으로 포함되어야 함
  • 목차 : 매뉴얼 전체 내용을 순서대로 요약한 후 관련 내용의 시작 페이지를 함께 기술
  • 개요 : 소프트웨어의 주요 특징, 매뉴얼의 구성과 실행 방법, 사용법, 항목별 점검 기준, 항목별 설정 방법 등에 대한 내용 기술

2. 서문

• 문서 이력 : 버전, 작성자, 작성일, 검토자, 일시, 검수인, 변경 내용
• 사용자 매뉴얼의 주석
  • 주의 사항 : 소프트웨어를 사용할 때 사용자가 반드시 알고 있어야 하는 중요한 내용을 기술
  • 참고 사항 : 특별한 사용자의 환경이나 상황에 대한 내용 기술
• 기록 보관 내용
  • 소프트웨어를 사용하면서 필요한 기술 지원이나 추가 정보를 얻기 위한 소프트웨어 등록 정보를 기술
  • 소프트웨어 등록 시 필요한 정보 : 소프트웨어 명칭, 모델명, 문서 번호, 제품 번호, 구입 날짜 등
    • 문서 번호 : 릴리즈 번호, 날짜 등 고유한 문서번호를 기재
    • 제품 번호 : 소프트웨어의 고유한 시리얼 넘버를 기재

3. 기본 사항

• 소프트웨어 개요
  • 소프트웨어의 주요 기능 및 UI 설명
  • UI 및 화면 상의 버튼, 프레임 등을 그림으로 설명
• 소프트웨어 사용 환경
  • 소프트웨어 사용을 위한 최소 환경 설명
  • CPU, 메모리 등의 PC 사양, 운영체제 OS 버전 설명
  • 최초 구동에 대한 설명
  • 소프트웨어 사용 시 발생할 수 있는 프로그램 충돌이나 개인정보, 보안 등에 관한 주의사항을 설명
• 소프트웨어 관리 : 소프트웨어의 사용 종료 및 관리 등에 관한 내용 설명
• 모델, 버전별 특징 : 모델 및 버전별로 UI 및 기능의 차이점을 간략하게 요약 
• 기능, 인터페이스의 특징 : 제품의 기능과 인터페이스의 특징을 간략하게 요약
• 소프트웨어 구동 환경
  • 개발에 사용한 언어 및 호환 가능한 운영체제에 대해 설명
  • 설치 후 구동하기까지의 과정을 운영체제별로 설명

4. 사용자 매뉴얼 작성 순서

1. 작성 지침 정의 : 사용자 매뉴얼을 작성하기 위한 지침을 기록, 작성 지침은 사용자 환경에 필요한 정보를 제공할 수 있는 형태로 기록
2. 사용자 매뉴얼 구성 요소 정의 : 소프트웨어의 기능, 구성 객체 목록, 객체별 메소드, 메소드 피라미터, 실제 사용 예, 사용자 환경 셋팅 방법 등을 기록
3. 구성 요소별 내용 작성 : 사용자 매뉴얼 구성 요소별로 내용을 기록
4. 사용자 매뉴얼 검토 : 작성된 구성 요소별 내용이 올바른지, 부족한 부분은 없는지 등을 검토하여 수정 및 보완