Як написати керівництво користувача

Як написати керівництво користувача

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

Вам знадобиться

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

Інструкція

  1. Керівництво користувача або, іншими словами, керівництво з експлуатації — документ, покликаний надати допомогу у використанні певної системи її користувачам. Для складання керівництва користувача вам необхідно знати описувану систему на всі сто відсотків, проте дивитися на неї очима нічого не тямить школяра. Припустимо, керівництво користувача пишеться для якоїсь програмної утиліти, аналогів якої ще не було. Уявіть, що ви зіткнулися з цією програмою вперше. З чого потрібно починати? Що необхідно знати в першу чергу? Систематизуйте ці знання, розбивши їх на категорії важливості.
  2. Розбивши всю інформацію, що стосується вашого творіння, на групи, ви склали план для написання керівництва користувача. Почніть описувати роботу у вашій програмі з азів, залишаючи наостанок найскладніші деталі, що стосуються, скажімо, перепрограмування можливостей або роботі з критичними помилками. На цьому етапі у вас має бути готове зміст посібника користувача — одна з обов’язкових частин цього документа.
  3. Якщо створюване вами керівництво призначене для використання в крупній компанії, то варто звернути увагу на прийняті там корпоративні стандарти. Приміром, у багатьох російських компаніях керівництво користувачів не приймаються без ілюстративного супроводу, простіше кажучи, картинок, що пояснюють написане. У керівництві користувача крім утримання повинні бути й інші обов’язкові частини:

    - Анотація, тобто пояснення загальних завдань керівництва і описуваного продукту;

    - Введення, в якому розповідається про пов’язані з керівництвом користувача документах і методи використання керівництва;

    - Розділи, що пояснюють про використання продукту на різних стадіях його використання, наприклад, перші кроки, ремонт або профілактика;

    - Розділ поширених запитань і відповідей на них;

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

Зверніть увагу

Багато видів посібників користувача регламентовані державними стандартами. Так, наприклад, ГОСТ 19.101-77 описує види програм і програмних документів, ГОСТ 19.105-78 — загальні вимоги до програмних документів, а ГОСТ 19.505-79 — вимоги до змісту та оформлення керівництва оператора ЕОМ.