Прокачайся в код-рев’ю: для перших 50 учасників — курс безкоштовний

час читання: 2 хв

Як створити корисний посібник користувача

Написання посібника користувача може виявитися справжнім викликом через складність продукту або процесу, а також через технічну мову, яку може бути важко зрозуміти пересічному користувачеві. У цій статті є 10 порад, як створити зрозумілий і стислий посібник користувача.

Автор цієї статті — контент-редактор EPAM Френк Вольтас.

Вступ

Що робить більшість, повертаючись додому з ІКЕА? Так, ігнорує інструкції й одразу ж починає збирати меблі. Для когось це може спрацювати, а для когось стає випробуванням на міцність стосунків або повним розчаруванням.

У професійному світі люди часто використовують один і той самий підхід, коли йдеться про користування продуктом чи послугою. Завдання авторів полягає у створенні інформативних і зручних для користувача інструкцій, які водночас заохочують до прочитання.

У цій статті я ділюся найкращими практиками, які допоможуть вам написати вдалий посібник користувача.

10 порад, як створити корисний посібник користувача

1. Подумайте, хто ваша аудиторія

Перш ніж написати на папері хоч одне слово, подумайте, хто ваша аудиторія. Для кого ви пишете цей посібник? Який у цих людей рівень освіти, ким вони працюють, які, вірогідно, мають знання з цієї теми? Чи володіють вони мовою, якою ви пишете? Адаптування посібника до конкретних потреб вашої цільової аудиторії забезпечить його доступність, цікавість і легкість його сприйняття.

2. Ознайомтеся з продуктом чи послугою

Це може здатись очевидним, але перш ніж почати писати, варто переконатися, що ви певним чином знайомі з продуктом або послугою на практиці. Або принаймні попитайте в людей, які знайомі, і попросіть їх окреслити важливі теми.

3. Структуруйте зміст

Зміст посібника користувача має бути логічно структурований. Можливо, корисно буде відокремити загальну частину, призначену для всіх користувачів, а потім надати додаткову, спрямовану на щось конкретне та більш детальну інформацію для досвідчених користувачів у окремих розділах або пов’язаних документах.

4. Використовуйте чітку та лаконічну мову

Поставте себе на місце вашої аудиторії й пишіть так, щоб інформацію було легко сприймати та цікаво читати. Намагайтесь уникати довгих абзаців, натомість використовуйте маркери чи нумеровані списки. Мова має бути якомога простішою, повсякденною, а також слід уникати жаргону.

5. Додайте детальні інструкції

У користувачів має бути можливість дотримуватись інструкцій крок за кроком, тому надайте достатньо деталей. Якщо є кілька способів виконання завдання, можливо, краще буде описати лише найпростіший метод, щоб уникнути плутанини. Додаткову інформацію для досвідчених користувачів можна надати в окремих розділах або пов’язаних документах.

6. Оформлення та візуальні ефекти

Ваш посібник користувача має бути оформлений гарно та послідовно. Ідеться, зокрема, про чіткий шрифт, помірне й логічне використання кольорів та уникнення надто довгих абзаців.

Хороша візуалізація, як-от таблиця чи скріншот, може бути кращою за тисячу слів. Використовуйте візуальні ефекти для ілюстрування своїх тез і коментарі для надання покрокових інструкцій.

7. Створіть розділ FAQ

Створіть список поширених запитань і відповідей, який користувачі легко знайдуть.

8. Забезпечте перевірку та оновлення

Перш ніж опублікувати посібник користувача, попросіть колег, а бажано також одного чи кількох представників цільової аудиторії, вичитати його. Зробіть виправлення відповідно до їх зауважень.

Після публікації посібник слід регулярно переглядати та оновлювати. Мало що дратує користувачів більше, ніж неповна або застаріла документація.

9. Додайте глосарій та алфавітний покажчик

Якщо розмір посібника не порушить при цьому встановлені межі, додайте зміст й алфавітний покажчик. Зміст допомагає користувачам зрозуміти структуру документа й легко знайти тему, яка їх цікавить. Алфавітний покажчик тем може бути корисним, якщо посібник користувача великий.

10. Просувайте свій посібник

Ви можете створити чудовий посібник користувача, але якщо ним ніхто не користується, то який у цьому сенс? Наголошуйте на його існуванні на сайтах, в інформаційних розсилках та під час тренінгів.

Висновок

«Ніхто не має на це часу» — саме так багато людей думають про читання посібників користувача. Я не маю ілюзій, що це коли-небудь повністю зміниться. Але за допомогою порад із цієї статті ви зможете написати хороший посібник, яким люди будуть із задоволенням користуватися. Це допоможе звести до мінімуму кількість запитів до служби підтримки й забезпечить позитивний користувацький досвід.