Зміст

• Крок
• Частина 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. Використовуйте активний голос. Активний голос - це спосіб письма, який пояснює речі з точки зору користувача. Це легше зрозуміти, ніж альтернативу, пасивний голос, у якому суб’єкт невизначений.
   • Спробуйте додаток Хемінгуей (www.hemmingwayapp.com), щоб визначити пасивні уривки у своєму тексті.
   • Вивчіть ці два зразки речень - перший активний, а другий пасивний:
     • Ви повинні відкривати упаковку повільно і обережно.
     • Пакет слід відкривати повільно та обережно.
4. Напишіть нумеровані інструкції. Числово впорядковані інструкції допомагають читачеві краще зосередитись на процесі використання, підключення або побудови продукту, про який йде мова. Замість того, щоб писати довгий багатослівний абзац або серію ненумерованих абзаців, напишіть свій посібник користувача простими, чіткими кроками, кожен з яких чітко пронумерований.
5. Починайте кожен крок з імперативу. Імператив - дієслово, орієнтоване на дію. Починаючи кожен крок з дієслова, ви даєте читачеві підказку про дію, необхідну для завершення кроку. Наприклад, залежно від продукту, про який ви пишете, ви можете розпочати кроки командою типу "Підключитися", "Підтвердити" або "Слайд". Однак не починайте кроки з відповіді системи.
   • Наприклад, якщо екран стає синім і починає блимати, не починайте крок з: "Екран блиматиме і стане синім." Спробуйте: "Натисніть і утримуйте клавішу додому. Екран блиматиме і стане синім ".
6. Визначте, який словниковий запас ви будете використовувати. Якщо ви пишете посібник з йо-йо, вашою аудиторією будуть переважно маленькі діти. Використовуйте прості слова та словниковий запас, щоб пояснити, як працює йо-йо. Коли ви пишете посібник зі скануючого електронного мікроскопа, ваша аудиторія складається з висококваліфікованих вчених, які можуть розуміти дуже детальну інформацію, тому не уникайте використання спеціалізованої лексики або нюансних пояснень.
   • Загалом, ви намагаєтесь уникати жаргонізму та технічної мови.
   • Щоб бути ефективним для якнайширшої бази користувачів, спробуйте писати на рівні з шостого по сьомий клас початкової школи.
7. Відправляючи товар за кордон, переконайтесь, що ваші переклади є точними. Наймайте перекладача, щоб перекласти посібник користувача на рідну мову країни, куди ви відправляєте товар. Ви також можете скористатися онлайн-програмою перекладу, але попросіть носія мови прочитати переклад та перевірити наявність помилок.
   • Якщо у вашій аудиторії представлено кілька мовних груп, включте переклади посібника користувача на кожну відповідну мову.
   • Перекладач повинен бути добре знайомий з продуктом, оскільки в цільовій мові можуть бути різні слова для конкретних термінів, які не є перекладом від слова до слова.
8. Запишіть короткими реченнями. Замість кількох довгих абзаців ви використовуєте багато коротких абзаців. Шукайте логічні розриви в кожному розділі та перетравлюйте корисну інформацію фрагментами з одним або двома реченнями. Те саме стосується рівня речень. Нехай ваші речення будуть короткими та простими, а не довгими та багатослівними.
   • Якщо крок стає занадто довгим, розбийте його на менші кроки. Це не зменшить кількість слів, але розриви рядків полегшать читання.
9. Перевірте посібник на наявність помилок. Посібник може втратити довіру через граматичні та орфографічні помилки. Нехай колега чи технічний письменник також відредагує та вичитає посібник. Окрім орфографії та граматики, коректору слід звернути увагу на наступне:
   • Пасивний стан
   • Неясна або заплутана мова
   • Загорнута структура речень
   • Надто довгі абзаци

Поради

• Люди вчаться по-різному; Якщо можливо і доречно, включіть у посібник наочні посібники або посилання на відеоролики в Інтернеті, щоб розмістити читачів, орієнтованих на візуальний орієнтир.