제품 소프트웨어 매뉴얼 작성 📖

출제 빈도: 하
빈출 태그: 설치 매뉴얼, 사용자 매뉴얼

설치 매뉴얼과 사용자 매뉴얼은 “언제 읽히는가”가 다르다. 설치 매뉴얼은 프로그램을 처음 깔 때 딱 한 번 참고되고, 사용자 매뉴얼은 이후 기능을 쓰다가 막힐 때마다 반복해서 펼쳐진다. 이 차이 때문에 두 문서는 목차 구성부터 강조점이 달라진다 — 설치 매뉴얼은 “순서”가 생명이고, 사용자 매뉴얼은 “찾기 쉬움”이 생명이다.

1. 제품 소프트웨어 설치 매뉴얼

기본 원칙

• 사용자 기준으로 작성되어야 합니다.
• 순차적으로 작성해야 합니다.
• 모든 관련 화면을 캡처해야 합니다.
• 에러 내용을 체계적으로 분류해야 합니다.

설치 매뉴얼 작성 항목

• 개요, 서문, 기본 사항 순으로 설명
• 서문 포함 사항:
  • 문서 이력
  • 주석
  • 설치 도구의 구성
• 기본 사항 포함 내용:
  • 간략한 기능 및 UI
  • 설치 관련 파일
  • 설치 아이콘
  • 프로그램 삭제 방법
  • 관련 추가 정보
• 설치 방법 상세 설명
• 기술 지원 및 서비스 연락처 정보
• 사용자 준수사항:
  • 제품 키 보존
  • 저작권 정보
  • 불법 등록 사용 금지 안내

2. 설치 매뉴얼 작성 절차

1. 기능 식별
   • 흐름 순서대로 정리하여 설명
2. UI 분류
   • 화면 중심으로 순차적 분류
   • 목차에 맞는 UI 분류

3. 설치/백업 파일 확인

4. Uninstall 절차 확인
   • 순차적 기술
   • 삭제 후 원상복구 상태 확인
5. 이상 Case 확인
   • 이상 메시지 케이스 발생 테스트
   • 메시지 표시 상태 확인
6. 최종 설치 완료 결과 적용

3. 제품 소프트웨어 사용자 매뉴얼

작성 절차

1. 작성 지침 정의
2. 구성요소 정의
3. 구성 요소별 내용 작성
4. 검토

작성 항목

• 개요
• 서문
  • 문서 이력
  • 주석
  • 기록 항목
• 기본 사항
  • 기능과 UI 첨부
  • 개요
  • 사용법
  • 관리 방법
  • 버전별 특징
  • 인터페이스
  • 구동 환경

4. 매뉴얼 작성 지침

• 다양한 측면에서 상세한 설명 제공
• 서비스 연락 수단 명시
• 사용자 준수사항 안내:
  • 제품 키 보존
  • 저작권 정보
  • 불법 등록 사용 금지

5. 제품 소프트웨어 배포용 미디어

기본 사항

• 배포 정보를 포함한 산출물 제작
• 안정성 고려
• 저작권 및 보안 유의
• 복제 및 사후 지원 고려

배포용 미디어 제작 포함사항

• 버전 정보
• 요구 사양
• 설치 방법
• 새로운 기능
• 알려진 오류/대처 방법
• 제약 사항
• 제작 방법:
  • 온라인: 실행 파일로 통합
  • 오프라인: 시리얼 넘버 포함

미디어 제작 절차

1. 온라인/오프라인 배포 방식 선정
2. 시리얼 넘버 등록 및 관리 체계 확인
3. 설치 파일 및 매뉴얼 최종 확인
4. 명세서 구현 여부 검토
5. 정보의 충실성 검토
6. 인증 여부 확인

핵심 정리

• 설치 매뉴얼은 “순서대로 따라 하면 설치가 끝난다”를 목표로, 사용자 매뉴얼은 “필요한 기능을 빠르게 찾는다”를 목표로 작성 방향이 갈린다.
• 두 매뉴얼 모두 개요 → 서문(문서 이력·주석) → 기본 사항 순서로 구성되는 공통 골격을 따르되, 이상 Case·에러 메시지 검증은 설치 매뉴얼에서 특히 중요하다 — 설치 실패는 사용자가 되돌릴 방법이 없는 경우가 많기 때문이다.