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

Підходи до тестування документації

Тестувальники знають, що існує кілька підходів до тестування. Наприклад, тестування можна проводити з двох сторін: експертна оцінка та тестування користувача.

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

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

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

Безпека на першому місці

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

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

Ця перевірка безпеки передбачає всі підводні камені, про які ви можете подумати в більшому масштабі.

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

Майте сенс

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

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

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

Допоможіть користувачам почуватися як вдома

Тепер настав час полірування. Коли весь контент готовий, час прибрати дрібниці.

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

Крім того, на цьому етапі потрібно провести фінальну перевірку орфографії та коректуру. Друкарські помилки та безглузді помилки можуть діяти на нерви користувачеві, який і так може бути не в найкращому настрої - на жаль, люди читають посібники користувача не заради розваги 🙂

Звісно, набагато простіше скористатися якимось сервісом для перевірки орфографії. Досить часто ця функція присутня в інструментах для написання документації “з коробки”. Наприклад, зверніть увагу на WYSIWYG-редактор у ClickHelp (інструмент для написання документації онлайн), він дозволяє одразу знаходити помилки, наприклад, друкарські помилки, і швидко їх виправляти.

Висновок

Це етапи, які ви повинні пройти, щоб правильно протестувати вашу документацію користувача. Щоб швидко підсумувати все:
● Проведіть перевірку безпеки - переконайтеся, що всі критичні терміни правильні; перевірте, що всі дії, які можуть викликати серйозні проблеми, описані чітко;
● Проведіть перевірку узгодженості - уважно подивіться на структуру документації, навігацію;
● Проведіть перевірку UX - переконайтеся, що ваші корпоративні стандарти UX дотримані.

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

*Про автора - команду ClickHelp

Цей гостьовий блог був написаний постачальником інструменту онлайн-документації ClickHelp. ClickHelp - це сучасний хмарний інструмент на основі браузера. Він може створювати онлайн- та друковану документацію, бази знань, PDF-документи, контекстну довідку, політики та процедури. ClickHelp поєднує в собі середовище створення документації для команд і портал документації для кінцевих користувачів.
Щоб дізнатися більше про інструмент документації ClickHelp, відвідайте цей веб-сайт: https://clickhelp.com/