Як написати посібник користувача програми або сайту - інструкції, поради, допомога, програмне забезпечення

Що таке посібник користувача і для чого його створювати

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

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

Загальні поради щодо створення документації користувача

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

Після цього важливо подумати про те:

• Де користувач буде до нього звертатися: вдома, на роботі, в машині?
• Як часто він його переглядатиме?
• Наскільки об'єктивно складний розуміння продукт?

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

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

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

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

У першому розділі бажано розповісти загальну інформацію про програму:

• Навіщо створено продукт.
• Які завдання він вирішує.
• Які основні вигоди від використання клієнта.

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

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

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

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

Інструменти для швидкого створення посібника користувача

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

Одним із популярних інструментів для створення якісного керівництва є програма Dr. Explain (https://www.drexplain.ru), в якій вже є готові шаблони посібників користувача з готовою структурою розділів і в якій зручно оновлювати документацію, як часто ці оновлення не відбувалися.

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

Будь-який проект у Dr.Explain ви можете створити з нуля або імпортувати вже існуючу документацію, наприклад з формату MS Word, HTML або CHM-файлу, і буквально за кілька хвилин створити з неї онлайн-допомогу, файл довідки у форматі CHM, або документ у формат PDF.

Під час створення керівництва важливо спиратися на заздалегідь складений план.Дерево проекту в Dr.Explain допоможе структурувати документ на вашу думку. Ви можете додавати, видаляти переміщати розділи та перейменовувати їх. Для кожного розділу ви можете визначити, який формат він експортуватиметься. Також у роботі зручно використати статуси готовності розділів.

Програма має власний редактор, оптимізований під роботу зі складною документацією. Основні функції редактора винесені компактний тулбар. Це – управління стилем тексту, форматування абзаців, вставка посилань, зображень, відео, таблиць та списків, а також вставка спеціальних об'єктів. Dr. Explain заощаджує час та сили своїх користувачів. Розробники документації часто стикаються з проблемою багаторазового використання одного і того ж фрагмента тексту і вдаються до очевидних рішень - "Ctrl+c", Ctrl+v". Dr.Explain пропонує рішення щодо повторного використання контенту - текстові змінні. Це рішення економить час, коли потрібно багато разів використовувати той самий текст, особливо, який може періодично змінюватися - наприклад, версія документованої системи.

Багато російських компаній стикаються з тим, що керівництво користувача потрібно писати згідно з ГОСТ 19 та ГОСТ 34. Dr.Explain активує підтримку вимог ГОСТ фактично одним кліком. Програма автоматично сформує структуру обов'язкових розділів та встановить необхідні параметри сторінки, стилі абзаців, списків та заголовків.

Часто технічним письменникам при документуванні інтерфейсу користувача доводиться постачати зображення пояснювальними виносками. Для таких випадків програма підтримує спеціальні графічні об'єкти – анотовані екрани. Найчастіше анотуються скріншоти програм та сторінок веб-сайтів.Унікальною особливістю Dr.Explain є автоматична інструкція зображень, одержуваних при захопленні екранів з вікнами програм або веб-сайтів. Програма аналізує структуру вікон та додає пояснювальні виноски до всіх важливих елементів.

Крім того, Dr.Explain дозволяє кільком авторам одночасно працювати над проектом з використанням сервісу www.tiwri.com, обліковий запис на якому можна створити безкоштовно за пару хвилин. При внесенні правок одним автором сервіс блокує розділи проекту, що редагуються, для зміни іншими авторами. Після закінчення редагування зміни відправляються на сервер і блокування знімається. Так, кілька людей можуть одночасно працювати над різними розділами проекту без ризику перешкодити один одному.

Спробувати режим розрахованої на багато користувачів роботи в Dr.Explain можна навіть з безкоштовною ліцензією. Ви можете створити спільний проект і повноцінно працювати з ним у розрахованому на багато користувачів режимі до семи днів.

Чому компанії вибирають Dr.Explain для створення посібників користувача

Павло Свиридов, професійний військовий, полковник, творець астрологічної системи "Вега Матриця"

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

Наталія Обухова, бізнес-аналітик компанії CRM Expert

"За класикою жанру був пілотний проект на двох фаворитах (Dr.Explain та HelpNDoc) та борошна вибору.
За тиждень довідка була повністю готова. Звичайно, якщо ми набивали її з нуля, за цей час ми б не встигли. Ми просто конвертували всі паперові інструкції у внутрішній формат програм, змінили каталогізацію та організували систему гіперпосилань.
Спочатку лідером вибору була інша система, але вирішальним чинником на користь Dr.Explain став вигук людини, виконує основну частину роботи з перенесення тексту: «Вжух! І вся структура документа перенеслася до файлу довідки». Функція імпорту в Dr.Explain відпрацювала на ура та заощадила купу часу.
Також дуже підкупив дизайн веб-довідки, який формується Dr.Explain, та гарний спосіб організації підписів до вікон нашої системи. У Dr.Explain це називається «Аннотування екрану».
Можливість встановлення статусу розділу теж виявилася дуже зручною, особливо після імпорту старої версії довідки легко відслідковувати, які розділи вимагають оновлення, в яких ще ведуться зміни, а які вже оновлені та актуальні”.
Прочитати повний кейс компанії CRM Expert

Микола Вальковець, розробник компанії 2V

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

Підсумуємо

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

Завантажити Dr.Explain з необмеженою за термінами можливістю безкоштовної роботи можна за адресою: https://www.drexplain.ru/download/

Успішних розробок!

Дивіться також

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

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

Кількість переглядів цієї статті: 54 982.

Посібник користувача - це довідник на паперовому або цифровому носії (у форматі PDF або XPS), в якому наводяться інструкції з експлуатації чогось або описується правильний порядок дій для здійснення будь-якого процесу. Хоча коли людина чує словосполучення "посібник користувача", він зазвичай представляє посібник з використання певної програми, інструкції з експлуатації є у ​​комп'ютерної та побутової техніки (телевізори, стерео-системи, телефони, мп3-плеєри, садова техніка і т.д.) .Хороший посібник користувача розповідає про основні функції приладу або програми та пояснює, як правильно ними користуватися, при цьому інформація зазвичай добре структурована. Ця стаття розповість, про що важливо пам'ятати під час створення та оформлення посібника користувача.

Створення документації

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

• Іноді повністю виключити технічні терміни неможливо (наприклад, якщо ви складаєте інструкцію до програми для створення графіків та діаграм, де, крім стандартних засобів, також використовуються графічні інструменти Фібоначчі). У цьому випадку корисно дати визначення терміну та короткий опис (тобто що таке графіки Фібоначчі та як вони використовуються в аналізі фінансових показників).