Разработка руководства пользователя

Руководство пользователя — это документ, содержащий информацию о разработанной системе и особенностях работы с ней. Основное назначение руководства пользователя — предоставление помощи пользователям системы в её использовании.

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

Согласно методическим указаниям РД 50−34.698−90 руководство пользователя содержит следующие разделы: [9].

• 1) введение;
• 2) назначение и условия применения;
• 3) подготовка к работе;
• 4) описание операций;
• 5) аварийные ситуации;
• 6) рекомендации по освоению.

Разработаем руководство пользователя при помощи инструмента Qt Assistant, входящего в пакет установки среды разработки Qt Creator.

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

Работа справочной системы основана на отображении простейших веб-страниц, написанных с помощью HTML (HyperText Markup Language — «язык гипертекстовой разметки»), и организации переходов между ними.

Выделим в руководстве пользователя следующую структуру:

• 1.

  Введение

  .

• 2. О программе.
• 3. Интерфейс программы.
• 3.1. Стартовое окно.
• 3.2. Окно прогнозирования.
• 3.3. Окно быстрого расчёта.
• 4. Работа с файлами.
• 5. Быстрый расчёт.
• 5.1. Порядок работы.
• 5.2. Сохранение отчёта.
• 6. Составление прогноза.
• 6.1. Порядок работы.
• 6.2. Сохранение проекта.
• 6.3. Сохранение отчёта.
• 7. Заполнение полей
• 7.1. Таблица статистики.
• 7.2. Параметры системы.
• 7.2.1. Количество тепла
• 7.2.2. Зависимость количества тепла.
• 7.2.3. Потери системы.
• 7.3. Теплоноситель.
• 7.4. Топливный ресурс.
• 8. Возможные ошибки.

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

Интерфейс разработанной справочной системы руководства пользователя представлен на рисунке 3.3.

Рисунок 3.3 — Интерфейс справочной системы руководства пользователя.

Полный текст разработанного руководства пользователя представлен в Приложении 6.