Шаблон руководство администратора по гост

Документ «Руководство пользователя»

Документ «Руководство пользователя»

РД 50-34.698-90. Автоматизированные системы. Требования к содержанию документов: <…>.

УКАЗАНИЯ ГОСТ:
Настоящие методические указания распространяются на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследование, проектирование и т. п.), включая их сочетание, и устанавливают требования к содержанию документов, разрабатываемых при создании АС.

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

1. Структура документа:
2. 1. Введение
3. 1.1 Область применения
4. 1.2 Краткое описание возможностей
5. 1.3 Уровень подготовки пользователя
6. 1.4 Перечень эксплуатационной документации
7. 2 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ
8. 2.1 Виды деятельности, функции
9. 2.2 Программные и аппаратные требования к системе
10. 3 ПОДГОТОВКА К РАБОТЕ
11. 3.1 Состав дистрибутива
12. 3.2 Запуск системы
13. 3.3 Проверка работоспособности системы
14. 4 ОПИСАНИЕ ОПЕРАЦИЙ
15. 4.1 Наименование операции
16. 4.2 Условия выполнения операции
17. 4.3 Подготовительные действия
18. 4.4 Основные действия
19. 4.5 Заключительные действия
20. 4.6 Ресурсы, расходуемые на операцию
21. 5 АВАРИЙНЫЕ СИТУАЦИИ. ВОССТАНОВЛЕНИЕ БАЗЫ ДАННЫХ
22. 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. пр.

Дата введения 2022-01-01

Предисловие

Цели, основные принципы и общие правила проведения работ по межгосударственной стандартизации установлены ГОСТ 1.0 «Межгосударственная система стандартизации. Основные положения» и ГОСТ 1.2 «Межгосударственная система стандартизации. Стандарты межгосударственные, правила и рекомендации по межгосударственной стандартизации. Правила разработки, принятия, обновления и отмены»

Сведения о стандарте

1 РАЗРАБОТАН Акционерным обществом «Всероссийский научно-исследовательский институт сертификации» (АО «ВНИИС») и Обществом с ограниченной ответственностью «Информационно-аналитический вычислительный центр» (ООО ИАВЦ)

2 ВНЕСЕН Федеральным агентством по техническому регулированию и метрологии

3 ПРИНЯТ Межгосударственным советом по стандартизации, метрологии и сертификации (протокол от 22 декабря 2020 г. N 58)

За принятие проголосовали:

4 Приказом Федерального агентства по техническому регулированию и метрологии от 19 ноября 2021 г. N 1521-ст межгосударственный стандарт ГОСТ 34.201-2020 введен в действие в качестве национального стандарта Российской Федерации с 1 января 2022 г.

5 ВЗАМЕН ГОСТ 34.201-89

6 ИЗДАНИЕ (март 2022 г.) с Поправкой (ИУС N 3 2022 г.)

1 Область применения

Настоящий стандарт распространяется на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследования, проектирование и т.п.), включая их сочетания, и устанавливает требования к видам, наименованию, комплектности и обозначению документов, разрабатываемых на стадиях создания АС.

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

2 Нормативные ссылки

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

ГОСТ 2.102 Единая система конструкторской документации. Виды и комплектность конструкторских документов

ГОСТ 2.113-75 Единая система конструкторской документации. Групповые и базовые конструкторские документы

ГОСТ 2.601 Единая система конструкторской документации. Эксплуатационные документы

_______________

¹⁾ В Российской Федерации действует ГОСТ Р 2.601-2019.

ГОСТ 19.101 Единая система программной документации. Виды программ и программных документов

ГОСТ 34.602 Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы

Примечание — При пользовании настоящим стандартом целесообразно проверить действие ссылочных стандартов и классификаторов на официальном интернет-сайте Межгосударственного совета по стандартизации, метрологии и сертификации (www.easc.by) или по указателям национальных стандартов, издаваемым в государствах, указанных в предисловии, или на официальных сайтах соответствующих национальных органов по стандартизации. Если на документ дана недатированная ссылка, то следует использовать документ, действующий на текущий момент, с учетом всех внесенных в него изменений. Если заменен ссылочный документ, на который дана датированная ссылка, то следует использовать указанную версию этого документа. Если после принятия настоящего стандарта в ссылочный документ, на который дана датированная ссылка, внесено изменение, затрагивающее положение, на которое дана ссылка, то это положение применяется без учета данного изменения. Если ссылочный документ отменен без замены, то положение, в котором дана ссылка на него, применяется в части, не затрагивающей эту ссылку.

3 Виды и наименование документов

Состав видов документов, разрабатываемых на стадии «Исследование и обоснование создания АС», определяют исходя из требуемых результатов выполнения данной стадии (научно-технический отчет, тактико-техническое задание, технико-экономическое обоснование).

На стадии «Техническое задание» разрабатывают Техническое задание (ТЗ) на создание автоматизированной системы в соответствии с требованиями ГОСТ 34.602.

Допускается разрабатывать ТЗ на составные части системы (подсистемы, комплексы задач, программно-технические комплексы, компоненты технического и программного обеспечения и т.п.).

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

Виды документов, разрабатываемых на стадиях «Эскизный проект», «Технический проект», «Рабочая документация», приведены в таблице 1.

Таблица 1 — Виды документов, разрабатываемых на стадиях «Эскизный проект», «Технический проект», «Рабочая документация»

Виды документов на программные средства, используемые при создании АС (ее частей), — по ГОСТ 19.101.

Виды документов на технические средства, используемые при создании АС (ее частей), — по ГОСТ 2.102 и по ГОСТ 2.601 в части эксплуатационных документов.

Наименования конкретных документов, разрабатываемых при проектировании АС в целом или ее части, приведены в таблице 2.

Таблица 2 — Наименования конкретных документов, разрабатываемых при проектировании АС в целом или ее части

В зависимости от применяемых методов проектирования и специфики создаваемых АС допускается:

• разрабатывать групповые и базовые документы в соответствии с разделами 1, 3, 4, 6 ГОСТ 2.113— 75;
• выпускать документы отдельными самостоятельными частями, соответствующими разделам основного документа;
• расширять номенклатуру документов, установленную настоящим стандартом.

При изготовлении несерийных компонентов комплексов средств автоматизации и на стадии «Ввод в действие» разрабатывают следующие организационно-распорядительные документы:

• акт завершения работ;
• акт приемки в опытную эксплуатацию;
• акт приемки в промышленную эксплуатацию;
• план-график работ;
• приказ о составе приемочной комиссии;
• приказ о проведении работ;
• программа работ;
• протокол испытаний;
• протокол согласования.

4 Комплектность документации

4.1 Перечень наименований разрабатываемых документов и их комплектность на систему и ее части определяется либо в техническом задании на создание автоматизированной системы (подсистемы), либо на начальных этапах ее создания.

Примечание — Комплектность проектно-сметных документов определяют в соответствии с правилами, установленными системой проектной документации для строительства.

4.2 На каждый комплект должна быть составлена ведомость документов.

4.3 Комплектность документации, обеспечивающей разработку, изготовление, приемку и монтаж технических средств, — по ГОСТ 2.102. Комплектность эксплуатационной документации на эти средства — по ГОСТ 2.601.

4.4 Комплектность документации на программные средства вычислительной техники — по ГОСТ 19.101.

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

5 Обозначения документов

5.1 Каждому разработанному документу должно быть присвоено самостоятельное обозначение. Документ, выполненный на разных носителях данных, должен иметь одно обозначение. К обозначению документов, выполненных на машинных носителях, добавляют букву «М».

Заимствованным документам сохраняют ранее присвоенные обозначения.

5.2 Настоящие правила не распространяются на документы, правила обозначения которых регламентированы государственными стандартами других систем документации.

5.3 Обозначение документа имеет следующую структуру, показанную на рисунке 1.

5.3.1 Правила обозначения системы (части системы) приведены в приложении А.

5.3.2 Код документа состоит из двух буквенно-цифровых знаков. Код для документов, определенных настоящим стандартом, проставляют в соответствии с графой 3 таблицы 2. Код дополнительных документов формируют следующим образом: первый знак — буква, означающая вид документа согласно таблице 1, второй знак — цифра или буква, указывающая порядковый номер документа данного вида.

Код документа отделяют от предыдущего обозначения точкой.

Рисунок 1. Структура обозначения документа.

5.3.3 Порядковые номера документов одного наименования (два знака) присваивают, начиная со второго, и отделяют от предыдущего обозначения точкой.

5.3.4 Номер редакции документа присваивают, начиная со второй в порядке возрастания от 2 до 9, и отделяют от предыдущего значения точкой. Очередной номер редакции присваивают в случаях сохранения (не аннулирования) предыдущей редакции.

5.3.5 Номер части документа отделяют от предыдущего обозначения дефисом. Если документ состоит из одной части, то дефис не проставляют и номер части документа не присваивают.

5.3.6 Признак документа, выполненного на машинных носителях, вводят при необходимости. Букву «М» отделяют от предыдущего обозначения точкой.

Приложение А (рекомендуемое). Правила обозначения систем и их чертежей

А.1 Структура обозначения автоматизированной системы или ее части имеет вид, показанный на рисунке А.1.

Рисунок А.1. Структура обозначения АС

А.2 Код организации-разработчика представляет собой основной государственный регистрационный номер (ОГРН) из Единого государственного реестра юридических лиц (ЕГРЮЛ).

А.З Код классификационной характеристики системы или ее части (подсистемы, комплекса, компонента) присваивают в соответствии с правилами, установленными в отрасли.

А.4 Порядковый регистрационный номер системы (части системы) присваивает служба организации разработчика, ответственная за ведение картотеки и учет обозначений. Регистрационные номера присваивают с 001 до 999 по каждому коду регистрационной характеристики.

Скачать документ в формате .doc вы можете здесь.