Як скласти керівництво користувача: 12 кроків

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

кроки

Частина 1 з 3:

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

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

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

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

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

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

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

Частина 2 з 3:

Складові частини керівництва користувача

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

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

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

3. Якщо кількість сторінок перевищує 10 штук, вам знадобиться зміст.

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

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

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

5. Використовуйте зображення і схеми. Малюнки та скріншоти можуть описати певні процеси краще, ніж текст, особливо якщо мова йде від складних процесах, де необхідно мати візуальне підтвердження того, що людина все робить вірно. Графічні зображення можна створити в спеціальних програмах: в системах двох- і тривимірного креслення, в графічних редакторах, в додатках для обробки фотографій і т.д. Якщо необхідно зробити скріншоти, їх можна отримати за допомогою штатних засобів комьпютер і графічної програми з можливістю збереження скріншотів.

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

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

Хоча графічні редактори (наприклад, Photoshop і Paint Shop Pro) зручні для створення скріншотів, краще використовувати спеціальні програми (наприклад, SnagIt), оскільки вони дозволяють відразу ж швидко і легко відредагувати, зберегти і підписати всі зображення.

Частина 3 з 3:

Оформленні керівництва по експлуатації

1. Виберіть читається шрифт. Хоча комп`ютери підтримують різні шрифти, керівництво користувача повинно бути добре читаним, тому віддавайте перевагу найпростішим. Найкраще підібрати кілька шрифтів, які добре виглядають разом. Є два типи шрифтів: із зарубками і без зарубок.

У шрифтів із зарубками є невеликі рисочки по краях ліній. До таких шрифтів відносяться Times New Roman, Baskerville і Book Antiqua. Такі шрифти підійдуть великим обсягам тексту, надрукованого 10 або 12 розміром і становить основу керівництва користувача.
Шрифти без зарубок мають прості лінії без прикрас. Це такі шрифти, як Arial, Calibri і Century Gothic. Шрифти без зарубок краще виглядають в текстах, надрукованих 8 або 10 шрифтом в посібниках в форматі PDF або web-документа. Чим більше шрифт, тим складніше його читати без зарубок. Однак ці шрифти можна використовувати і для великого тексту - наприклад, для набору заголовків. Шрифти без зарубок підходять для набору цифр в таблицях і колонках.
Слід вибирати прості шрифти на зразок Arial або Times New Roman, хоча для цитат підійде який-небудь більш складний шрифт. Якщо ви пишете керівництво користувача для фентезійної ігри, можна виділити хитромудрим шрифтом назви глав. Допускається також виділення цитат курсивом.
Після того, як виберіть шрифти, створіть тестову сторінку, щоб переконатися, що ці шрифти поєднуються між собою на папері. Покажіть цю сторінку людині, який схвалює макети, перш ніж віддати керівництво користувача до друку.

2. Продумайте схему розташування інформаційних блоків. На цьому етапі вам потрібно вирішити, в якому порядку розміщувати інформацію.

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

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

Залиште достатньо великі відступи з усіх сторін. З боку палітурки відступ повинен бути ширше.

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

скріплення скобою. Цей тип підходить для брошур розмірами 21x 27.5 см, 21x35 см або 11 x 27.5x42.5 см. Більшість недорогих інструкцій по експлуатації, які складаються з 48 сторінок і менш, переплітаються таким чином.

Обкладинка наопашки. Так переплітають більшість звичайних інструкцій по експлуатації, не рахуючи інструкцій до автомобілів, хоча деякі довгі керівництва також переплітаються таким чином. (Paint Shop Pro спочатку поставлявся саме з таким керівництвом користувача.)

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

4. зверстати документ. У більшості текстових редакторів і програм для публікації тексту в інтернеті передбачена можливість верстки. У міру того, як ви будете набирати текст, він буде автоматично відображатися в обраному шрифті. (Ця стаття була спочатку написана за допомогою шаблону в Microsoft Word.) У цих програмах також є вже готові шаблони, які ви можете змінити з урахуванням своїх потреб, замість того, щоб створювати шаблон з нуля.

У текстових редакторах і програмах для публікації тексту в інтернеті також є функція створення "стилів", збереження шрифтів і завдання розмірів для змістів, колонтитулів і основного тексту. Можна вибрати з уже існуючих стилів ( "Заголовок1", "Звичайний", "Цитата") або створити свій власний стиль і дати йому свою назву. Рекомендується називати стилі за такою ж системою, як це передбачено в програмі. (Наприклад, Microsoft Word створює такі назви, як "Заголовок1", "Заголовок2" - крім того, є ще підзаголовки.) Налаштуйте програму заздалегідь, щоб вам не довелося повертатися до цього, коли ви будете займатися написанням тексту.

Поради

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