PDF 다운로드
PDF 다운로드
유저 매뉴얼은 전자 문서(PDF 혹은 XPS) 포맷이나 인쇄 책자 형태로 이용 가능하며, 특정한 사물을 사용하거나 특정한 작업을 수행하는 방법을 설명하는 문서이다. "유저 가이드 "라는 용어가 컴퓨터 소프트웨어에 많이 사용되는 반면, 유저 매뉴얼은 컴퓨터나, 텔레비전과 스테레오, 전화 시스템, MP3 플레이어 등의 전자기기와 다른 가전제품에 많이 사용된다. 좋은 유저 매뉴얼은 사용자에게 제품의 기능을 잘 알려주고, 효율적으로 기능을 사용할 수 있는 방법을 쉽게 읽고 참조할 수 있도록 구성되어 있어야 한다. 이 위키하우 글을 읽어보고 효과적인 콘텐츠로 구성된 유저 매뉴얼을 만들어보자.
단계
-
사용자가 누구인지 정의하기. 성공적인 유저 매뉴얼을 작성하기 위해 사용자의 프로필을 작성해보거나, 사용자의 특성에 대한 합리적인 추정을 바탕으로 발전시켜 나가보자. 매뉴얼 개발 팀의 일원으로 매뉴얼을 작성할 때 사용자의 프로필이 마련되어 있다면 큰 도움이 될 수 있으며, 제품을 구상 단계부터 마무리 단계까지 살펴보는 데에도 도움이 된다. 사용자 프로필을 구성할 때 다음과 같은 점들을 고려해보자:
- 사용자가 집, 사무실, 실외 공간, 차 등 어디에서 매뉴얼을 살펴볼 가능성이 높은지 생각해보자. 장소가 결정되면 매뉴얼의 내용뿐 아니라, 사용자가 매뉴얼을 다루는 스타일까지 추정해볼 수 있다.
- 사용자가 유저 매뉴얼을 어떻게 살펴볼지 생각해보자. 정보를 찾거나 모르는 내용을 찾아볼 때 사용하는 유저 매뉴얼이라면, 쉽게 참고할 수 있도록 구성되어야 한다. 하지만 사용 초기에 살펴보아야 하는 매뉴얼이라면, 참조 영역 "시작하기" 영역이 추가되고 가장 많이 활용되는 기능에 대한 설명이 들어가 있어야 한다.
- 사용자가 해당 제품이나 이와 비슷한 제품을 다뤄본 경험이 많을지 생각해보자. 신제품이거나 기존 제품과 매우 다른 제품이라면, 이 제품이 가지고 있는 다른 제품과의 차이점, 그리고 사용 방법을 설명하는 것이 좋다. 컴퓨터 애플리케이션처럼 사용자들이 제품을 다룰 때 일반적으로 어려워하는 점들이 있다면, 사용자들이 이를 잘 이해할 수 있도록 적절한 정보를 자세하게 제공한다.
-
사용자들이 이해할 수 있는 방식으로 글을 작성하기. 기술적인 배경을 갖추지 않은 사용자들이라면, 전문적인 언어를 사용하지 않고, 간단하게 설명하는 것이 가장 좋다. 사용자들이 생각하는 방향에 따라 글을 기술하도록 해보자. 기능에 따라 제품 구성을 나열하는 것이 단순히 나열하는 것보다 더 좋은 방법이다.
- 예를 들어, 그래프 소프트웨어 매뉴얼이라면 피보나치 차트나 파이 차트, 바 그래프와 같은 전문적인 용어 사용을 피하기 어려울 수 있다. 이런 경우, 용어를 정의하고 피보나치 차트가 무엇인지, 재무 분석을 할 때 어떻게 사용되는지 배경 지식을 함께 전달하면 도움이 된다.
-
사용자들이 해결하려고 하는 문제를 자세히 기술하기. 문제와 함께 해결책을 제시한다. 제품을 홍보할 때는 일반적인 문제의 해결책을 하나의 기능으로 제시하는 것도 괜찮지만, 사용자가 제품을 구매한 후 사용할 수 있는 방법을 익힐 수 있도록 안내해야 한다. 사용자들이 마주하는 특정한 문제를 구분 짓고 이를 유저 매뉴얼에 설명한 하고, 문제를 해결할 수 있는 방법을 제시한다.
- 제품의 문제가 복잡한 편이라면, 작은 부분으로 나눠보자. 문제를 해결하는 방법을 각 부분마다 나열하고, 그 이후 어떻게 진행해야 하는지 안내한다. 이렇게 정보를 분해하는 방식을 "청킹(chunking)"이라고 한다.
광고
-
적절한 커버와 제목 페이지를 삽입하기. 단순한 참조 카드가 아닌 매뉴얼이라면 가장 앞 표지가 필요하며, 단순히 종이 한 장을 접은 매뉴얼이 아니고 4장 이상의 매뉴얼이라면 제목 페이지가 필요하다.
- 매뉴얼에 저작권이 있다면, 앞 표지와 제목 페이지에 저작권 표기가 들어가야 한다.
- 매뉴얼이나 제품을 사용하는데 이용 약관이 필요하다면, 앞 표지 안에 이를 기록한다.
-
전문에 참조한 관련 문서를 기재하기. 사용자를 위한 문서가 2개 이상이라면, 다른 문서 참조 영역을 만들고, 매뉴얼의 버전을 기재한다. 매뉴얼에 전문이 있다면 "이 가이드를 사용하는 방법" 영역도 추가한다.
-
매뉴얼이 10페이지를 넘어갈 경우, 목차를 삽입하기.
-
매뉴얼의 본문에 사용법, 과정, 참조 자료를 넣어주기. 절차와 참조 부분을 별도의 영역으로 넣어주되, 사용자가 특정한 내용을 살펴보길 원할 때 해당 내용을 빠르게 참조할 수 있도록 해주어야 한다.
- 절차 방법은 설명 영역과 동일한 구성으로 작성한다. 작업의 개괄로 시작하고, 사용자에게 따라야 할 절차를 설명한 후, 어떤 결과를 맞이해야 하는지 기술한다. 이 위키하우 글처럼 단계별로 번호를 매기고 행위 동사로 설명한다.
- 참조 자료에 다양한 옵션 목록, 문제 해결 팁, 자주 묻는 질문 등을 포함해보자. 용어 사전이나 색인도 매뉴얼 끝에 추가할 수 있으나, 자주 묻는 질문은 되려 매뉴얼의 앞부분에 넣어주는 것이 좋다. 매뉴얼의 장 수가 20장 미만이라면 색인은 생략해도 좋다.
-
글을 뒷받침할 수 있는 그래픽 이미지를 넣어주기. 그래픽 이미지, 스크린샷을 삽입하면 시각적 도움을 받아서 단계를 제대로 수행할 수 있기 때문에 글만 있는 것보다 더 좋은 설명이 될 수 있다. CAD나 그래픽 에디팅 소프트웨어, 디지털카메라, 사진 수정 소프트웨어, 컴퓨터의 스크린샷 기능, 혹은 스크린 캡처가 가능한 그래픽 프로그램 등을 사용해서 이미지를 삽입해보자.
- 그래픽 이미지가 생성되었다면, 워드 프로세서나 데스크탑의 퍼블리싱 프로그램으로 이미지를 사용할 수 있도록 압축 포맷으로 저장해보자. 또한 충분한 설명이 담긴 페이지에 사진이 더 조화롭게 삽입되도록 이미지의 크기도 줄여보자(필요할 경우 원본 사진을 잘라서 글과 관련 있는 부분만 붙여 넣도록 한다).
- 과정 부분에 여러 그래픽 이미지를 삽입할 경우, 길이를 맞춰주거나, 너비를 맞춰주거나 혹은 원본에서 동일한 비율로 자른 크기 등, 일정한 크기를 유지해서 사용자의 눈에 깔끔하게 들어올 수 있도록 해보자. 마찬가지로 컬러 매뉴얼에 컴퓨터의 스크린샷을 삽입할 때에도 컴퓨터의 색깔 배열을 표준으로 유지한다.
- 포토샵이나 페인트샵 프로 등의 그래픽 수정 프로그램을 사용해도 좋지만, 스네그잇(SnagIt)과 같은 화면 캡쳐 전문 프로그램을 사용하면 더 쉽게 캡쳐된 이미지를 수정하고, 주석을 달며, 분류할 수 있다.
광고
-
읽기 쉬운 폰트를 몇 개 선택하기. 컴퓨터에서 사용할 수 있는 폰트가 매우 많지만, 유저 매뉴얼일 경우 쉽게 읽을 수 있는 글씨여야 한다. 함께 놓였을 때 잘 어울리는 폰트를 몇 개 선정해서 가독성을 높여보자. 폰트는 다음과 같은 2 종류로 나뉘어질 수 있다: 세리프(serif)와 산 세리프(sans serif).
- 세리프 폰트는 글자의 메인 획 끝에 살짝 장식이 들어가는 글자체로, 타임즈 뉴 로만(Times New Roman), 베스커빌(Baskerville), 북 안티쿠아(Book Antiqua) 등의 폰트가 이에 해당된다. 세리프 폰트는 10-12 폰트 크기의 글자가 모여 있는 유저 매뉴얼 본분 내용에 사용하는 것이 좋다.
- 산 세리프는 각 획 끝에 장식이 들어가지 않는 글자체이다. 에어리얼(Arial), 칼리브리(Calibri), 그리고 센츄리 고딕(Century Gothic)과 같은 폰트가 이에 해당된다. 산 세리프 폰트는 8-10 폰트 크기의 글자가 서로 많이 모여 있을 때 PDF나 웹 기반 매뉴얼에 사용하는 것이 좋지만, 12폰트 이상의 글자에 세리프 글자체가 부족하면 가독성이 떨어질 수 있다. 하지만 제목 등과 같은 큰 글씨를 나타날 때 산 세리프의 효과가 좋을 수 있으며, 주석이나 표의 숫자처럼 작은 글자를 표기할 때 사용해도 좋다.
- 에어리얼이나 타임즈 뉴 로만처럼 간단한 폰트를 유저 매뉴얼에 사용하는 것이 좋지만, 판타지나 공상과학 기반의 비디오 게임 유저 매뉴얼이라면, 제목이나 인용 문구 등을 적을 때 장식이 들어간 폰트를 사용하는 것도 좋다(게임 인용 문구라면, 간단한 폰트에 이탤릭 스타일을 넣어주는 것도 좋은 방법이다.)
- 사용하고자 하는 폰트를 결정했다면, 샘플 페이지를 만들어서 폰트가 잘 어울리는지 확인해보자. 또한 매뉴얼을 더 작성해나가기 전에 샘플 페이지를 다른 사람들에게 보여주고 의견을 구해보자.
-
충분히 구성에 대해 생각해보기. 유저 매뉴얼의 폰트를 결정하고 난 후, 페이지에 들어갈 다른 부분에 대해 생각해보자.
- 일반적으로, 매뉴얼의 제목이나 각 장의 제목은 머리말이나 꼬리말로 넣어주고, 매뉴얼 제목이라면 페이지 왼쪽 면에, 그리고 장 제목이라면 페이지 오른쪽에 정렬해준다. 페이지 숫자도 머리말이나 꼬리말 부분에 넣어주는 것이 좋은데, 페이지의 바깥쪽에 넣어주려면 머리말이나 꼬리말 중 원하는 곳에 사용해도 좋고, 중앙에 넣어줄 경우 꼬리말에 넣어주는 것이 좋다. 각 영역이나 각 챕터의 가장 처 페이지의 페이지 번호를 가운데에 넣어주고, 나머지 페이지는 바깥쪽 코너에 넣어주는 등 살짝 구분해주어도 좋다.
- 다른 문자로부터 구분되는 색이나 음영이 들어간 박스가 삽입된 페이지 숫자를 넣어주는 방법도 있다. 이때 색깔이나 음영이 다른 글자를 너무 압도하지 않도록 주의한다.
- 모든 면에 충분한 여백을 남겨주고, 책으로 엮을 때 필요한 추가 공간도 염두에 둔다.
-
유저 매뉴얼의 바인딩 기법을 고려하기. 4장 이상의 유저 매뉴얼이라면, 페이지를 엮어줄 필요가 있다. 내부적인 문서라면 코너를 스테이플러로 고정시켜주어도 좋지만, 제품과 함께 제공되는 대외적인 문서라면 다음과 같은 3가지 방법을 고려해보자:
- 21 x 27.5-cm, 21 x 35-cm, 27.5 x 42.5-cm 크기의 종이를 접은 매뉴얼이라면 측면 스테이플링 기법을 활용하는 것이 좋다. 48장 이내의 매뉴얼일 때 가장 저렴하게 바인딩을 할 수 있는 방법이다.
- 중철 제본은 제품과 함께 제공되는 유저 매뉴얼의 참고 자료를 묶을 때(자동차 매뉴얼은 제외) 가장 많이 사용되지만, 가끔 페이지 장수가 많은 매뉴얼도 중철 제본 방식으로 제본되는 경우가 있다(JASC 소프트웨어에서 페인트샵 프로를 선보였을 때, 유저 매뉴얼이 중철 제본 방식으로 바인딩 되었다).
- 스프링 제본은 사이드 스테이플이나 중철 제본 기법을 사용했을 때 떨어지기 쉬운 야외 등의 환경에서 사용되는 유저 매뉴얼에 활용하는 것이 좋다. 스프링 제본과 함께 종이를 코팅하면 젖거나 진흙이 묻어도 매뉴얼이 손상되지 않는다.
-
매뉴얼을 위한 문서 양식 만들기. 워드 프로세서나 데스크탑의 퍼블리싱 프로그램은 유저 매뉴얼을 위한 문서 양식을 제공한다. 양식을 활용하면 글을 입력할 때 자동으로 작성하고 있는 매뉴얼 부분에 미리 선택한 폰트로 문자가 나타난다(위키하우 글도 초기에 마이크로소프트 워드 양식으로 작성되었다). 대부분의 프로그램들이 나의 필요에 맞게 수정할 수 있는 양식들을 많이 제공하고 있기 때문에, 양식을 처음부터 만들지 않아도 된다.
- 워드 프로세서나 데스크탑의 퍼블리싱 프로그램들이 머리말, 꼬리말, 제목, 본문에 폰트와 폰트 크기를 미리 지정할 수 있는 "스타일" 기능도 제공한다. 이미 정해져 있는 스타일 이름(예: "본문1," "일반글," "인용")을 사용하거나 나만의 스타일을 생성하고 스타일 이름을 붙여보자. 동일한 등급의 글자에 다양한 스타일을 적용할 경우, 가능하면 이미 존재하는 스타일 이름의 형식을 따라보자(예를 들어, 마이크로소프트 워드에서는 제목과 여러 등급의 부제목의 텍스트 스타일을 "제목1," "제목2," 등으로 이어 나가고 있다). 스타일을 미리 만들어 놓으면, 매뉴얼을 작성할 때 작성을 멈추고 스타일을 생성하지 않아도 된다.
광고
팁
- 적용이 가능하다면 구역 코드와 문자 변수도 사용해보자. 제품의 이름이나 매뉴얼, 혹은 장 이름에 값을 지정하고, 문서를 작성할 때 실제 해당 이름 대신에 문자 값을 입력한다. 문서를 미리 보거나 인쇄해서 살펴보면 값을 입력한 부분에 해당 문자가 삽입된 것을 확인할 수 있다. 제품의 이름이 변경되었거나, 매뉴얼이나 장의 이름을 변경했다면, 문서에서 변경값을 검색해서 대체하는 것보다 문자 변수의 값을 변경해주면 되기 때문에, 쉽게 변경이 가능하다.
광고
필요한 것
- 워드 프로세서 혹은 데스크탑 퍼블리싱 프로그램
- 그래픽 에디팅 혹은 화면 캡처 프로그램
출처
- http://www.asktog.com/columns/017ManualWriting.html
- http://headrush.typepad.com/creating_passionate_users/2007/03/the_best_user_t.html
- http://klariti.com/technical-writing/User-Guides-Tutorial.shtml
- Rodney Ruff, Omaha, NE; over 10 years of experience in writing help files and user manuals
광고
