Ръководство за потребителя е наръчник в хартиен или електронен формат (PDF или XPS), който предоставя инструкции относно процедура или използване на нещо. Въпреки че „ръководствата за потребителя“често се свързват с ръководства за компютърни приложения, ръководствата за потребители също са снабдени с компютри и други електронни устройства, като телевизори, стереосистеми, телефонни системи, MP3 плейъри и домакинско и градинско оборудване. Доброто ръководство за потребителя обучава потребителите за характеристиките на продукта, като същевременно ги учи как да използват тези функции ефективно. Ръководството за потребителя е структурирано по такъв начин, че е лесно за четене и справка. Ето някои стъпки, които трябва да имате предвид при разработването на ефективно съдържание и проектирането на оформления на ръководството за потребителя.
Стъпка
Част 1 от 3: Създаване на подходящо ръководство за потребителя
Стъпка 1. Решете кой ще използва ръководството
За да напишете добро ръководство за потребителя, трябва да разработите потребителски профил, или официално чрез създаване на писмен профил, или неофициално, като отделите време, за да направите разумни предположения относно характеристиките на потребителя. Такива профили са полезни, когато сте част от екип за писане на ръководства за потребителя и когато работите върху предвидения продукт от концепцията до окончателната форма. При създаването на потребителски профил вземете предвид следните фактори:
- Местоположението на потребителя ще използва ръководството, например у дома, в офиса, на отдалечено работно място или в колата. Този фактор определя не само съдържанието, но и стила на писане, който ръководството ще възприеме.
- Как потребителят ще използва ръководството. Ако те го използват рядко или се нуждаят само от него, за да намерят информация, най -добре е ръководството да бъде направено под формата на справочен документ. От друга страна, ако потребителят ще го използва редовно в началото, референтният раздел трябва да бъде придружен от раздел „Как да започнем“и инструкции за най -често срещаните функции, които продуктът ще изпълнява.
- Колко опит има потребителят с продукта или подобен артикул. Ако продуктът е нов или много различен от подобни продукти, трябва да включите обяснение как се различава от другите и инструкции как да го използвате. Ако продуктът се занимава с нещо, което потребителите често затрудняват, като например компютърно приложение, трябва да предоставите подходяща информация и подробности по разбираем начин.
Стъпка 2. Създайте ръководство, което отговаря на нуждите на потребителя по начин, който той може да разбере
Ако потребителите не са технически запознати хора, най -добре е да избягвате високотехнологичен език и да давате ясни и прости обяснения. Текстът също трябва да бъде организиран по начин, който наподобява начина, по който потребителят мисли. Изброяването на продуктови характеристики, групирани по функции, често има повече смисъл, отколкото от най -често използваните функции.
Понякога използването на технически термини е неизбежно, например за приложения за графики, които включват диаграми на Фибоначи, заедно с кръгови диаграми и по -често срещаните стълбови диаграми. В такъв случай би било по -добре да дефинирате термините и да предоставите информация, например обяснение за това какво представлява диаграмата на Фибоначи и как се използва във финансовия анализ
Стъпка 3. Опишете проблема, който потребителят се опитва да реши, след това предоставете решение на този проблем
Предлагането на функции като решения на често срещани проблеми е добре, когато рекламирате продукт, но след като клиентът притежава продукта, той или тя трябва да разбере как да го използва. Определете проблема, който потребителят ще срещне, опишете го в ръководството за потребителя, последвано от инструкции за решаването му.
Ако проблемът е сложен, разделете го на по -малки парчета. Запишете всеки раздел с инструкции как да го решите или да се справите с него, след което следвайте един друг по ред. Разбиването на информация по този начин е известно като метод за групиране или разделяне
Част 2 от 3: Компоненти на ръководството за потребителя
Стъпка 1. Създайте подходяща корица и заглавна страница
Ще ви е необходима корица за всяко ръководство за потребителя, което е повече от референтна карта, и заглавна страница за ръководство, което включва повече от сгънат лист хартия (с дължина 4 или повече страници).
- Ако ръководството е защитено с авторски права, бележката за авторските права трябва да бъде включена на предната и задната корица, както и на заглавната страница.
- Ако има условия за използване на ръководството и свързаните с него продукти, моля, включете ги във вътрешната страна на предния капак.
Стъпка 2. Поставете препратка към съответния документ във въведението
Ако има повече от едно ръководство за потребителя, моля направете препратка към друг документ, включително правилния номер на версията, тук. Предговорът е също място за поставяне на раздела „Как да използвате това ръководство“, ако има такъв.
Стъпка 3. Включете съдържание, ако ръководството е по -дълго от 10 страници
Стъпка 4. Поставете инструкции/процедури и справочни материали върху тялото на ръководството
В повечето случаи както процедурата, така и референтният материал трябва да имат своя собствена секция. Можете обаче да кажете на потребителите да се позовават на конкретно съдържание в един раздел и да го разграничат от други раздели. По този начин потребителят може бързо да намери информацията, която търси.
- Процедурите трябва да бъдат написани в последователна структура в инструкциите в ръководството. Започнете с преглед на функционалността на продукта, след това обяснете какво трябва да направи потребителят и какви резултати ще получи или види. Стъпките трябва да бъдат номерирани и да започват с глагол за действие, както и как стъпките са написани във всеки раздел на тази статия.
- Справочният материал може да включва контролни списъци, съвети за отстраняване на неизправности и често задавани въпроси. Речник и индекс могат да бъдат добавени в края на ръководството, въпреки че в началото може да бъде предоставен речник на често използваните термини. Индексът може да бъде пропуснат, ако ръководството има по -малко от 20 страници.
Стъпка 5. Използвайте графични изображения, за да поддържате текст
Графичните изображения или екранните снимки могат по -добре да илюстрират определени точки в ръководството, отколкото текст, особено в сложни процедури, при които потребителите се нуждаят от визуално потвърждение, за да се уверят, че следват стъпките правилно. Графични чертежи могат да бъдат създадени с помощта на компютърно подпомагано изготвяне (CAD) или приложения за редактиране на графики, цифрови фотоапарати и приложения за обработка на снимки, или ако искате да използвате екранни снимки, използвайте функциите за екранни снимки, вградени във вашия компютър, или графична програма с възможности за заснемане на екрана.
- След като създадете графично изображение, запишете го в компресиран формат, за да можете да го използвате в приложение за текстообработка или настолно публикуване. Също така трябва да намалите размера на изображението, за да пасне по -добре на страницата, но все пак да предоставите пълна подробност за потребителя. (Ако е необходимо, можете да изрежете оригиналното изображение в секции и да покажете съответните раздели заедно с поддържащия текст).
- Ако използвате няколко графични изображения в процедурата, уверете се, че изображенията са създадени с постоянен размер, или със същите размери по дължина и ширина, или пропорционално на размера на оригиналното изображение. По този начин изображението ще изглежда по -привлекателно за потребителите. Същото важи и когато правите екранни снимки от компютър; уверете се, че компютърът показва стандартната цветова схема, когато правите снимки, в противен случай съветникът ще покаже цветна екранна снимка.
- Докато приложенията за редактиране на изображения като Photoshop и Paint Shop Pro имат добри възможности за заснемане на изображения, програмите, посветени на правенето на екранни снимки като Snagit, също предлагат възможност за лесно модифициране, каталогизиране и анотиране на екранни снимки.
Част 3 от 3: Проектиране на лесен за използване Ръководство на потребителя
Стъпка 1. Изберете някои лесни за четене шрифтове
Въпреки че компютърът може да поддържа редица шрифтове, целта на създаването на ръководство за потребителя е лесна за четене. Избирането на няколко съвпадащи шрифта е най -добрият начин за постигане на тази цел. Шрифтовете могат да бъдат групирани в два типа: засечени и безсерифни.
- Серийните шрифтове имат малки декоративни линии в краищата на основните редове, които съставят буквите. Серийните шрифтове включват Times New Roman, Baskerville и Book Antiqua. Серийните шрифтове са идеални за повечето текст, показан в размери 10-12 в основното тяло за ръководства за печат.
- Безсерифните шрифтове съдържат само линиите, съставляващи буквите, без украса. Шрифтовете, принадлежащи към групата без засечки, включват Arial, Calibri и Century Gothic. Безсерифните шрифтове могат да се използват за повечето текстови размери от 8 до 10 в PDF файлове или онлайн ръководства, въпреки че без украса прави изреченията, показани в шрифтове 12 или по -големи, по -трудни за четене. Въпреки това, шрифтовете могат да се използват ефективно в по -големи размери за показване на заглавия и заглавия, а в по -малки размери те са идеални за бележки под линия и числа в колони и таблици.
- Като цяло, най -добре е да изберете обикновен шрифт като Arial или Times New Roman за вашето ръководство, въпреки че можете да използвате декоративен шрифт за цитати или заглавия, ако пишете ръководство за видеоигра, поставена във фентъзи или научна фантастика. (В случай на цитати често можете да използвате обикновен шрифт и да покажете пълния цитат в курсив).
- След като решите кои шрифтове да използвате, създайте примерни страници, за да проверите дали изглеждат добре на хартия. Трябва също да покажете тази примерна страница на лицето, отговорно за предоставянето на одобрение за показването на ръководството, преди да продължите с процеса на писане.
Стъпка 2. Помислете за оформлението
След като изберете шрифт за ръководството, ще трябва да решите как да структурирате съдържанието в горната част на страницата.
- Като цяло вероятно трябва да поставите заглавието на документа или заглавието на главата в долния или долния колонтитул, може би като използвате заглавията на ръководството вляво на страницата и заглавията на главите вдясно на страницата. Трябва да поставите номера на страницата в горния или долния колонтитул, отвън (горен или долен колонтитул) или центриран (само в долен колонтитул). Може също да се наложи да различите първата страница на всеки раздел или глава от другите страници, като поставите номера на страницата в средата на долния колонтитул и следващата страница във външния ъгъл на заглавката.
- Може да се наложи да направите вмъкнатия текст в цветна кутия или блок, за да го различите от останалия текст. Уверете се, че сте избрали цвят или ниво на блокиране, така че да не затруднява четенето на текста.
- Оставете доста широк ръб от всички страни, с допълнително пространство по краищата, което трябва да бъде свързано.
Стъпка 3. Помислете за типа том за ръководството за потребителя
Ако ръководството е по -дълго от 4 страници, страниците трябва да бъдат подвързани по определен начин. Въпреки че вътрешните документи могат да бъдат телбодени с телбод в ъгъла на страницата, външното ръководство за потребителя, което се доставя с продукта, обикновено се телбоди по един от следните 3 метода:
- Методът с телбод отстрани (захванат отстрани на страницата със телбод) за водачи, отпечатани върху сгъната хартия 21 x 27,5 cm, 21 x 35 cm или 27,5 x 42,5 cm. Повечето евтини ръководства с 48 или по -малко страници са подвързани по този начин.
- Методът за шиене на седлото (зашит отстрани на страницата) се използва по-често за справочници на трети страни, отколкото ръководства, включени в продукти, различни от автомобили, въпреки че някои по-дълги водачи са обвързани по този начин. (Ръководството на Paint Shop Pro първоначално включваше ръководство за шиене на седло, докато все още се произвежда от JASC Software).
- Спиралното свързване е най-подходящо за водачи, използвани в по-тежки среди, като например на открито (в този случай методите за странично зашиване и зашиване на седлото не са достатъчно здрави, за да причинят подхлъзване на страници). Някои ръководства със спираловидни подвързии могат също да имат страници, които са ламинирани с пластмаса, за да не се повредят при намокряне или излагане на кал.
Стъпка 4. Създайте шаблон документ за насоки
Много текстообработващи и настолни приложения за публикуване предлагат възможност за създаване на шаблонни документи за ръководства на потребителите. Така че, докато пишете, текстът ще се показва автоматично с шрифта, който сте избрали за частта от съветника, върху който работите. (Всъщност тази статия първоначално е написана с помощта на шаблон на Microsoft Word). Повечето от тези програми включват и стандартен набор от шаблони, които можете да променяте според нуждите, за да не се налага да създавате свои собствени от нулата.
