Съдържание

• Стъпвам
• Част 1 от 4: Планиране на ръководството на вашия собственик
• Част 2 от 4: Вграждане на основна информация
• Част 3 от 4: Описване на поддръжката на продукта
• Част 4 от 4: Напишете четлив наръчник
• Съвети

Софтуерът, компютрите, игрите и устройствата изискват ръководства за потребителя; ръководства, обясняващи как да използвате продукта (и как да не го правите). Ръководството за потребителя е официален документ със специфична структура и трябва да бъде написано от някой, който познава продукта отвътре, като технически автор или продуктовия дизайнер. Написването на ефективно ръководство за потребителя изисква да знаете кой ще използва продукта и да напишете ръководството предвид тези потребители. Поддържайте писането си ясно, точно и лесно, за да осигурите безпроблемно потребителско изживяване.

Стъпвам

Част 1 от 4: Планиране на ръководството на вашия собственик

1. Направете потребителски анализ. Ръководството за потребителя трябва да бъде написано за потребителите - тези, които ще купят вашия продукт или услуга и ще прочетат ръководството за потребителя. Потребителският анализ ще ви каже коя ще бъде вашата основна или целева аудитория и ще ви води през писането на текста.
   • Говорете с хора, които ще използват вашето устройство. Предложете на потребителите тестови прототипи на устройството и проект на ръководство за потребителя при контролирани условия. Попитайте тези тестови потребители за обратна връзка за неща, които са неясни или объркващи в ръководството за потребителя, и направете промени във вашето ръководство за потребителя въз основа на тази обратна връзка.
   • Никога не можете да задоволите цялата си аудитория; напишете ръководството, съобразено с целевата аудитория или най-голямата аудитория.
   • Помислете за възрастта, здравето (имат ли някакви заболявания, обучителни затруднения или увреждания?) И нивото на образование на аудиторията, за да определите най-добрия подход за писане на ръководството за потребителя.
2. Координирайте дизайна на ръководството за потребителя. Ако сте били част от екипа, който е помогнал при проектирането и разработването на устройството или продукта, може да е трудно да погледнете обективно на продукта, за да обясните как работи. Следователно трябва да потърсите съвет от писател (за предпочитане някой с опит в писането на инструкции) и графичен дизайнер, който да ви помогне да подготвите ръководството за потребителя. Можете да изберете тези хора чрез външна консултантска компания или от вашата собствена компания или организация.
3. Направете анализ на задачата. Анализът на работата е процес на идентифициране и организиране на стъпките, необходими за използване на устройството. Подробният анализ на работата идентифицира материалите и оборудването (като батерии, лекарства или други продукти, доставяни от потребителя), необходими за всяка стъпка, както и действията, грешките и съветите за отстраняване на неизправности, които всяка стъпка може да изисква.
   • Ако имате продукт, който може да изпълнява много различни задачи или подзадачи, трябва да извършите анализ на задача за всяка задача. Например: в автомобил можете да тръбите, да се закопчаете и да включите или изключите фаровете си. Направете анализ на работата за всеки от тях, ако е необходимо.
4. Уверете се, че вашият продукт отговаря на изискванията за етикетиране и разрешение за пускане на пазара. Тези изисквания гарантират, че продуктите се произвеждат с оглед на безопасността на потребителя и че излагането на потребителя на опасни условия, като радиация и токов удар, е ограничено. Рекламите трябва ясно да посочват целта и основните насоки за работа на даден продукт и вие трябва да използвате тези ресурси, когато пишете ръководството на собственика си.
   • За да бъде ефективно ръководството за потребителя на продукта, то трябва да бъде написано в съответствие с етикетите, поставени директно върху продукта.
   • Уверете се, че вашето устройство е официално лицензирано за продажба, преди да напишете ръководството за потребителя.
5. Вземете решение за оформлението на вашето ръководство. Има няколко важни начина, по които можете да рационализирате ръководството си. Трябва да поставите удебелено заглавие в началото на всеки раздел с всяка дума с главни букви. Например „Настройване на вашето устройство“, „Работа с вашето устройство“ и „Отстраняване на неизправности“ могат да бъдат заглавия на разделите с получер шрифт.
   • Друг начин за опростяване на вашето ръководство е да използвате две колони, едната отдясно с текст, а другата точно вляво от текста, с маркери, цифри или малки икони, като предупредителни знаци или червени удивителни точки.
   • Ръководството може да се състои главно от изображения с някакъв текст под всяко изображение, за да се обясни устройството, или може да е предимно текст само с няколко придружаващи изображения. Можете също да използвате блок-схема, за да насочвате потребителя. Помислете за вашия продукт и как всеки метод може да ви помогне да напишете вашето ръководство. Избягвайте обаче да смесвате различни оформления в рамките на едно ръководство. Изберете един и се придържайте към него.

Част 2 от 4: Вграждане на основна информация

1. Организирайте ръководството логично. Ръководството трябва да бъде структурирано по такъв начин, че потребителят да извлече най-голяма полза от него. Разделете ръководството на глави или раздели, които имат смисъл за използване на продукта, и включете съдържание в предната част на ръководството, така че всеки раздел да може да бъде намерен бързо.
   • Съдържанието е особено необходимо за по-дълги ръководства.
   • Необходим е речник или указател, ако има много термини, които да обяснят, че вашата аудитория може да не е запозната. Речникът обаче не се препоръчва; най-добрият избор е да се обяснят объркващи термини в текста на самото ръководство. Ако решите да включите речник, поставете го в предната част на ръководството, непосредствено след съдържанието.
   • Списък с таблици или фигури е необходим само ако в ръководството има повече от няколко таблици или фигури.
   • Необходимо е приложение за неща, които трябва да бъдат обяснени, но не могат да бъдат обяснени другаде в ръководството, тъй като това би нарушило потока и фокуса.
2. Включете необходимите предупреждения. Общите предупреждения или информацията за предпазни мерки трябва да предоставят информация за потенциални опасности, причинени от неправилна употреба на продукта, включително смърт или сериозно нараняване. Тези предупреждения трябва да бъдат поставени в предната част на ръководството, след първата страница, така че потребителят да ги види първо. Конкретни предупреждения също трябва да бъдат включени в текста на ръководството непосредствено след или непосредствено преди да бъде предложена потенциално опасна стъпка.
   • Например, общо предупреждение за електрически уред може да бъде да не се използва, когато вали.
   • Конкретна инструкция може да бъде да се уверите, че ръцете и устройството ви са сухи, преди да включите устройството в контакта.
   • Предоставете изображения (като череп и кръстосани кости) или текст с различен цвят (като червен текст), за да различите предупреждението от останалите указания в IFU и да привлечете вниманието на потребителите към него.
3. Опишете устройството. Описанието ви трябва да включва както писмено обяснение на предназначението на устройството, така и малко графично представяне на това как изглежда устройството. Фигурата трябва да обозначава и да назовава всички превключватели, бутони и закрепващи се части, съдържащи се в устройството.
4. Предоставете инструкции за инсталиране. Разделът за инсталиране трябва да съдържа основна информация за това как да се подготвите за използване на продукта или устройството. Ако уредът не може да бъде изграден или настроен от домашен потребител, посочете това ясно в удебелено заглавие в горната част на инсталационния раздел. Трябва да включите и следното:
   • Списък с части
   • Инструкции за разопаковане
   • Предупреждения за инсталиране
   • Последици от неправилна инсталация
   • Кой да се обади в случай на затруднения по време на инсталацията
5. Предоставете информация за операцията. Този раздел е най-важната част от ръководството за потребителя и трябва да предоставя конкретна, подробна информация за това как да използвате устройството. Започнете с основна подготовка за използване на уреда, като включване на захранващия кабел или измиване на ръцете. Продължете с логически, номерирани стъпки, описващи как да използвате устройството, както и всякакви отзиви (например „Ще чуете щракване ...“), които потребителят може да очаква, когато правилно използва устройството.
   • В края на тази глава потребителите трябва да бъдат насочени към главата за отстраняване на неизправности, за да разрешат проблеми, които не могат да бъдат обяснени бързо.
   • Поставете изображения, където е необходимо. Някои стъпки са най-добре обяснени както със снимки, така и с думи. Помислете за използването на снимки или илюстрации във вашето ръководство.
   • В този раздел, както във всеки раздел, трябва да включите съответните предупреждения за безопасност относно неправилна употреба или експлоатация. Например можете да предупредите потребителите на верижни триони да не пият алкохол или да използват верижния трион, докато са на определени лекарства.
   • Ако смятате, че потребителите ще се възползват, помислете за включване на връзки към онлайн видеоклипове, демонстриращи правилното използване и работа на устройството. Можете да запишете тези видеоклипове или в началото на този раздел, или (в случай на видеоклипове, които илюстрират само една стъпка) в края на всяка стъпка.
6. Включете резюме на продукта в края. Резюмето трябва да се появи в края на ръководството, точно преди индекса, за да предостави основни стъпки за работа. Това трябва да бъде опростена, съкратена версия на оперативната информация и не трябва да съдържа повече от една страница. Обобщете как да се използва устройството или продукта. Включете основни предупреждения, номерирани стъпки, които обясняват как да използвате продукта, както и телефонни номера или имейл адреси, които насочват потребителите към помощ.
   • Ако очаквате потребителят често да премахва или да се позовава на обобщения лист, можете да го отпечатате на подвижна ламинирана карта или дебел картон, за да го улесните за носене и препращане към потребителя.
   • Като алтернатива можете да приложите обобщение директно към продукта за бърза и лесна справка от потребителя.

Част 3 от 4: Описване на поддръжката на продукта

1. Обяснете как да почиствате устройството. Ако вашето устройство или продукт се нуждаят от почистване, обяснете как да направите това. Избройте необходимите почистващи препарати. Кажете на читателя колко често да почиствате. След това, както във всяка друга част на ръководството, включете номерирани инструкции стъпка по стъпка как да го почистите.
   • Ако почистването изисква разглобяване на продукта или отстраняване на определена част или части, посочете как трябва да се разглоби продуктът.
   • Предоставете предупреждение за резултатите от неуспех при почистване на устройството. Например можете да кажете: „Ако устройството не е почистено, производителността ще бъде по-ниска от оптималната“.
2. Пребройте потребителя как да извърши основна поддръжка. Ако продуктът или устройството може да се използва от потребителя за коригиране на проблеми с производителността, предоставете номерирани инструкции как да направите това за потребителя. Например, ако батериите трябва да се сменят след всеки 300 часа употреба, предоставете инструкции как да проверите дали батериите трябва да се сменят, как да премахнете изтощените батерии и как да инсталирате новите.
   • Ако има определени задачи по поддръжката, които могат да бъдат изпълнени само от сертифициран техник, разделете частта за поддръжка на ръководството на две части.
3. Обсъдете опциите за съхранение. Ако е необходимо, ръководството трябва да обясни как правилно да съхранявате продукта или устройството. трябва да включите и информация за това защо е необходимо съхранението и последиците от неправилното съхранение. Например: можете да напишете:
   • Съхранявайте продукта на хладно и сухо място. Неправилното съхранение може да съкрати живота на вашия продукт поради натрупването на влага. "
   • "Не излагайте продукта на топлина и не го съхранявайте при температури над 50 градуса по Целзий.Ако го направите, това може да доведе до изгаряне. "
4. Предоставете информация за отстраняване на неизправности. Можете да организирате този раздел като списък с често срещани проблеми и техните решения. Групирайте подобни проблеми под логическо заглавие. По този начин потребителите могат бързо да намерят конкретни проблеми.
   • Например, ако има няколко проблема с компютъра, показващ син екран, ги групирайте в подзаглавие, например „Често срещани проблеми с екрана“.
   • Трябва също да включите телефонен номер и / или имейл за обслужване на клиенти в този раздел.

Част 4 от 4: Напишете четлив наръчник

1. Прочетете други ръководства за потребителя. Преди да напишете ръководство за собствения си продукт, разгледайте други ефективни ръководства за потребителя. Обърнете внимание на структурата, избора на думи и структурата на изреченията. Основни марки като Apple, Google и Microsoft създават силни, ефективни ръководства за потребителя, които могат да ви помогнат да създадете по-обмислено написано ръководство за потребителя.
   • Не просто четете всичко ръководства за потребителя. Прочетете ръководствата за подобни продукти, които продавате. Например, ако продавате бебешки продукти, прочетете ръководства за бебета, а не технически.
2. Изберете вашите стандарти. Стандартизирането на правописа, избора на думи и формулировките ще направи ръководството за потребителя по-удобно за потребителя. Ръководството за стил в Чикаго и Ръководството за стил на Microsoft също могат да бъдат полезни ръководства за стил, когато пишете ръководството на вашия собственик; проверете и двете, за да видите дали един е подходящ за вашето ръководство.
   • Например, вместо да използвате както "превключвател на захранването", така и "бутон за захранване" във вашето ръководство, изберете един от двата термина и се придържайте към него.
3. Използвайте активния глас. Активният глас е начин на писане, който обяснява нещата от гледна точка на потребителя. По-лесно е да се разбере от алтернативата, пасивния глас, при който субектът е неопределен.
   • Опитайте приложението Hemingway (www.hemmingwayapp.com), за да идентифицирате пасивните пасажи във вашето писане.
   • Изучете тези две примерни изречения - първото е активно, а второто е пасивно:
     • Трябва да отворите опаковката бавно и внимателно.
     • Опаковката трябва да се отваря бавно и внимателно.
4. Напишете номерирани инструкции. Цифрово подредените инструкции помагат на читателя да се фокусира по-добре върху процеса на използване, свързване или изграждане на въпросния продукт. Вместо да пишете дълъг, подробен абзац или поредица от неномерирани абзаци, напишете вашето ръководство за потребителя с прости, изрични стъпки, всяка от които е ясно номерирана.
5. Започнете всяка стъпка с императив. Императив е глагол, ориентиран към действие. Като започнете всяка стъпка с глагол, вие давате на читателя подсказка за действието, необходимо за завършване на стъпката. Например, в зависимост от продукта, за който пишете, можете да започнете стъпките си с команда като „Свързване“, „Потвърждаване“ или „Слайд“. Не започвайте стъпките си обаче с отговор от системата.
   • Например, ако екранът стане син и започне да мига, не започвайте стъпката с: „Екранът ще мига и ще стане син.“ Опитайте: „Натиснете и задръжте клавиша за начало. Екранът ще мига и ще стане син. "
6. Определете кой речник ще използвате. Ако пишете йо-йо наръчник, вашата аудитория ще бъдат предимно малки деца. Използвайте прости думи и лексика, за да обясните как работи йо-йото. Когато пишете ръководство за сканиращ електронен микроскоп, вашата аудитория се състои от висококвалифицирани учени, които могат да разберат много подробна информация, така че не отбягвайте използването на специализиран речник или нюансирани обяснения.
   • Като цяло се опитвате да избягвате жаргон и технически език.
   • За да бъдете ефективни за възможно най-широката потребителска база, опитайте се да пишете на ниво от шести до седми клас в началното училище.
7. Когато изпращате продукт в чужбина, уверете се, че вашите преводи са точни. Наемете преводач, за да преведете вашето ръководство на потребителя на родния език на страната, в която изпращате продукта си. Можете също да използвате онлайн програма за превод, но помолете носител на езика да прочете превода и да провери за грешки.
   • Ако във вашата аудитория са представени множество езикови групи, моля, включете преводи на ръководството за потребителя на всеки подходящ език.
   • Преводачът трябва да е запознат с продукта, тъй като в целевия език може да има различни думи за конкретни термини, които не са преводи от дума на дума.
8. Напишете с кратки изречения. Вместо няколко дълги абзаца, вие използвате много кратки абзаци. Търсете логически прекъсвания във всеки раздел и смилайте полезна информация на парчета с едно или две изречения. Същото важи и на ниво изречение. Дръжте изреченията си кратки и прости, а не дълги и подробни.
   • Ако една стъпка става твърде дълга, разбийте я на по-малки стъпки. Това няма да намали броя на думите, но прекъсванията на редовете ще улеснят четенето.
9. Проверете ръководството за грешки. Ръководството може да загуби доверие поради граматически и правописни грешки. Помолете колега или технически писател да редактира и коригира ръководството. В допълнение към правописа и граматиката, коректорът трябва да обърне внимание на следното:
   • Страдателен залог
   • Неясен или объркващ език
   • Увита структура на изреченията
   • Прекалено дълги параграфи

Съвети

• Хората се учат по различни начини; Ако е възможно и целесъобразно, включете визуални помагала или връзки към онлайн видеоклипове в наръчника, за да поберете визуално ориентирани читатели.