Какие стандарты описывает руководство пользователя

Ниже представлен пример (образец) документа «Руководство пользователя«, разработанного на основании методических указаний РД 50-34.698-90.

Данный документ формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».

Для формирования руководства пользователя в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической системы «Корпоративное хранилище данных».

Ниже приведен состав руководства пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к содержанию и текст примера заполнения (выделен вертикальной чертой).

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

1. Введение.
2. Назначение и условия применения.
3. Подготовка к работе.
4. Описание операций.
5. Аварийные ситуации.
6. Рекомендации по освоению.

1. Введение

В разделе «Введение» указывают:

1. область применения;
2. краткое описание возможностей;
3. уровень подготовки пользователя;
4. перечень эксплуатационной документации, с которой необходимо ознакомиться пользователю.

2. Назначение и условия применения Oracle Discoverer Plus

В разделе «Назначение и условия применения» указывают:

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

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

В разделе «Подготовка к работе» указывают:

1. состав и содержание дистрибутивного носителя данных;
2. порядок загрузки данных и программ;
3. порядок проверки работоспособности.

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

В разделе «Описание операций» указывают:

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

Для каждой операции обработки данных указывают:

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

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

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

В разделе «Аварийные ситуации» указывают: 1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств; 2. действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях обнаружении несанкционированного вмешательства в данные; 4. действия в других аварийных ситуациях.

6. Рекомендации по освоению

В разделе «Рекомендации по освоению» указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

МЕЖГОСУДАРСТВЕННЫЙ СОВЕТ ПО СТАНДАРТИЗАЦИИ. МЕТРОЛОГИИ И СЕРТИФИКАЦИИ

(МГС)

INTERSTATE COUNCIL FOR STANDARDIZATION, METROLOGY AND CERTIFICATION

ГОСТ 34.201 — 2020

(ISC)

МЕЖГОСУДАРСТВЕННЫЙ

СТАНДАРТ

Информационные технологии

КОМПЛЕКС СТАНДАРТОВ НА АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ

Виды, комплектность и обозначение документов при создании автоматизированных систем

Издание официальное

Москва

Российский институт стандартизации 2021

Предисловие

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

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

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

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

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

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

Краткое наименование страны по МК (ИСО 3166) 004-97	Код страны по МК (ИСО 3166) 004-97	Сокращенное наименование национального органа по стандартизации
Армения	AM	ЗАО «Национальный орган по стандартизации и метрологии» Республики Армения
Беларусь	BY	Госстандарт Республики Беларусь
Киргизия	KG	Кыргыэстандарт
Россия	RU	Росстандарт
Украина	UA	Минэкономразвития Украины

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

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

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

В случае пересмотра, изменения или отмены настоящего стандарта соответствующая информация будет опубликована на официальном интернет-сайте Межгосударственного совета по стандартизации, метрологии и сертификации в каталоге «Межгосударственные стандарты»

© Оформление ФГБУ «РСТ», 2021

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

УДК 004:006.354    МКС 01.040.35; 35.240

Ключевые слова: информационные технологии, автоматизированные системы, виды документации

Редактор Л. В Коретникова Технический редактор В. Н. Прусакова Корректор РА. Ментова Компьютерная верстка И.А. Налвйкиной

Сдано в набор 22.11.2021. Подписано в печать 30.11.2021. Формат 60*84%. Гарнитура Ариал. Уел. печ. л. 1.40. Уч.-иад. л. 1.12.

Подготовлено на основе электронной версии, предоставленной разработчиком стандарта

Создано в единичном исполнении в ФГБУ «РСТ» для комплектования Федерального информационного фонда стандартов. 117418 Москва. Нахимовский пр-т. д. 31. к. 2. wvrw.goelinfo ги inlo@90stinfo.ru

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Информационные технологии

КОМПЛЕКС СТАНДАРТОВ НА АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ

Виды, комплектность и обозначение документов при создании автоматизированных систем

Information technology. Set of standards for automated systems.

Types, sets and indication of documents for automated systems design

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

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

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

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

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

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

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

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

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

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

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

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

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

Издание официальное

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

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

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

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

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

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

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

Вид документа Код документа Назначение документа Ведомость В Перечисление в систематизированном виде объектов, предметов и т. д. Схема С Графическое изображение форм документов, частей, элементов системы и связей между ними в виде условных обозначений Инструкция И Изложение состава действий и правил их выполнения пользователями и персоналом Обоснование Б Изложение сведений, подтверждающих целесообразность принимаемых решений Описание П Пояснение назначения системы, ее частей, принципов их действия и условий применения Конструкторский документ — По ГОСТ 2.102 Программный документ — ПоГОСТ 19.101

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

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

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

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

Принадлежность к Стадия созда ния Наименование документа Код доку мента Часть проек та проектно- сметной Доку ментации эксплуа тационной докумен тации Дополнительные указания ЭП Ведомость эскизного проекта ЭП* ОР — — — Пояснительная записка к эскизному проекту П1 ОР — — — эп Схема организационной структуры СО ОР — — Допускается включать в документ ПЗ или ПВ

Продолжение таблицы 2

Принадлежность к Стадия созда ния Наименование документа Код доку мента Часть проек та проектно сметной Доку ментации эксплуа тационной докумен тации Дополнительные указания ТП Структурная схема комплекса технических средств С1* ТО X — Допускается включать в документ П9 Схема функциональной структуры С2* ОР При разработке документов СО. Cl. С2. СЗ на стадии ЭП допускается их включение в документ П1 Перечень заданий на разработку специализированных (новых) технических средств В9 то X При разработке на стадии ТП допускается включать в документ П2 Схема автоматизации сз* то X — — Технические задания на разработку специализированных (новых) технических средств то В состав проекта не входят тп Задания на разработку строительных, электротехнических. санитарно-технических и других разделов проекта, подготовительные работы, связанные с созданием системы то X В состав проекта не входят Ведомость технического проекта ТП* ОР — — — Ведомость покупных изделий ВП* ОР — — Перечень входных данных В1 ио — — — Перечень выходных данных В2 ио — — — Перечень заданий на разработку строительных, электротехнических, санитарно-технических и других разделов проекта, связанных с созданием системы вз то X Допускается включать в документ П2 Пояснительная записка к техническому проекту П2 ОР Включает план мероприятий по подготовке обьекта к вводу системы в эксплуатацию Описание автоматизируемых функций ПЗ ОР — — — Описание постановки задач (комплекса задач) П4 ОР — — Допускается включать в документы П2 или ПЗ Описание информационного обеспечения системы П5 ио — — —

Продолжение таблицы 2

Принадлежность к Стадия созда ния Наименование документа Код доку мента Часть проек та проектно- сметной Доку ментации эксплуа тационной докумен тации Дополнительные указания ТП Описание организации информационной базы П6 ИО — — — Описание систем классификации и кодирования П7 ИО — — — Описание массива информации П8 ИО — — — Описание комплекса технических средств П9 ТО « Для задачи допускается включать в документ П6 по ГОСТ 19.101 Описание программного обеспечения ПА ПО — — — Описание алгоритма (проектной процедуры) ПБ МО — — Допускается включать в документы П2. ПЗ или П4 Описание организационной структуры ПВ 00 — — — План расположения С8 то X — Допускается включать в документ П9 Ведомость оборудования и материалов — то X — — Локальный сметный расчет Б2 ОР X — — тп. РД Проектная оценка надежности системы Б1 ОР — — — Шаблон документа С9 ИО X На стадии ТП допускается включать в документы П4 или П5 РД Ведомость держателей подлинников ДП* ОР — — — Ведомость эксплуатационных документов эд* ОР — X — Спецификация оборудования В4 то X — — Ведомость потребности в материалах В5 то X — — Описание информационного массива В6 ИО — X — Описание базы данных В7 ИО — X — Локальная смета БЗ ОР X — — Методика (технология) автоматизированного проектирования И1 оо ‘ X « Технологическая инструкция И2 00 — X — Руководство пользователя ИЗ оо — X —

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

—    разрабатывать групповые и базовые документы в соответствии с раздепами 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. второй знак— цифра или буква, указывающая порядковый номер документа данного вида.

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

XX.    XX.    X-    X.    м

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

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

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

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

Приложение А (рекомендуемое)

Правила обозначения систем и их частей

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

А.    Б.    XXX

Код организации-разработчика

Код классификационной характеристики системы (ее части)

Регистрационный номер

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

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

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

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