Как да направите ръководство за употреба: 12 стъпки

Ръководството на потребителя е книга за хартия или цифрова среда (в PDF или XPS формат), в който инструкциите за използване на нещо или описва правилната процедура за извършване на процес. Въпреки че когато човек чува фразата "упътване", Обикновено представлява ръководство за използването на конкретна програма, ръководство за експлоатация на компютърни и домакински уреди (телевизори, стерео системи, телефони, MP3 плейъри, градинско оборудване и и t.Д.Чест. Доброто ръководство разказва за основните функции на устройството или програмата и обяснява как да ги използвате правилно и информацията обикновено е добре структурирана. Тази статия ще разбере за това, което е важно да запомните, когато създавате и изпълнявате ръководството за потребителя.

Стъпка

Част 1 от 3:

Създаване на документация

един. Определете кой читател. За да създадете добро ръководство за потребителя, трябва да разберете кой човек ще купи устройството, на което създавате инструкции. Можете да запишете мислите си, но можете просто да си представите този човек. Полезно е да направите, ако работите като екип, за да създадете документация и ако участвате в разработката на продукта от самото начало до края. Помислете за следното:

Където човек ще използва ръководството за експлоатация: у дома, на работа, в колата, в интернет? Това ще определи не само съдържанието, но и стила на документацията.
Като човек ще използва инструкциите? Ако дадено лице се нуждае само от време на време в ръководството за потребителя, това означава, че инструкцията трябва да бъде оформена в компресирана форма. Ако ръководството често се използва, особено в самото начало, трябва да включите цял раздел как да започнете да използвате устройството или софтуерния продукт и да опишете всички най-важни функции.
Колко опит трябва да има човек? Ако вашият продукт е сравнително нов или значително различен от подобни продукти, ще трябва да включите информация за това как този продукт се различава от аналозите и предоставя на потребителя подробни инструкции. Ако стоките са свързани с чести проблеми (например с голям брой програми), опишете какво трябва да се направи, когато възникне проблемът.

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 2

2. Пишете, така че читателят да ви разбере. Ако само вашият продукт не предполага тесни познания за потребителя, по-добре е да се избягват технически термини и да опише всичко просто, разбираем език. Структурата на текста трябва да отговаря на последователността на въпросите, които могат да възникнат от потребителя. По-правилно е да се групират функциите на устройството в зависимост от задачите, които изпълнява и изоставя идеята за обединяване в една група от най-популярните функции.

Понякога е невъзможно напълно да се изключат техническите термини (например, ако правите инструкции към програмата за създаване на графики и диаграми, където в допълнение към стандартните фондове се използват и графични инструменти на Fibonacci). В този случай е полезно да се определи терминът и кратко описание (т.е. какво е графиката на Фибоначи и как се използват при анализа на финансовите показатели).

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 3

3. Опишете проблема, с който потребителят може да срещне, и след това да предложи решение. Когато рекламирате някакъв вид продукт, фрази за това как той може да реши определен проблем, несъмнено ще привлече много внимание. Но когато потребителят купува този продукт, той трябва да обясни какво да прави с него. Опишете, с какви проблеми потребителят може да срещне по време на работа и да включва в ръчни инструкции за текущите проблеми.

Ако проблемът е сложен, прекъснете го на няколко части. Направете списък и придружете всяка позиция инструкции. Това се нарича блокове.

Част 2 от 3:

Композитни части от ръководството за потребителя

един. Помислете за корицата и дизайна на първите страници на раздели. Трябва да създадете капак, ако инструкцията отнеме няколко страници. Също така ще бъде необходимо да се поставят страници с името на разделите за инструкции, където общото количество информация отнема повече от 4 страници.

Ако ръководството за потребителя е защитено с авторско право, съответната индикация трябва да бъде на корицата и на преградните страници.
Ако ръководството на потребителя осигурява определени условия за използване на продукта и инструкциите за него, поставете тази информация от вътрешната страна на капака.

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 5

2. Връзки към допълнително място за документация във въведението. Ако ръководството се състои от няколко брошура, посочете всички броя брошури в началото. В допълнение, тя трябва да постави и раздел "Как да използвате това ръководство за потребителя", Ако решите, че такъв раздел е необходим.

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 6

3. Ако броят на страниците надвишава 10 броя, ще ви трябва съдържание.

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 7

4. Основата на ръководството за експлоатация трябва да бъде инструкции и информация за компонентите на стоките. Като правило инструкциите са разбити на блокове и във всеки блок можете да посочите в кои раздели потребителят трябва да търси тази или тази информация. Така че потребителят ще бъде по-лесен и по-бърз, за да намери необходимата информация.

Процесите трябва да бъдат описани ясно и последователно. Започнете с общото описание на задачата, след което обяснете, че потребителят ще трябва да направи и какъв резултат ще трябва да получите. Всички стъпки трябва да бъдат номерирани и предложенията трябва да започнат с глаголите.

Референтните материали трябва да включват списък на функциите, методи за диагностициране на грешки и често задавани въпроси. В края на ръководството на потребителя можете да направите кратък речник на термините и азбучния указател, въпреки че основните термини често се правят в началото. Азбучния показалец се препоръчва за инструкции, чийто обем надвишава 20 страници.

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 8

пет. Използвайте изображения и схеми. Чертежите и скрийншота могат да опишат определени процеси по-добре от текста, особено когато идва от сложни процеси, където трябва да имате визуално потвърждение, че човек прави всичко правилно. Графичните изображения могат да бъдат създадени в специални програми: в системите на дву- и триизмерен чертеж, в графични редактори, в приложения за обработка на снимки и др.Д. Ако трябва да се направят снимки на екрана, те могат да бъдат получени чрез персонала на компетентността и графичната програма с възможност за запазване на скрийншота.

След като получите графично изображение, запазете го в компресиран формат. Може също да се наложи да намалите размера на картината, така че да е поставен на страницата, но размерът не трябва да бъде твърде малък, тъй като в противен случай потребителят няма да може да обмисли как и какво трябва да се направи. Ако е необходимо, можете да разбиете изображението на няколко части и да опишете всеки от тях.

Ако използвате няколко изображения, те трябва да имат същия размер, пропорция и резолюция. Такива изображения ще бъдат по-разбираеми и приятни на читателя. Когато създавате снимки на екрана, уверете се, че използвате стандартната цветова схема (за случаи, когато ръководството е отпечатано в цвят).

Въпреки че графичните редактори (например, Photoshop и Paint Shop Pro) са удобни за създаване на снимки на екрани, по-добре е да се използват специални програми (например, Snagit), тъй като те им позволяват да бъдат незабавно и лесни за редактиране, запазване и подписване на всички Изображения.

Част 3 от 3:

Регистрация на ръководство

един. Изберете четлив шрифт. Въпреки че компютрите поддържат различни шрифтове, ръководството на потребителя трябва да бъде добре четимо, така че дайте предпочитания най-простата. Най-добре е да изберете няколко шрифта, които изглеждат добре заедно. Има два вида шрифтове: със серифи и без маратонки.

Шрифтовете със серифи имат малки тирета по ръбовете на линиите. Такива шрифтове включват Times New Roman, Baskerville и Book Antiqua. Такива шрифтове ще отговарят на големите обеми текст, отпечатани с 10 или 12 размера и компонент на ръководството за потребителя.
Шрифтовете без маратонки имат прости линии без декорации. Това са шрифтове като Arial, Calibri и Century Gothic. Шрифтовете без серифи са по-добре да гледат в текстове, отпечатани с 8 или 10 шрифта в PDF или уеб ръководства за документи. Колкото по-голям е шрифтът, толкова по-трудно е да го прочетете без маратонки. Въпреки това, тези шрифтове могат да се използват за голям текст - например за набор от заглавки. Шрифтовете за източване са подходящи за цифрово набиране в таблици и колони.
Трябва да изберете прости шрифтове като Arial или Times New Roman, въпреки че някой по-сложен шрифт е подходящ за оферта. Ако напишете ръководство за потребителя за игра Fantasy, можете да маркирате с заглавие на сиропиталището. Допуска се и да шият цитат в курсив.
След като изберете шрифтове, създайте тестова страница, за да сте сигурни, че тези шрифтове са комбинирани един с друг на хартия. Покажете тази страница на човек, който одобрява оформленията, преди да предоставите ръководството за потребителя за печат.

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 10

2. Помислете за схемата за местоположение на информационните блокове. На този етап трябва да решите каква информация е поставена информация.

Като правило, името на ръководството за употреба и имената на главите се поставят върху горната или долната част на страницата заедно с номериращи страници. Фигури могат да бъдат разположени отвън (за горната и долната част на страницата) или в средата (за NIZA). Първата страница на всяка секция може да се различава от останалите, така че можете да поставите броя на страниците си в средата на дъното и номерата на всички останали страници - отвън.

Отделни фрагменти от текста могат да бъдат изолирани чрез цвят, като ги поставите в специални блокове. Важно е да изберете такъв нюанс, който няма да отбележи текста.

Оставете доста големи тирета от всички страни. От свързването на тире трябва да бъде по-широк.

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 11

3. Помислете за вида на свързването. Ако в ръководството за потребителя има повече от 4 страници, ще ви е необходим задължителен. Документите за вътрешно ползване обикновено се закрепват в ъгъла в ъгъла, но ако инвестирате ръководството си към кутията със стока, ще трябва да се приближите до този въпрос по-отговорно. Има три вида задължителни:

Свързваща скоба. Този тип е подходящ за брошури с размери 21x 27.5 cm, 21x35 cm или 11 x 27.5x42.5 cm. Най-евтините инструкции за употреба, които се състоят от 48 страници и по-малко преплетени по този начин.

Обвързващ вакидка. Така че преплитайте повечето от обичайните инструкции за употреба, без да преброявате инструкциите за автомобили, въпреки че някои дълги лидери също се преплитат по този начин. Първоначално бе снабден с такова ръководство за потребителя.Чест

Свързване с телешка спирала. По този начин ръководствата, които се използват в по-тежки условия, са преплетени, например, на улицата, където скобите могат лесно да се счупят или разпръснат. В някои инструкции за употреба с такова свързване са открити ламинирани страници, които не са мокри и не замърсяват в мръсотията.

Изображение, озаглавено Създаване на ръководство за потребителя Стъпка 12

4. Вземете документа. Повечето текстови редактори и програми за публикуване на текст в интернет има възможност за оформление. Тъй като въвеждате текста, той автоматично ще се покаже в избрания шрифт. (Тази статия първоначално е написана с помощта на шаблон в Microsoft Word.) Тези програми също имат готови шаблони, които можете да промените, като се вземат предвид вашите нужди, вместо да създавате модел от нулата.

В текстовите редактори и програми за публикуване на текст в интернет има и функция за създаване "стилове", Спестяване на шрифтове и задачи за работа за таблици и долни материали и основен текст. Можете да избирате от вече съществуващи стилове ("Дял1. t", "Обичайност", "Цитат") или създайте свой собствен стил и го дайте името си. Препоръчително е да се обадете на стилове по същата система, както е предвидено в програмата. (Например, Microsoft Word създава такива имена като "Дял1. t", "Заглавие2"- В допълнение, все още има субтитри.) Конфигурирайте програмата предварително, така че да не се налага да се връщате към него, когато ще напишете писане на текст.

Съвети

Ако е възможно, използвайте кодове на полета или текстови променливи. Можете да промените техните стойности (например името на продукта, името на главата на ръководството на потребителя) и да ги поставите в документа на мястото, където обикновено се премествате на думите ръчно. Когато направите предварителен преглед на документа или го подгответе за печат, желаният текст ще се включи в променливи. Ако името на стоките се променя или ако решите да промените името на главата, ще бъдете по-лесни за промяна на текста, като замените стойността на променливата.