Основной целью руководства пользователя является обеспечение пользователя необходимой информацией для самостоятельной работы с программой или автоматизированной системой. Поэтому руководство пользователя должно отвечать на вопросы:

• что это за программа (система)?

• что может программа (система)?

• что необходимо для обеспечения корректного функционирования программы (системы)?

• что делать в случае отказа системы?

При составлении наиболее подробного руководства пользователя можно придерживаться следующей структуры:

1. Введение

Данный раздел должен предоставлять пользователю общую информацию о программе (системе). В нем указывают:

• область применения;

• краткое описание возможностей;

• уровень подготовки пользователя.

2. Перечень эксплуатационной документации

В данном разделе перечисляется документация, которая позволит пользователю избежать определенного рода ошибок.

3. Назначение и условия применения

Раздел подразделяет основную задачу программы (системы) на подзадачи и описывает каждую из них. В нем указывают:

• виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;

• условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).

4. Подготовка к работе

Данный раздел должен содержать пошаговую инструкцию для запуска программы (системы). К этапу подготовки системы к работе можно отнести установку дополнительных приложений, идентификацию, аутентификацию. В данном разделе указывают:

• состав и содержание дистрибутивного носителя данных;

• порядок загрузки данных и программ.

5. Проверка работоспособности

В разделе описываются показатели, по которым можно определить, что программное обеспечение работает нестабильно.

6. Описание операций

Это основной раздел, который содержит пошаговую инструкцию для выполнения того или иного действия пользователем. Если работа автоматизированной системы затрагивает целый бизнес-процесс, то в руководстве пользователя перед описанием операций целесообразно предоставить информацию о данном процессе, его назначении и участниках. Подобное решение позволяет человеку четко представить свою роль в данном процессе и те функции, которые реализованы для него в системе. Далее в руководстве пользователя следует представить описание функций, разбитых на отдельные операции.

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

• описание всех выполняемых функций, задач, комплексов задач, процедур;

• описание операций технологического процесса обработки данных, необходимых для выполнения функций, задач, процедур.

7. Аварийные ситуации

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