2-3-5장. 소프트웨어 사용자 매뉴얼 작성 - C

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

소프트웨어 사용자 메뉴얼은 사용자가 소프트웨어를 사용하는 과정에서 필요한 내용을 문서로 기록 설명서와 안내서이다.

 

• 개별적으로 동작이 가능한 컴포넌트 단위로 매뉴얼 작성

• 컴포넌트 명세서와 컴포넌트 구현 설계서를 토대로 작성

• 사용자가 소프트웨어 사용에 필요한 절차, 환경 등의 제반 사항이 모두 포함되도록 작성

• 소프트웨어 배포 후 발생될 수 있는 오류에 대한 패치나 기능에 대한 업그레이드를 위해 매뉴얼의 버전을 관리

서문

서문에는 문서 이력, 사용자 매뉴얼의 주석, 기록 보관을 위해 필요한 내용을 기술한다.

 

• 문서 이력

• 사용자 매뉴얼의 주석

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

  • 참고 사항 : 특별한 사용자의 환경이나 상황에 대한 내용을 기술

• 기록 보관 내용

  • 소프트웨어를 사용하면서 필요한 기술 지원이나 추가 정보를 얻기 위한 소프트웨어 등록 정보를 기술

  • 소프트웨어 등록 시 필요한정보는 소프트웨어 명칭, 모델명, 문서 번호, 제품 번호, 구입 날짜 등이다.

기본 사항

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

 

• 소프트웨어의 개요, 소프트웨어의 사용 환경, 소프트웨어 관리, 모델버전별 특징, 기능 인터페이스의 특징, 소프트웨어 구동 환경

사용자 메뉴얼 작성 방법

사용자 매뉴얼은 사용자가 사용 방법을 이해하기 쉽도록 상황별로 누락 없이 캡처하여 순서대로 상세히 설명한다.

 

• 사용자 매뉴얼에는 사용자 화면 및 UI, 주요 기능 분류, 응용 프로그램 및 설정, 장치 연동, Network 환경, Profile 안내, 고객 지원 방법, 준수 정보 및 제한 보증 등에 대한 내용을 기술한다.

사용자 매뉴얼 작성 순서