Формат онлайн-документації
Більшість сучасних HAT-програм, таких як Dr.Explain. вміють створювати документи в різних форматах (наприклад, webhelp і PDF) з одного проекту-джерела без додаткових витрат часу з вашого боку.
Ще один важливий момент, який треба відзначити, це використання фреймів. Багато років тому, коли технології динамічного контенту (AJAX, HTML5 і т.д.) перебували в зародковому стані, фрейми здавалися вдалим способом поділу робочого вікна браузера на функціональні зони - заголовок, зміст, область контенту і т.д. Однак, зараз в їх використанні немає великого сенсу. Вони народжують, скоріше, більше проблем, ніж дають переваг. Серед проблем можна виділити такі, як - більш складна навігація і юзабіліті, незручність використання в мобільних браузерах, можливі проблеми з пошуковою оптимізацією (SEO). Практично всі сучасні програми для створення документації вміють створювати webhelp без використання фреймів без шкоди для зручності роботи з документацією.
Навігація по документації
Тому важливо показати такому "заскочити" користувачеві, в якому розділі він знаходиться, де цей розділ знаходиться в загальній структурі проекту, які є пов'язані розділи, що можна подивитися додатково і, взагалі кажучи, документацію до якого проекту він, власне, читає. Всі ці завдання можна легко вирішити, організувавши хорошу навігацію по документації.
Анотація скриншота зроблена вбудованими засобами програми Dr.Explain
Зміст
Зміст документації повинно бути доступно на будь-який її сторінці. Зміст відразу показує структуру документа, позицію поточного розділу і, найголовніше, дозволяє моментально перейти до інших розділів. Не допускайте ситуації, коли зміст зроблено окремої кореневої сторінкою документації. У такому випадку користувачеві доводиться постійно повертатися до кореневого змісту, щоб потім перейти до іншого розділу. Це не зручно. Зазвичай, таким структурним недоліком володіє документація, створена на wiki-платформах.
"Хлібні крихти" (Bread crumbs)
"Хлібні крихти" показують список батьківських розділів для даної сторінки. З їх допомогою користувач може швидко зрозуміти, в які більш глобальні розділи входить конкретна тема, і кліком перейти в один з них.
лінійна навігація
Посилання на наступну і попередню сторінки зручні при послідовному читанні документації, особливо, якщо зміст дуже велике. Лінійна навігація позбавляє користувача від необхідності кожного разу шукати очима в дереві розділів поточну тему, а потім намагатися зрозуміти, яка тема наступна.
Пов'язані розділи та підрозділи
Список пов'язаних розділів ( "Дивись також") і список підрозділів поточної теми можна розмістити в кінці сторінки. Така "добірка" допомагає користувачеві швидко знайти додаткову інформацію по цікавить його питання, не вдаючись до функції пошуку.
Брендування і інтеграція з сайтом проекту
Зручність використання
На щастя, професійні програми для розробки документації, такі як Dr.Explain. вміють створювати онлайн-довідки з повністю адаптивним дизайном, який буде одночасно підтримувати і традиційну, і мобільний верстку. Такий документацією зручно користуватися як на стаціонарному комп'ютері, так і на мобільних пристроях.
Взаємодія з користувачами
Крім основної мети - допомоги користувачам в роботі з продуктом - документація може також виконувати роль маркетингового інструменту і засоби спілкування з користувачами.
Пошукова оптимізація (SEO)
Розглядаючи маркетингову функцію онлайн-документації, тобто використання її для залучення нових користувачів і просування продукту на ринку, не можна залишити поза увагою питання SEO (Search Engine Optimization).
Онлайн-документація - це величезний масив інформації, яка описує рішення певного класу задач за допомогою вашого продукту. Люди, які шукають в інтернеті вирішення цих завдань, але ще не знайомі з вашим проектом - ваші потенційні користувачі. Прочитавши у вашій документації про те, як їх завдання можуть бути вирішені за допомогою функцій вашого продукту, вони, швидше за все, захочуть ним скористатися. Єдиний спосіб роздобути таких людей - зробити так, щоб пошукові системи - Google, Yandex, Bing і т.д. - видавали якомога частіше і ближче до початку списку посилання на сторінки вашої онлайн-довідки по фразам, пов'язаних з описом користувальницьких проблем. Наприклад, "як оптимізувати палітру PNG-зображення без втрати якості".
Технічним тонкощам пошукової оптимізації документації слід присвятити окрему статтю. Для початку ж можна зупинитися на базових принципах правильної подачі інформації.
Добре структуруйте інформацію. Розбивайте контент на закінчені семантичні розділи і теми, що описують рішення конкретних завдань. Не робіть довгих тим, що описують занадто багато відразу. Інформація на кожній сторінці повинна бути чітка і сфокусована.
Всередині сторінки також дотримуйтеся чіткої структури. Використовуйте інформативні підзаголовки різних рівнів, нумеровані списки і перерахування. Намагайтеся використовувати короткий зміст ключові слова, пов'язані з описом розв'язуваної задачі. Не лінуйтеся повністю підписувати зображення, таблиці, схеми.
Перелінковивают сторінки документації. Ставте в тексті розділу посилання на інші розділи документації, при цьому в тексті посилань, використовуйте наступні ключові фрази (наприклад, "Змінити розмір зображення"), а не слова-пустушки (наприклад, "натисніть тут" або "тут").
Створюйте кожну тему в окремому файлі з ключовими словами в імені файлу. Кожна тема вашої онлайн-довідки повинна мати унікальне ім'я файлу, а, в результаті, і унікальний URL, щоб пошуковик міг на неї послатися. Щоб підвищити рейтинг саме вашій сторінці у видачі пошукової системи, дайте їй осмислене ім'я. Наприклад, "reduce-image-size-by-limiting-colors.html" більш детально визначений назва, ніж "page_34-838-b.htm". До речі, програма Dr.Explain автоматично формує імена файлів на основі назви тем. Це зручно.
Розташування
Розташовуйте файли довідки в окремому каталозі на сайті продукту. Вашим користувачам буде простіше звертатися до документації, а вам буде простіше її підтримувати і оновлювати, так як файли онлайн-довідки не будуть перемішуватися з файлами інших розділів сайту.
доступність
Це питання легко зняти. Досить додати посилання на документацію в основне меню сайту, а також на сторінки підтримки та описи функціоналу проекту.
Не допускайте ситуації, коли користувач не може знайти документацію самостійно і єдиний шанс отримати до неї доступ - це запросити її безпосередньо в технічній підтримці.
Дотримуйтесь описаним принципам, і ви перетворите свою онлайн-документацію з простого набору нудних текстів в потужний інструмент технічної підтримки, комунікації з користувачами і просування вашого проекту на ринку. А слідувати цим принципам зовсім нескладно. Спеціалізовані програми для створення користувальницької документації, такі як Dr.Explain. вирішать за вас більшість технічних питань і дозволять вам зосередитися на найважливішому - на ваших користувачів і на вашому проекті.
ЗАВАНТАЖИТИ
БЕЗКОШТОВНО
45Mb (ZIP), Windows Vista, 7, 8, 10 - 64 Bit
