제품 소프트웨어 매뉴얼
더 많은 작업
제품 소프트웨어 매뉴얼(Product Software Manual)은 완성된 소프트웨어를 사용자가 설치하고 사용하는 데 필요한 내용을 정리해 제품과 함께 배포하는 문서로, 설치 방법을 다루는 설치 매뉴얼과 기능과 사용법을 다루는 사용자 매뉴얼로 나뉜다.
제품 소프트웨어 매뉴얼은 소프트웨어 패키징의 결과물과 함께 사용자에게 전달된다. 개발자가 아니라 사용자가 읽는 문서이므로, 사용자가 제품을 처음 받아 설치하고, 기능을 쓰고, 문제가 생겼을 때 지원을 받는 데 필요한 정보만 담는다. 개발 일정, 개발 인력, 개발 비용 같은 프로젝트 관리 정보는 매뉴얼에 넣지 않는다. 그런 정보는 사업 수행 계획서나 결과 보고서 같은 개발 산출물에 들어간다.
매뉴얼의 화면 설명과 실제 UI 가 어긋나면 사용자가 따라 할 수 없으므로, 패키징할 때 UI 를 매뉴얼과 일치시키고 판(버전)이 바뀌면 매뉴얼도 함께 고친다.
사용자가 제품을 처음 설치할 때 참고하는 문서다. 설치 전 준비부터 설치 완료 확인, 삭제까지 순서대로 적는다.
| 구성 | 내용 |
|---|---|
| 목차와 개요 | 매뉴얼 전체의 구성, 설치 매뉴얼의 목적과 주요 내용 |
| 문서 이력 | 매뉴얼의 판, 작성·변경 일자와 변경 내용 |
| 설치 매뉴얼 주석 | 설치 중 주의할 점(설치 전 다른 프로그램 종료, 관리자 권한 등)과 참고 사항 |
| 설치 도구의 구성 | exe·dll·ini·chm 등 설치에 쓰이는 파일과 폴더, 설치 프로그램의 실행 방식 |
| 설치 위치 | 기본 설치 폴더와 바꾸는 방법 |
본문에서 설명하는 기본 사항은 다음과 같다.
- 제품 소프트웨어 개요 - 제품의 주요 기능과 UI 를 간단히 설명한다
- 설치 관련 파일 - 설치에 필요한 파일(실행 파일, 설정 파일, 라이브러리, 도움말 파일)을 설명한다
- 설치 아이콘 - 설치를 시작하는 실행 아이콘과 위치
- 프로그램 삭제 - 설치한 소프트웨어를 지우는 방법
- 관련 추가 정보 - 설치에 필요한 운영체제·CPU·메모리 같은 최소 사양, 함께 설치되는 다른 소프트웨어
그 밖에 설치 화면과 단계별 진행, 설치 중 나올 수 있는 이상 메시지와 대처 방법, 설치 완료와 결과 확인 방법, 자주 묻는 질문(FAQ), 고객 지원 방법(연락처, 지원 시간), 준수 정보와 제한 보증(라이선스, 저작권, 보증 범위)을 적는다.
소프트웨어 개발 기간, 개발 인원, 개발 비용은 설치와 관계가 없으므로 설치 매뉴얼의 항목이 아니다.
설치를 마친 사용자가 기능을 쓰는 방법을 설명하는 문서다.
- 사용자 화면과 UI - 주요 화면 구성과 메뉴, 버튼의 뜻
- 주요 기능 - 기능별 사용 절차와 화면 예시, 입력 값과 결과
- 응용 프로그램·설정 - 환경 설정 항목과 기본값, 다른 프로그램과의 연동
- 장치 연동·네트워크 환경 - 함께 쓰는 장치, 필요한 네트워크 설정
- 오류 메시지와 해결 방법, 자주 묻는 질문
- 고객 지원 방법, 준수 정보와 제한 보증
작성 순서는 보통 작성 지침 정의 → 사용자 매뉴얼 구성 요소 정의 → 구성 요소별 내용 작성 → 사용자 매뉴얼 검토이다. 설치 매뉴얼도 같은 흐름으로 쓴다.