Перегляд вихідного коду сторінки Керівництво користувача для користувача

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

[http://usethics.ru/blog/lib/doc_for_the_user/ повний текст статті]

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

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

Структура керівництва повинна бути чіткою і простою та побудована в залежності від призначення та застосування програмного продукту. Тобто відповідати на питання:
<ul>
<li>що це за продукт?
<li>кому і коли він потрібен?
<li>як з ним працювати: установка і настройка,
перелік вирішуваних завдань і оптимальні способи їх реалізації,
способи вирішення можливих проблем.
</ul>
При створенні структури керівництва слід виходити з потреб користувача програмного продукту, так, щоб, відкривши зміст, користувач міг без труднощів знайти відповідь на шукане питання. А виявивши потрібне, отримав вичерпну інформацію, як вирішити свою задачу, коли і навіщо використовувати ту чи іншу функціональність програми.
Оскільки користувач навряд чи буде повністю читати керівництво, а буде лише переглядати необхідні розділи, то кожен розділ має бути автономний і давати всю інформацію з даного питання.

Крім правильної розбивки тексту практичне керівництво повинне відповідати таким умовам:
<ul>
<li>Обов'язкові правила і моменти, що вимагають особливої уваги користувача, слід виділяти в тексті.
<li>Текст бажано забезпечити перехресними посиланнями так, щоб при необхідності користувач не мучився в пошуках згаданого терміну.
<li>Верстка керівництва повинна бути зручною для користувача.
<li>При необхідності текст слід супроводжувати відповідними тексту ілюстраціями.
</ul>
Ігнорування будь-який з цих деталей здатне зіпсувати керівництво і утруднити сприйняття тексту користувачем. 

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

== Висновки ==

Керівництво користувача створюється для користувача, а не для опису програмного продукту, воно повинно відповідати декільком вимогам:
<ul>
<li>Головна персона в керівництві завжди '''користувач''' і '''його запити''' при роботі з даним продуктом. Керівництво не повинно обманювати його очікування. Воно повинно відповідати на питання, а не змушувати читати опис інтерфейсу програми.
<li>'''Чіткість характеристик.''' Користувачеві необхідно ясно пояснити не тільки як зробити ту чи іншу дію, але і як краще це зробити, коли краще, для чого і до чого це призведе. У цьому випадку користувач краще зможе орієнтуватися в програмному продукті і використовувати його по максимуму. Розпливчасті й незрозумілі формулювання тут недоречні!
<li>'''Стислість тексту.''' Текст повинен бути невеликим і легко читатися. Потрібно уникати великовагових форм з численними причетними або дієприслівниковими зворотами, вступними словами і т.д. І не можна примушувати користувача читати зайві деталі. Користувач не повинен витрачати час на довгі і часто непотрібні опису.
</ul>