Переконайтеся, що ви точно знаєте, що читачі посібника повинні навчитися робити.
Існує велика різниця між написанням інструкції з експлуатації, в якій пояснюється, як використовувати предмет, і того, як його ремонтувати. Якщо ви пишете інструкцію для косметологів, які використовуватимуть нову модель фена в салоні, це сильно відрізняється від створення інструкції, щоб пояснити, як обслуговувати або ремонтувати фен.
Почніть свою першу чернетку зі складання списку всіх кроків, які потрібно виконати, щоб виконати будь-яке завдання, яке, як передбачається, пояснює посібник. Після того, як ви склали список, використовуйте створений вами список кроків, щоб спробувати виконати завдання самостійно. Це допоможе вам визначити, чи достатньо списку в наявному вигляді або необхідно внести зміни. Найімовірніше, ви зрозумієте, що потрібно додати ще кілька кроків або що деякі з перерахованих пунктів потрібно розбити на кілька кроків. За необхідності внесіть зміни і продовжуйте працювати з інструкціями, поки вони не стануть легкими для виконання.
Візьміть свою останню чернетку і використовуйте свої навички технічного письма, щоб перевести їх у практичну частину керівництва. Почніть з повного списку матеріалів, щоб читачам було легко зібрати те, що їм потрібно. Для цього підходять марковані списки. Фактичні кроки мають бути представлені у вигляді пронумерованого списку, якого читачі можуть дотримуватися крок за кроком.
Після того, як кроки буде викладено, подумайте, де графічні елементи можуть допомогти читачам слідувати їм і застосовувати їх. Розробіть відповідні діаграми, графіки або ілюстрації для включення в текст разом із кроками. Розмістіть їх на сторінці, щоб читачі могли чітко бачити, яка частина письмових інструкцій відповідає кожному зображенню. Якщо ви не можете розробити графіку самостійно, зверніться до ілюстратора або художника-графіка.
Після того, як основна частина інструкції (власне інструкції) буде написана, зосередьтеся на розробці інших розділів теми. Як мінімум, вам знадобиться вступний розділ і висновок.
Введення в посібник користувача зазвичай починається з подяки користувачам за вибір продукту і загального огляду продукту.
Висновок зазвичай закінчується подробицями про те, як зв'язатися з компанією, а також інформацією про гарантію та будь-які заяви про відмову від відповідальності, які можуть знадобитися.
Також може бути корисно включити розділ поширених запитань та/або керівництво з усунення неполадок.
Посібники користувача мають бути стислими і докладними. Хоч би які розділи було включено, вони мають бути написані в технічному стилі письма, орієнтованому на передачу максимального обсягу інформації якомога меншою кількістю слів. Ніколи не рекомендується бути багатослівним тільки для того, щоб додати змісту і зробити посібник довшим. Якщо на процедуру можна відповісти лише кількома реченнями, краще залишити все як є. Будьте стислими, переходячи до суті та відповідаючи на всі важливі питання, які необхідно вирішити. Викладайте деталі, але враховуйте кожне слово. Занадто багато слів може спричинити інформаційне перевантаження.
Переконайтеся, що вся інформація в посібнику користувача правильна. У посібниках користувача немає права на помилку. Хоча точність важлива під час написання будь-якого тексту, вона справді важлива під час написання керівництва користувача. В інструкціях обов'язково має бути чітко вказано, як використовувати конкретне обладнання або дотримуватися певної процедури. Перевірте все на точність, включно з усією термінологією, порядком кроків і ясністю мови.
Вичитайте уважно, щоб переконатися, що ваш документ не містить усіх видів помилок, включно з орфографічними, пунктуаційними та граматичними. Друкарські та інші помилки можуть заплутати читача. Вони також погано відображають бренд, компанію або продукт.
Охоплення всієї ключової інформації, необхідної читачам, має вирішальне значення для керівництва користувача, але документ також має бути зручним для користувача і легким для розуміння. Це означає форматування документа з урахуванням зручності читання.
Виберіть відповідний шрифт, не використовуйте шрифтом менше 10, залежно від вашої аудиторії вам може знадобитися більший шрифт.
Надайте до продукту справжній посібник користувача, не змушуйте людей читати pdf.
Переконайтеся, що інструкції дійсно відповідають продукту в усіх відношеннях.
Подайте інструкції у вигляді покрокових інструкцій.
Розкажіть користувачеві, які є функції і для чого вони потрібні, а не тільки як їх використовувати.
В інструкції уникайте реклами.
Пишіть посібник користувача синхронно з графіком розробки продукту, а не під тиском термінів доставки.
Візьміть до уваги потреби користувачів з обмеженими можливостями (наприклад, слабозорих, дальтоніків), якщо це продукт для побутового застосування та надайте альтернативні посібники, написані шрифтом Брайля, великим шрифтом, аудіо тощо.
Протестуйте продукт і посібник користувача на реальних користувачах (включно з користувачами з обмеженими можливостями).
Багато користувачів ніколи не доходять до керівництва користувача. Його часто відкидають, вважаючи другорядним або просто занадто складним.
Уникайте зовнішнього вигляду підручника (альбомне форматування може бути менш небезпечним).
Використовуйте папір, що відповідає якості продукту.
Цілеспрямовано й ефективно використовуйте колір.
Посібник користувача не має бути надто великим, але для світлодіодного світильника це один об'єм, а для верстата з ЧПУ інший.
Ефективно використовуйте картинки та діаграми.
Включіть номер служби підтримки.
Використовуйте мову, зрозумілу для споживача.
Дуже важливо, щоб інструкції були легко читабельними та зрозумілими для всіх користувачів. Багато посібників користувача містять інструкції, які є неповними, неправильними або просто не мають відношення до фактичного продукту.
