Документ "Руководство пользователя"
Документ "Руководство пользователя"
РД 50-34.698-90. Автоматизированные системы. Требования к содержанию документов: <...>.
УКАЗАНИЯ ГОСТ:
Настоящие методические указания распространяются на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследование, проектирование и т. п.), включая их сочетание, и устанавливают требования к содержанию документов, разрабатываемых при создании АС.
Руководство пользователя
- Структура документа:
- 1. Введение
- 1.1 Область применения
- 1.2 Краткое описание возможностей
- 1.3 Уровень подготовки пользователя
- 1.4 Перечень эксплуатационной документации
- 2 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ
- 2.1 Виды деятельности, функции
- 2.2 Программные и аппаратные требования к системе
- 3 ПОДГОТОВКА К РАБОТЕ
- 3.1 Состав дистрибутива
- 3.2 Запуск системы
- 3.3 Проверка работоспособности системы
- 4 ОПИСАНИЕ ОПЕРАЦИЙ
- 4.1 Наименование операции
- 4.2 Условия выполнения операции
- 4.3 Подготовительные действия
- 4.4 Основные действия
- 4.5 Заключительные действия
- 4.6 Ресурсы, расходуемые на операцию
- 5 АВАРИЙНЫЕ СИТУАЦИИ. ВОССТАНОВЛЕНИЕ БАЗЫ ДАННЫХ
- 6 РЕКОМЕНДАЦИИ ПО ОСВОЕНИЮ
УКАЗАНИЯ ГОСТ:
Документ содержит разделы:
1) введение;
2) назначение и условия применения;
3) подготовка к работе;
4) описание операций;
5) аварийные ситуации;
6) рекомендации по освоению.
1. Введение
1.1 Область применения
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа "Техническое задание, п.п.2.1".
1.2 Краткое описание возможностей
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа "Описание автоматизируемых функций, п.п.2.".
1.3 Уровень подготовки пользователя
ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа "Техническое задание, п.п.4.1.2 Требования к численности и квалификации персонала системы"
1.4 Перечень эксплуатационной документации
ПРИМЕР СОДЕРЖАНИЯ:
Перечень эксплуатационных документов, с которым необходимо ознакомиться:
- АС Кадры. "Руководство администратора";
- АС Кадры. "Руководство пользователя";
- т.д.
- пр.;
2 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ
УКАЗАНИЯ ГОСТ:
В разделе "Назначение и условия применения" указывают:
1) виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
2) условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).
ПРИМЕР СОДЕРЖАНИЯ:
2.1 Виды деятельности, функции
ПРИМЕР СОДЕРЖАНИЯ:
АС Кадры предназначена для автоматизации следующих видов деятельности:
Наполнение раздела можно взять в документе "Описание автоматизируемых функций, раздел ЦЕЛИ АС И АВТОМАТИЗИРУЕМЫЕ ФУНКЦИИ".
2.2 Программные и аппаратные требования к системе
ПРИМЕР СОДЕРЖАНИЯ:
Пример требований к программному обеспечению приведен в документе "Пояснительная записка, п.п.3.10".
Пример требований к аппаратному обеспечению приведен в документе "Техническое задание, п.п.4.3.5".
3 ПОДГОТОВКА К РАБОТЕ
УКАЗАНИЯ ГОСТ:
В разделе "Подготовка к работе" указывают:
1) состав и содержание дистрибутивного носителя данных;
2) порядок загрузки данных и программ;
3) порядок проверки работоспособности.
3.1 Состав дистрибутива
ПРИМЕР СОДЕРЖАНИЯ:
В состав дистрибутива АС Кадры входит:
- СУБД Oracle 10.2g;
- Приложение установки базы данных;
- Серверная часть Windows приложения АС Кадры;
- Клиентская часть Windows приложения;
- т.д.;
- пр.
3.2 Запуск системы
ПРИМЕР СОДЕРЖАНИЯ:
Предварительно необходимо выполнить установку системы. Информацию об установке системы можно получить в документе РД И3(А) АС Кадры, который входит в состав проектной документации.
1. Для того, чтобы запустить АС Кадры, откройте папку, в которую была установлена программа, и запустите файл kadry.exe.
2. В открывшемся окне заполните следующие поля в области окна Общие параметры:
- Логин - логин (логическое имя) пользователя;
- Пароль - пароль для входа в систему;
3. т.д.
пр.
3.3 Проверка работоспособности системы
ПРИМЕР СОДЕРЖАНИЯ:
Программное обеспечение работоспособно, если в результате действий пользователя, изложенных в п.п.3.2, на экране монитора отобразилось главное окно клиентского приложения без выдачи пользователю сообщений о сбое в работе.
4 ОПИСАНИЕ ОПЕРАЦИЙ
УКАЗАНИЯ ГОСТ:
В разделе "Описание операций" указывают:
1) описание всех выполняемых функций, задач, комплексов задач, процедур;
2) описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.
Для каждой операции обработки данных указывают:
1) наименование;
2) условия, при соблюдении которых возможно выполнение операции;
3) подготовительные действия;
4) основные действия в требуемой последовательности;
5) заключительные действия;
6) ресурсы, расходуемые на операцию.
В принципе, допускается в пределах разумного описывать операции без перечисления всех приведенных выше пунктов.
4.1 Наименование операции
ПРИМЕР СОДЕРЖАНИЯ:
Просмотр справочной информации.
4.2 Условия выполнения операции
ПРИМЕР СОДЕРЖАНИЯ:
Приложение запущено, успешно функционирует, не выполняет никакх операций, блокирущих доступ к пунктам меню.
4.3 Подготовительные действия
ПРИМЕР СОДЕРЖАНИЯ:
Отсутствуют.
4.4 Основные действия
ПРИМЕР СОДЕРЖАНИЯ:
Открыть пункт меню "Помощь", выбрать раздел "Справка". Появится всплывающее окно, содержащее разделы со справкой.
4.5 Заключительные действия
ПРИМЕР СОДЕРЖАНИЯ:
После завершения работы со справочной информацией, закрыть вплывающее окно со справкой.
4.6 Ресурсы, расходуемые на операцию
ПРИМЕР СОДЕРЖАНИЯ:
Отсутствуют.
5 АВАРИЙНЫЕ СИТУАЦИИ. ВОССТАНОВЛЕНИЕ БАЗЫ ДАННЫХ
УКАЗАНИЯ ГОСТ:
В разделе "Аварийные ситуации" указывают:
1) действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств;
2) действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных;
3) действия в случаях обнаружении несанкционированного вмешательства в данные;
4) действия в других аварийных ситуациях
ПРИМЕР СОДЕРЖАНИЯ:
При сбое в работе аппаратуры восстановление нормальной работы системы должно производиться после:
- перезагрузки операционной системы;
- запуска исполняемого файла системы;
При ошибках в работе аппаратных средств (кроме носителей данных и программ) восстановление функции системы возлагается на ОС.
При ошибках, связанных с программным обеспечением (ОС и драйверы устройств), восстановление работоспособности возлагается на ОС.
При неверных действиях пользователей, неверных форматах или недопустимых значениях входных данных, система выдает пользователю соответствующие сообщения, после чего возвращается в рабочее состояние, предшествовавшее неверной (недопустимой) команде или некорректному вводу данных.
6 РЕКОМЕНДАЦИИ ПО ОСВОЕНИЮ
УКАЗАНИЯ ГОСТ:
В разделе "Рекомендации по освоению" указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.
ПРИМЕР СОДЕРЖАНИЯ:
Для успешного освоения приложения АС Кадры необходимо иметь навыки работы с ПК и изучить следующее:
- Нормативно-правовую базу по вопросам управления государсвенными кадрами;
- Раздел «Описание процесса деятельности» документа «Пояснительная записка (Технический проект)»;
- Раздел «Описание автоматизируемых функций» документа «Пояснительная записка (Технический проект)»;
- Настоящее «Руководство пользователя».
Контрольный пример работы с системой
Ниже рассмотрен пример работы с системой, начиная с ее запуска и заканчивая оформлением документов:
1. Запустите систему.
2. т.д.
3. пр.