Як зробити гарний посібник користувача

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

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

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

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

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

Отже, з теорією все стало ясно, настав час переходити до практики. Далі йде список порад у жанрі контрольного списку.

Користувачі читають документацію з надією отримати від цього процесу знання. Існують три типи знань Як (Що), Навіщо і Чому:

Як (Що)."Як мені включити магнітофон в електромережу?". "Що робить ця кнопка?"
Чому."Чому магнітофон згорів, коли я облив його водою під час запису?"
Навіщо."Навіщо цю кнопку добре натискати під час запису?"

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

Зміст

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

Намагайтеся робити абзаци коротші.

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

Намагайтеся підтримувати фіксовану структуру розділів.

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

Уникайте ілюстрацій, вони збивають увагу при перегортанні.

Все, що важко передати словами, передавайте за допомогою ілюстрацій.

Не розміщуйте в ілюстрації несуттєві деталі. Краще буде менш красиво, але більш зрозуміло.

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

Дві різні теми не повинні описуватись на одній сторінці.

Заголовки не повинні губитися на тлі тексту, краще місце для них поля.

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

Ні те ні се

РП без предметного покажчика - гівно. (Звернутися до такої термінології мене спонукала виняткова важливість цього постулату. Нормальна людина спочатку лізе в предметний покажчик, і тільки потім в зміст. Тобто РП може і не мати змісту, але предметний покажчик повинен бути обов'язково.)

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

Предметний покажчик краще писати паралельно з писанням основного тексту.

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

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

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

Оновлення РП паралельно з оновленням продукту. Користувачі ненавидять застарілі документації.

Я з вдячністю прийму будь-які доповнення чи критику.

Версія 1.2. Останнє оновлення цього документа: 20.03.00