CODEDRAGON ㆍDevelopment/Software Engineering
제품 소프트웨어 사용자 매뉴얼의 기본 작성 항목
· 목차 및 개요
· 서문
· 기본 사항
목차 및 개요
|
목차 |
매뉴얼 전체의 내용을 순서대로 요약 |
|
개요 |
제품 소프트웨어의 주요 특징에 대해 정리 ex) Windows 기반의 PC에서 제공하는 운영 체제와 SW의 중요한 특징에 대한 여러 기능을 갖는 소프트웨어임. 사용자 매뉴얼에서의 구성과 실행 방법, 메뉴에 대한 설명을 비롯하여 사용법, 각 항목에 따른 점검 기준, 그리고 설정 방법 등에 대해 기술함 |
서문
|
문서 이력 정보 |
사용자 매뉴얼 문서 이력 정보
|
||||||||||||||||||||||||||||||||
|
사용자 매뉴얼의 주석 |
|
||||||||||||||||||||||||||||||||
|
기록 보관 |
· 제품 등록과 관련한 기록에 대한 내용 기재 · 향후 필요한 경우나 도움이 되는 추가 제품 정보를 받기 위한 내용 기재 · 인터넷을 이용한 지원이 가능하도록 Website URL 기재 · 제품 소프트웨어 CD-ROM 등을 통해 우편 또는 팩스로 지원을 보낼 수 있는 양식 제공 |
||||||||||||||||||||||||||||||||
사용자 매뉴얼 기록 항목
제품 등록과 관련하여 아래의 기록 항목들을 기재한다.
|
매뉴얼 기록 항목 |
기재할 내용 |
|
제품 명칭 |
제품 소프트웨어의 명칭 기재 |
|
제품 소프트웨어의 모델명(버전명) |
버전을 포함한 제품 소프트웨어의 자체 모델명을 기재 |
|
기록 항목에 대한 문서 번호 |
제품 소프트웨어 Rev. 버전 날짜 등등의 고유한 문서번호 기재 |
|
제품 번호 |
고유한 제품의 시리얼 넘버(Serial Number) 기재 |
|
구입 날짜 |
사용자가 직접 기재할 수 있도록 빈 공란으로 공백 처리함 |
기본 사항
기본적으로 제품 소프트웨어와 관련하여 설명할 항목들은 다음과 같다. 이때 간략한 기능 및 UI를 첨부하고, 요약한다.
사용자 매뉴얼 기본 사항
|
기본 사항 |
항목 설명 |
|
제품 소프트웨어 개요 |
제품 소프트웨어의 주요 기능 및 UI 설명 UI 및 화면 상의 버튼, 프레임 등을 도식화하여 설명 |
|
제품 소프트웨어 사용 |
제품 소프트웨어를 사용하기 위한 최소 환경 설명 PC 사양(CPU, Memory 등), OS 버전 명시 제품 소프트웨어 최초 동작을 위한 설명(실행 파일 or Website URL 등) 주의 사항: 제품 소프트웨어 동작 시 프로그램 충돌사항 혹은 안전하게 이용하기 위한 주의 사항(개인정보, 보안 등에 관련된 사항까지 명시) |
|
제품 소프트웨어 관리 |
제품 소프트웨어의 사용 종료 및 관리 등에 대한 내용 기재 |
|
모델, 버전별 특징 |
제품 구별을 위한 모델, 버전별 UI 및 기능의 차이 간단히 기술 |
|
기능, I/F의 특징 |
제품의 기능 및 Interface의 특징을 간단히 기술 |
|
제품 소프트웨어 구동 환경 |
개발 언어 및 호환 OS 설치 마법사(Setup Wizard) 이후 사용자가 구동하기 까지의 과정 요약(Windows, Linux) |