Типова структура

Методика й стиль викладу

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

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

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

Можливі й інші користувальницькі перспективи. Бувають програми, за допомогою яких користувач контролює стан того або іншого об'єкта, скажемо, промислової установки. Тоді керівництво користувача будується за принципом таблиці: повідомлення програми – реакція або можливі реакції користувача.

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

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

1. Загальні відомості.

2. Установка й первісне настроювання.

3. Основні поняття й визначення.

4. Інтерфейс користувача.

5. Робота із програмою.

6. Користувальницьке настроювання.

7. Повідомлення про помилки.

Єдиний розділ «Робота із програмою» часто заміняють декількома послідовними розділами, що описують великі групи користувальницьких завдань або функцій.