Шаблон Руководства пользователя на АС

1. НАИМЕНОВАНИЕ СИСТЕМЫ
НАИМЕНОВАНИЕ ОБЪЕКТА АВТОМАТИЗАЦИИ
КРАТКОЕ НАИМЕНОВАНИЕ СИСТЕМЫ
Руководство пользователя
Лист утверждения
Код документа-ЛУ
Согласовано
<Должность> <Должность>
<Наименование согласующей организации> <Наименование организации-исполнителя>
_________________ФИО _________________ФИО
«__»_____________ 20__ г. «__»_____________ 20__ г.
<Должность> <Должность>
<Наименование согласующей организации> <Наименование организации-
соисполнителя>
_________________ФИО _________________ФИО
«__»_____________ 20__ г. «__»_____________ 20__ г.
<Должность> <Должность>
<Наименование согласующей организации> <Наименование организации-
соисполнителя>
_________________ФИО _________________ФИО
«__»_____________ 20__ г. «__»_____________ 20__ г.
СОГЛАСОВАНО УТВЕРЖДАЮ
<Должность> <Должность>
<Наименование организации заказчика> <Наименование организации-исполнителя>
_________________ <ФИО> _________________ <ФИО>
«__»_____________ 20__ г. «__»_____________ 20__ г.

2. Утвержден
Код документа-ЛУ
НАИМЕНОВАНИЕ СИСТЕМЫ
НАИМЕНОВАНИЕ ОБЪЕКТА АВТОМАТИЗАЦИИ
КРАТКОЕ НАИМЕНОВАНИЕ СИСТЕМЫ
Руководство пользователя
Код документа
Листов 22

3. 2
Код документа
Содержание
Введение............................................................................................................4
1 Назначение и условия применения...............................................................5
1.1 Назначение АС...........................................................................................5
1.2 Условия применения..................................................................................5
1.2.1 Требования к аппаратному обеспечению рабочих станций.................5
1.2.2 Требования к программному обеспечению рабочих станций.............5
2 Подготовка к работе.......................................................................................6
2.1 Состав дистрибутива..................................................................................6
2.2 Порядок загрузки данных и программ.....................................................6
2.3 Настройка клиентского ПО.......................................................................6
2.4 Проверка работоспособности....................................................................7
3 Описание операций........................................................................................8
4 Правила работы с интерфейсом приложения..............................................9
4.1 Элементы пользовательского интерфейса...............................................9
4.1.1 Список.......................................................................................................9
4.1.2 Фильтр.....................................................................................................10
4.1.3 Меню списка...........................................................................................10
4.1.4 Окно иерархии........................................................................................11
4.1.5 Меню иерархии.......................................................................................11
4.1.6 Мастер.....................................................................................................12
4.1.7 Редактор...................................................................................................13
4.1.8 Представление связанного объекта......................................................13
4.1.9 Список связанных объектов .................................................................14
4.1.10 Поле свойства типа «файл».................................................................15
4.2 Навигация в окнах интерфейса...............................................................15
4.3 Работа с отчетами.....................................................................................16
4.3.1 Печать отчета..........................................................................................16
4.3.2 Экспорт отчета........................................................................................16
4.3.3 Сохранение отчета на диске..................................................................16
5 Начало работы..............................................................................................17
5.1 Запуск приложения..................................................................................17
5.2 Главное окно интерфейса........................................................................17
6 <Название пункта меню первого уровня>.................................................19
7 Аварийные ситуации....................................................................................20

4. 3
Код документа
8 Рекомендации по освоению.........................................................................21

5. 4
Код документа
Введение
<В разделе указывают:
− область применения;
− краткое описание возможностей;
− уровень подготовки пользователя;
− перечень эксплуатационной документации, с которыми необходимо
ознакомиться пользователю.>
Наименование системы (далее - Краткое наименование системы) предназначена для
область применения системы
Краткое наименование системы позволяет:
− ...;
− ....
Персонал, работающий с Краткое наименование системы, должен обладать
следующими навыками:
− ...;
− ....
Перед началом работы с Краткое наименование системы пользователь должен
ознакомится со следующей эксплуатационной документацией:
− ...;
− ....

6. 5
Код документа
1 Назначение и условия применения
<В разделе указывают:
− виды деятельности, функции, для автоматизации которых предназначено
данное средство автоматизации;
− условия, при соблюдении (выполнении, наступлении) которых обеспечивается
применение средства автоматизации в соответствии с назначением (например, вид ЭВМ
и конфигурация технических средств, операционная среда и общесистемные
программные средства, входная информация, носители данных, база данных, требования
к подготовке специалистов и т. п.).>
1.1 Назначение АС
Краткое наименование системы предназначена для автоматизации деятельности .....
1.2 Условия применения
1.2.1 Требования к аппаратному обеспечению рабочих станций
Рабочая станция, на которой устанавливается клиентская часть ПО, должна иметь
следующую конфигурацию:
− ...;
− ....
1.2.2 Требования к программному обеспечению рабочих станций
На рабочих станциях должно быть установлено следующее программное
обеспечение:
− ...;
− ....

7. 6
Код документа
2 Подготовка к работе
<В разделе указывают:
− состав и содержание дистрибутивного носителя данных;
− порядок загрузки данных и программ;
− порядок проверки работоспособности.>
2.1 Состав дистрибутива
Дистрибутив Краткое наименование системы имеет следующую структуру:
<название каталога_1> <описание назначения каталога_1>
<название подкаталога_1> <описание назначения каталога_1>
<название файла_1> <описание файла_1>
… …
<название файла_n> <описание файла_n>
2.2 Порядок загрузки данных и программ
2.3 Настройка клиентского ПО
На каждой рабочей станции для работы с Краткое наименование системы
необходимо выполнить следующие настройки:
− ...;
− ....

8. 7
Код документа
2.4 Проверка работоспособности
<Рекомендуемый текст для приложений на FrameWork:>
После установки всех настроек необходимо запустить приложение Краткое
наименование системы (см. п. 5.1) на рабочей станции пользователя и проверить
правильность настроек (см. п. 2.3).

9. 8
Код документа
3 Описание операций
<В подразделах раздела приводят описание технологических процессов обработки
данных (всех выполняемых функций, задач, комплексов задач, процедур), выполняемых с
помощью АС.
Правила описания данного раздела изложены в документе «Инструкция по
разработке документа «Руководство пользователя».>

10. 9
Код документа
4 Правила работы с интерфейсом приложения
4.1 Элементы пользовательского интерфейса
При описании окон, посредством которых ведется работа с приложением,
используются следующие стандартные элементы пользовательского интерфейса:
− список;
− фильтр;
− меню списка;
− окно иерархии;
− меню иерархии;
− мастер;
− редактор;
− представление связанного объекта;
− список связанных объектов;
− поле свойства типа «файл».
4.1.1 Список
Список – это представление набора объектов. Каждый объект в списке
представляет собой строку и выводится по колонкам. Пользователь может просматривать
список, устанавливать критерии отбора записей (см. подпункт 4.1.2) в список (если в
списке предусмотрен фильтр) и, при наличии у него соответствующих прав доступа,
выполнять операции над любой записью списка, с использованием стандартного меню
списка (см. подпункт 4.1.3).
Пользователь имеет возможность менять порядок расположения колонок в списке.
Для этого необходимо нажать левой кнопкой мыши на заголовок колонки и, не отпуская
кнопки, перенести его на требуемое место.
Кроме того, пользователь может осуществлять сортировку списка по
возрастанию/убыванию значений какой-либо колонки. Для этого достаточно нажать левой
кнопкой мыши на заголовке требуемой колонки.
Порядок следования колонок в списке и заданная сортировка сохранятся при
повторном открытии списка.

11. 10
Код документа
4.1.2 Фильтр
Фильтр - это форма, предназначенная для установки критериев отбора записей в
списке или иерархии, располагающаяся в одном окне с набором записей, либо
открывающаяся в отдельном окне.
Пользователь может ввести конкретные значения или значения, содержащие
символ контекстного поиска (*), в текстовые поля, задать поиск полями селективного
выбора, флагов, задания дат, выбора объектов (множественного в том числе). Поиск может
осуществляться по одному или нескольким реквизитам одновременно. Фильтр может
иметь несколько закладок; условия, заданные на нескольких закладках, действуют
одновременно.
Фильтр может функционировать в режиме автоматического или ручного
обновления списка, в зависимости от логики работы интерфейса. В режиме
автоматического обновления при любом изменении любого из условий фильтрации
содержимое списка изменяется в соответствии с новыми условиями. В режиме ручного
обновления для изменения содержимого списка после изменения условий фильтрации
необходимо выбрать в стандартном меню списка операцию Обновить или нажать кнопку
Обновить. Чтобы отменить действие ранее наложенного фильтра, необходимо выбрать в
стандартном меню списка операцию Очистить или нажать кнопку Очистить, затем
выбрать в стандартном меню списка операцию Обновить или нажать кнопку Обновить.
Значения, указанные в полях фильтра, сохраняются при повторном открытии окна
интерфейса.
4.1.3 Меню списка
Стандартное меню списка представляет состав операций, доступных в контекстно-
зависимом меню, которое вызывается по нажатию правой кнопки мыши на элементе
списка, либо доступных по нажатию кнопки Операции.
В стандартном меню списка реализованы следующие операции:
Просмотр
Вывод информации об объекте.
Редактировать
Изменение реквизитов выбранного объекта, запуск редактора.
При выборе данной команды открывается окно интерфейса, в
котором следует изменить значения необходимых полей и нажать
экранную кнопку OK.

12. 11
Код документа
Создать
Создание нового объекта базы данных, запуск мастера.
При выборе данной команды открывается окно интерфейса, в
котором следует заполнить поля и нажать экранную кнопку Готово.
Удалить
Удалить текущий объект из списка. Перед удалением выводится
диалоговое окно для подтверждения удаления записи.
Отчет
Формирование отчета по всем записям в списке.
Экспорт в Excel
Сохранить ту же информацию, что и в отчете, в формате Microsoft
Excel.
Обновить
Обновить список объектов.
Очистить фильтр
Вернуть исходное состояние фильтра.
Операции Просмотр, Редактировать, Создать и Удалить могут быть не доступны
в зависимости от прав пользователя.
4.1.4 Окно иерархии
Стандартное окно иерархии – форма для работы с объектами, имеющими
иерархическую структуру в базе данных. Экран с иерархической структурой визуально
разделен на две части: в левой части – иерархия объектов, в правой – контекстное меню
(см. подпункт 4.1.5) и блок контекстной информации, активизируемые при выборе
элемента в дереве. Форма может иметь фильтр для отбора объектов (см. подпункт 4.1.2)
при формировании иерархической структуры.
4.1.5 Меню иерархии
Стандартное меню иерархии - состав операций, доступных при выборе
соответствующих пунктов меню. В стандартном меню иерархии реализованы следующие
операции:
Создать
Создание нового объекта базы данных, запуск мастера.
При выборе данной команды открывается окно интерфейса, в
котором следует заполнить поля и нажать экранную кнопку Готово.

13. 12
Код документа
Создать подчиненный
Создание нового объекта базы данных, подчиненного текущему
объекту, запуск мастера.
При выборе данной команды открывается окно интерфейса, в
котором следует заполнить поля и нажать экранную кнопку Готово.
Изменить
Изменение реквизитов выбранного объекта, запуск редактора.
При выборе данной команды открывается окно интерфейса, в
котором следует изменить значения необходимых полей и нажать
экранную кнопку OK.
Удалить
Удалить текущий объект из дерева. Перед удалением выводится
диалоговое окно для подтверждения удаления записи.
Некоторые операции могут отсутствовать, если эти действия невозможны по логике
работы приложения.
4.1.6 Мастер
Мастер – специальное средство поддержки диалогов, он предназначен для создания
нового объекта в базе данных или выполнения сложных многоэтапных операций. Мастер
может состоять из одного или нескольких шагов. Он состоит из полей ввода данных и
управляющих кнопок:
Готово
Выход из мастера с сохранением результатов ввода в БД.
Далее
Переход к следующему шагу в мастере.
Данная кнопка не показывается на последнем шаге мастера.
Назад
Возврат к предыдущему шагу в мастере.
Данная кнопка не показывается на первом шаге мастера.
Отмена
Выход из мастера без сохранения вводимых значений.

14. 13
Код документа
4.1.7 Редактор
Стандартный редактор - форма, предназначенная для внесения изменений в
существующие объекты базы данных. Редактор состоит из набора полей, доступных для
редактирования, введенных в мастере. Редактор может состоять из одной или нескольких
страниц (доступных путем переключения закладок) с набором полей для редактирования
свойств и атрибутов объектов и набора кнопок:
OK
Выход из редактора с сохранением измененных реквизитов.
Отменить
Выход из редактора без сохранения изменений.
4.1.8 Представление связанного объекта
Стандартное представление связанного объекта – поле (Рисунок 1),
представляющее в редакторе/мастере одного объекта другой объект, на который ссылается
редактируемый объект.
Рисунок 1 - Стандартное представление связанного объекта
Справа от поля с наименованием связанного объекта выводится кнопка ..., по
нажатию на которую показывается меню со следующими операциями:
Выбрать
Выбрать из списка нужный объект.
Создать
Регистрация нового объекта базы данных.
Редактировать
Изменение реквизитов выбранного объекта.
Очистить
Очистить поле с объектом.
Некоторые операции могут отсутствовать, если эти действия невозможны по логике
работы приложения.

15. 14
Код документа
4.1.9 Список связанных объектов
Стандартный список связанных объектов – представление объектов, связанных с
другим объектом, в мастере/редакторе последнего (Рисунок 2). Список связанных
объектов состоит из списка объектов на странице мастера или редактора.
Рисунок 2 - Стандартный список связанных объектов
Для списка связанных объектов доступны следующие операции, представленные в
виде кнопок:
Вверх
Переместить объект в упорядоченном наборе вверх на одну позицию
(кнопка доступна только в том случае, если для связанных объектов
задается порядок).
Вниз
Переместить объект в упорядоченном наборе вниз на одну позицию
(кнопка доступна только в том случае, если для связанных объектов
задается порядок).
Выбрать
Выбрать объект в форме выбора объектов (из списка или иерархии).
Создать
Регистрация нового объекта, запуск мастера.
Редактировать
Изменение реквизитов выбранного объекта, запуск редактора.
Удалить
Удалить объект из списка.
Какие-то из этих кнопок могут быть недоступны или отсутствовать, если у
пользователя нет соответствующих прав, или эти действия невозможны по логике работы
приложения.

16. 15
Код документа
4.1.10 Поле свойства типа «файл»
Стандартное поле свойства типа «файл» - поле (Рисунок 3) в редакторе/мастере
объекта, позволяющее выбрать и записать в базу данных файл, например, документ
Microsoft Word. Поле типа «файл» состоит из трех частей: слева поле, в котором выводится
имя файла, в середине поле, в котором выводится размер файла, справа кнопка ... для
операций с файлом.
Рисунок 3 - Стандартное поле свойства типа «файл»
По нажатию кнопки ... доступны следующие операции:
Загрузить на сервер
Выбрать файл и загрузить его в БД.
Очистить
Очистить поле.
Просмотр
Открыть файл подходящим приложением. Приложение определяется
по зарегистрированному расширению файла.
Сохранить на диске
Сохранить файл из БД локально на диске.
4.2 Навигация в окнах интерфейса
В большинстве окон интерфейса слева от заголовка расположено меню
пиктограмм:
<картинка с
пиктограммой>
<описание действий, выполняемых по нажатию левой кнопкой
мыши на пиктограмму>

17. 16
Код документа
4.3 Работа с отчетами
4.3.1 Печать отчета
Чтобы вывести отчет на печать следует нажать сочетание клавиш Ctrl+P или
выбрать пункт меню File/Print (Файл/Печать) окна интерфейса с отчетом. Откроется
стандартное окно Windows для настройки параметров печати.
В данном окне следует выбрать принтер и нажать экранную кнопку OK.
4.3.2 Экспорт отчета
Для экспорта отчета в MS Excel следует нажать левой кнопкой мыши на
пиктограмму , расположенную в правом верхнем углу окна интерфейса с отчетом.
Загрузится приложение MS Excel, в нем будет создан новый лист, в который будет
выгружен отчет.
4.3.3 Сохранение отчета на диске
Для сохранения отчета в формате xls на диске следует в приложении MS Excel (то
есть после экспортирования файла в MS Excel, но до закрытия листа с отчетом) нажать
сочетание клавиш Ctrl+S или выбрать пункт меню File/Save (Файл/Сохранить)
приложения MS Excel. Откроется стандартное окно Windows для ввода параметров
сохранения файла.
В данном окне следует указать каталог, в котором будет сохранен отчет, и имя
сохраняемого файла, затем следует нажать экранную кнопку Save (Сохранить).

18. 17
Код документа
5 Начало работы
5.1 Запуск приложения
Для запуска приложения Краткое наименование системы необходимо выполнить
следующие действия:
1) На рабочей станции запустить Internet Explorer.
2) В адресной строке Internet Explorer ввести адрес Краткое наименование системы
(http://<имя сервера приложений>/<имя виртуального каталога>).
3) В открывшемся окне интерфейса регистрации в поле для ввода имени
пользователя указать имя зарегистрированного в системе пользователя, в поле для ввода
пароля указать пароль пользователя и нажать экранную кнопку OK.
После выполнения вышеперечисленных действий, если все настройки подсистемы
были проведены корректно, откроется главное окно приложения Краткое наименование
системы (Рисунок 4).
5.2 Главное окно интерфейса
<скриншот главного окна интерфейса>
Рисунок 4 – Главное окно интерфейса Краткое наименование системы
Пункты главного меню:
<название пункта меню первого уровня_1>
Пункт меню первого уровня, содержит следующие подпункты:
<название подпункта_1> – <описание действий, выполняемых при
выборе подпункта_1> (см. п. <ссылка на соответствующий пункт
руководства>).
…
<название подпункта_n> – <описание действий, выполняемых при
выборе подпункта_n> (см. п. <ссылка на соответствующий пункт
руководства>).

19. 18
Код документа
…
<название пункта меню первого уровня_m>
<описание действий, выполняемых при выборе пункта_m>
(см. п. <ссылка на соответствующий пункт руководства>).

20. 19
Код документа
6 <Название пункта меню первого уровня>
<В разделе приводят описание всех подпунктов для текущего пункта меню первого
уровня. Количество таких разделов соответствует количеству пунктов первого уровня в
главном меню приложения.
Правила описания данного раздела изложены в документе «Инструкция по
разработке документа «Руководство пользователя».>

21. 20
Код документа
7 Аварийные ситуации
<В разделе указывают:
− действия в случае несоблюдения условий выполнения технологического
процесса, в том числе при длительных отказах технических средств;
− действия по восстановлению программ и/или данных при отказе магнитных
носителей или обнаружении ошибок в данных;
− действия в случаях обнаружении несанкционированного вмешательства в
данные;
− действия в других аварийных ситуациях.>
Список аварийных ситуаций и действий пользователя при их возникновении
приведен в таблице 1.
Таблица 1 - Список аварийных ситуаций и действий пользователя при их
возникновении
Аварийная ситуация Действия пользователя

22. 21
Код документа
8 Рекомендации по освоению
<В разделе указывают рекомендации по освоению и эксплуатации, включая
описание контрольного примера, правила его запуска и выполнения.
Правила описания данного раздела изложены в документе «Инструкция по
разработке документа «Руководство пользователя».>

23. 22
Код документа
Перечень условных обозначений, сокращений и терминов
Лист регистрации изменений
Изм.
Номера листов (страниц) Всего
листов
(стра-
ниц) в
докум.
№ документа
Входящий
№ сопро-
водительного
докум. и
дата
Подп. Дата
изме-
ненных
заме-
ненных
новых
анну-
лиро-
ванных

24. 23
Код документа