Документація, орієнтована на користувача. Як створити цікавий і доступний контент

Привіт! Мене звати Оксана і я Technical Communicator у компанії SoftServe. Я люблю робити життя звичайних користувачів різних цифрових продуктів простішим, створюючи корисну, сучасну і зручну у використанні технічну документацію.

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

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

«Портрет» користувача

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

• Хто є цільовою аудиторією продукту (послуги)?
• Які технічні знання та навички має більшість користувачів? Якою мірою вони володіють технологіями, що використовуються у продукті?
• Які проблеми можуть виникнути у користувача, коли він буде встановлювати, налаштовувати і використовувати продукт?
• Для чого саме люди використовують продукт? Які проблеми вони прагнуть вирішити?

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

Чіткість і простота

Головна мета будь якої документації — зробити так, щоб складне ставало простим. Для цього краще використовувати базові і зрозумілі широкій аудиторії поняття. До того ж, необхідно також користуватися довідниками стилю (style guides.) Якщо ви пишете інструкції англійською мовою, то краще використовувати Simplified Technical English.

Іноді менше означає краще. Розглянемо наступний приклад, який демонструє силу спрощення.

Наприклад, порівняйте таке:​

Незрозуміло:

Використовуйте XYZ для створення екземпляра моделі даних.

Зрозуміло:

Щоб створити нову модель даних, виберіть XYZ.

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

Більше того, документів не має бути дуже багато. Наприклад, на одному з проєктів ми створювали одночасно три окремих документи: інструкція з встановлення/інсталяції, користування (user guide), та реліз ноути (release notes). Користувачі мали деякі складнощі, що саме і де їм потрібно шукати. Після того, як ми три документи об’єднали в єдину інструкцію, отримали багато позитивних відгуків — документацію почали використовувати частіше й ефективніше.

Аналіз причин

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

Розглянемо приклад:

Погано:

«На сторінці Документи, ви бачите кнопки Створити, Завантажити, а також список усіх документів, разом із їх назвою, розміром, та датою завантаження.»

Краще:

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

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

Стилі навчання

Як ви, можливо, вже знаєте, існує чотири основних стилі навчання: візуальний, аудіальний, читання/письмо та кінестетичний. Тобто, користувачі можуть мати абсолютно різні навички сприйняття матеріалу. Що я роблю в такому випадку?

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

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

Візуалізація

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

Наприклад, як легко скласти меблі IKEA? Використовуючи покрокові зображення і текстові інструкції, із купи деталей можна швидко зібрати столик і полиці.

Інтерактивність

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

Щоб ви вибрали — читати довгий текст чи використати онлайн форму з випливаючими підказками, стрілками і різними інтерактивними елементами? Звичайно, інтерактивні інструкції сприймати легше. Але водночас, їх створення, як правило, дорожче. Також такі інструкції оновлювати складніше і довше, ніж звичайний текст.

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

Доступність і безбар’єрність

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

• Використовуйте описовий alt текст для зображень.
• Надавайте текстові альтернативи для аудіо-візуального контенту.
• Переконайтеся, що вашу документацію можна переглядати за допомогою клавіатури (для користувачів, які не використовують мишку.)

Локалізація

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

Зворотний зв’язок

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

Спільноти користувачів

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

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

Співпраця між командами

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

На жаль, дуже типовими на проєктах є такі ситуації:

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

Всі ці моменти легко виправити при налагодженні комунікації між командами.

Підсумки

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

А що для вас найголовніше в технічній документації? Як ви як техрайтер взаємодієте з вашою аудиторією?