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

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

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


РД 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. пр.

Источник

Текст ГОСТ 34.201-2020 Информационные технологии. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем

        ГОСТ 34.201-2020

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

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

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

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

Information technology. Set of standards for automated systems. Types, sets and indication of documents for automated systems design

МКС 01.040.35; 35.240

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

Предисловие

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

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

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

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

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

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

Краткое наименование страны по МК (ИСО 3166) 004-97

Код страны по МК (ИСО 3166) 004-97

Сокращенное наименование национального органа по стандартизации

Армения

АМ

ЗАО «Национальный орган по стандартизации и метрологии» Республики Армения

Беларусь

ВY

Госстандарт Республики Беларусь

Киргизия

KG

Кыргызстандарт

Россия

RU

Росстандарт

Узбекистан

UZ

Узстандарт

Украина

UA

Минэкономразвития Украины

(Поправка)

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 — Виды документов, разрабатываемых на стадиях «Эскизный проект», «Технический проект», «Рабочая документация»

Вид документа

Код документа

Назначение документа

Ведомость

В

Перечисление в систематизированном виде объектов, предметов и т.д.

Схема

С

Графическое изображение форм документов, частей, элементов системы и связей между ними в виде условных обозначений

Инструкция

И

Изложение состава действий и правил их выполнения пользователями и персоналом

Обоснование

Б

Изложение сведений, подтверждающих целесообразность принимаемых решений

Описание

П

Пояснение назначения системы, ее частей, принципов их действия и условий применения

Конструкторский документ

—

По ГОСТ 2.102

Программный документ

—

По ГОСТ 19.101

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

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

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

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

Ста-

дия созда-

ния

Наименование документа

Код доку-

мента

Часть проек-

та

Принадлежность к

Дополнительные указания

проектно-

сметной доку-

ментации

эксплуа-

тационной докумен-

тации

ЭП

Ведомость эскизного проекта

ЭП*

ОР

—

—

—

Пояснительная записка к эскизному проекту

П1

ОР

—

—

—

ЭП

Схема организационной структуры

СО

ОР

—

—

Допускается включать в документ ПЗ или ПВ

ТП

Структурная схема комплекса технических средств

С1*

ТО

Х

—

Допускается включать в документ П9

Схема функциональной структуры

С2*

ОР

—

—

При разработке документов С0, С1, С2, С3 на стадии ЭП допускается их включение в документ П1

Перечень заданий на разработку специализированных (новых) технических средств

В9

ТО

Х

—

При разработке на стадии ТП допускается включать в документ П2

Схема автоматизации

С3*

ТО

Х

—

—

Технические задания на разработку специализированных (новых) технических средств

—

ТО

—

—

В состав проекта не входят

ТП

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

—

ТО

Х

—

В состав проекта не входят

Ведомость технического проекта

ТП*

ОР

—

—

—

Ведомость покупных изделий

ВП*

ОР

—

—

Перечень входных данных

В1

ИО

—

—

—

Перечень выходных данных

В2

ИО

—

—

—

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

В3

ТО

Х

—

Допускается включать в документ П2

Пояснительная записка к техническому проекту

П2

ОР

—

—

Включает план мероприятий по подготовке объекта к вводу системы в эксплуатацию

Описание автоматизируемых функций

П3

ОР

—

—

—

Описание постановки задач (комплекса задач)

П4

ОР

—

—

Допускается включать в документы П2 или П3

Описание информационного обеспечения системы

П5

ИО

—

—

—

ТП

Описание организации информационной базы

П6

ИО

—

—

—

Описание систем классификации и кодирования

П7

ИО

—

—

—

Описание массива информации

П8

ИО

—

—

—

Описание комплекса технических средств

П9

ТО

—

—

Для задачи допускается включать в документ П6 по ГОСТ 19.101

Описание программного обеспечения

ПА

ПО

—

—

—

Описание алгоритма (проектной процедуры)

ПБ

МО

—

—

Допускается включать в документы П2, П3 или П4

Описание организационной структуры

ПВ

ОО

—

—

—

План расположения

С8

ТО

Х

—

Допускается включать в документ П9

Ведомость оборудования и материалов

—

ТО

Х

—

—

Локальный сметный расчет

Б2

ОР

Х

—

—

ТП, РД

Проектная оценка надежности системы

Б1

ОР

—

—

—

Шаблон документа

С9

ИО

—

Х

На стадии ТП допускается включать в документы П4 или П5

РД

Ведомость держателей подлинников

ДП*

ОР

—

—

—

Ведомость эксплуатационных документов

ЭД*

ОР

—

Х

—

Спецификация оборудования

В4

ТО

Х

—

—

Ведомость потребности в материалах

В5

ТО

Х

—

—

Описание информационного массива

В6

ИО

—

Х

—

Описание базы данных

В7

ИО

—

Х

—

Локальная смета

Б3

ОР

Х

—

—

Методика (технология) автоматизированного проектирования

И1

ОО

—

Х

—

Технологическая инструкция

И2

ОО

—

Х

—

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

И3

ОО

—

Х

—

РД

Инструкция по эксплуатации комплекса технических средств

ИЭ

ТО

—

Х

—

Схема соединения внешних проводок

С4*

ТО

Х

—

Допускается выполнять в виде таблиц

Схема подключения внешних проводок

С5*

ТО

Х

—

То же

Таблица соединений и подключений

С6

ТО

Х

—

—

Схема деления системы (структурная)

Е1*

ТО

—

—

—

Чертеж общего вида

ВО*

ТО

Х

—

—

Чертеж установки технических средств

СА

ТО

Х

—

—

Схема принципиальная

СБ

ТО

Х

—

—

Схема структурная комплекса технических средств

С1*

ТО

Х

—

—

План расположения оборудования и проводок

С7

ТО

Х

—

—

Описание технологического процесса обработки данных (включая телеобработку)

ПГ

ОО

—

Х

—

Общее описание системы

ПД

ОР

—

Х

—

Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистем, систем)

ПМ*

ОР

—

—

—

Формуляр

ФО*

ОР

—

Х

—

Паспорт

ПС*

ОР

—

Х

—

* Документы, код которых установлен в соответствии с требованиями стандартов Единой системы конструкторской документации (ЕСКД).

Примечания

1 В таблице приняты следующие обозначения: ЭП — эскизный проект; ТП — технический проект; РД — рабочая документация; ОР — общесистемные решения; ОО — решения по организационному обеспечению; ТО — решения по техническому обеспечению; ИО — решения по информационному обеспечению; ПО — решения по программному обеспечению; МО — решения по математическому обеспечению.

2 Знак «Х» означает принадлежность к проектно-сметной или эксплуатационной документации.

3 Номенклатуру документов одного наименования устанавливают в зависимости от принятых при создании системы проектных решений.

4 Код (обозначение) документов, отмеченных в графе «Принадлежность к проектно-сметной документации» знаком «Х», может быть установлен по требованиям стандартов Системы проектной документации для строительства (СПДС).

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

— разрабатывать групповые и базовые документы в соответствии с разделами 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 Код организации-разработчика представляет собой основной государственный регистрационный номер (ОГРН) из Единого государственного реестра юридических лиц (ЕГРЮЛ).

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

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

УДК 004:006.354

МКС 01.040.35; 35.240

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

Источник

Журавлев Денис

Когда и у кого возникает необходимость создания руководства пользователя по ГОСТ

Многие IT-компании, которые занимаются разработкой и сопровождением программного обеспечения и автоматизированных комплексов, сталкиваются с задачей создания пользовательской документации или руководств для своих продуктов в соответствии с требованиями ГОСТ.

Как правило, необходимость в наличии пользовательского руководства, составленного по ГОСТ, возникает при сотрудничестве с государственными организациями, крупными производствами и компаниями, при заказной разработке программного обеспечения по тендерам и госзаказам или при необходимости добавить программный продукт в «Единый реестр российских программ для электронных вычислительных машин и баз данных (реестр отечественного ПО)».

Какие ГОСТ используются при написании руководства пользователя приложения

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

  • ГОСТ 34 — Автоматизированные системы
  • ГОСТ 19 — Единая система программной документации (ЕСПД)

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

ГОСТ 34 главным образом определяет комплектность, виды, структуру и содержание создаваемых документов.

ГОСТ 19 в большей степени определяет правила оформления документов.

Поэтому, на практике часто используются сразу оба этих ГОСТа.

Руководство пользователя — основной документ для конечного пользователя

Если говорить именно о документации для конечного пользователя системы, то из перечня описываемых в ГОСТ 34 документов нас интересует «Руководство пользователя». В ГОСТ 19 аналогичный по смыслу документ называется «Руководство оператора», но для программного обеспечения чаще используется именно первый вариант.

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

Сложности написания руководства пользователя по ГОСТ

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

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

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

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

Dr.Explain упрощает создание руководства пользователя по ГОСТ

Начиная с версии 5.5.1100 программа для создания пользовательской документации Dr.Explain предлагает функцию автоматизированной поддержки ГОСТ в проектах. Эта функция призвана значительно облегчить жизнь пользователям, перед которыми стоит задача создания руководства пользователя в соответствии с требованиями государственных стандартов.

В частности программа Dr.Explain контролирует и автоматизирует поддержку следующих требований стандартов:

  • Наличие обязательных разделов документа “Руководство пользователя” [ГОСТ 34 РД 50-34.698-90]. Все разделы снабжаются пояснениями по их содержанию.
  • Оформление титульных листов, аннотации и содержания [ГОСТ 19.105-78, 19.104-78].
  • Параметры печатных страниц документа и расположение основных элементов на них [ГОСТ 19.106-78].
  • Структуру и оформление колонтитулов [ГОСТ 19.106-78].
  • Оформление текстовой части документа: стили шрифтов, абзацные отступы, межстрочные интервалы [ГОСТ 19.106-78].
  • Формирование и оформление заголовков, разделов, перечислений (списков) [ГОСТ 19.106-78].

Управление функцией поддержки ГОСТ для проекта доступно в Настройках проекта в разделе Общие.

При включенном режиме поддержки ГОСТ для проекта соответствующие пользовательские настройки для печатаемых форматов RTF\DOC и PDF автоматически перекрываются программой, что гарантирует полное соответствие параметров выходных документов требованиям стандартов.

Для выходных форматов HTML и CHM будут использоваться пользовательские настройки вне зависимости от активности режима поддержки ГОСТ. Это снимает ограничение на свободную стилизацию этих форматов и позволяет, например, оформить онлайн-справку полностью в корпоративном или тематическом стиле.

Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.

Важно: Функция поддержки ГОСТ доступна в Dr.Explain только в русскоязычной версии интерфейса. Язык интерфейса программы выбирается в меню Настройки\Выбор языка программы (Options\Application language).

Создание нового руководства пользователя по ГОСТ

Для создания нового руководства пользователя по требованиям ГОСТ 34 в программе Dr.Explain можно использовать команды меню Файл \ Создать локальный проект — Руководство пользователя по ГОСТ 34 или Файл \ Создать общий проект на tiwri.com — Руководство пользователя по ГОСТ 34

или аналогичные кнопки на стартовом экране приложения.

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

В тексте каждого раздела будет приведена краткая инструкция-подсказка о том, что необходимо включить в данный раздел. Пользователю необходимо только наполнить разделы актуальным содержимым.

Настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.

Приведение существующей пользовательской документации в соответствие с требованиями ГОСТ

Также программа Dr.Explain позволяет привести существующую пользовательскую документацию в соответствии с требованиями ГОСТ.

Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.

Если исходная документация еще не ведется в Dr.Explain, а хранится в других форматах, первым шагом необходимо выполнить импорт существующих документов в программу. Dr.Explain поддерживает импорт документов из ряда популярных форматов. Команды импорта доступны как на стартовом окне программы, так и в меню Файл.

Затем необходимо включить режим поддержки ГОСТ в свойствах проекта описанным ранее способом.
Программа проверит структуру документа на наличие обязательных разделов и, если они отсутствуют, создаст их. Остальные существующие разделы, наличие которых не регламентировано ГОСТами, будут перенесены в скрытый от экспорта раздел “Старое дерево разделов”.

Пользователь должен будет перенести содержимое этих разделов или разделы целиком методом drag-n-drop в основное дерево проекта и отредактировать их по необходимости.

Как и в первом случае настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.

 Создайте документацию, соответсвующую ГОСТ 19 и ГОСТ 34 в Dr.Explain бесплатно

Смотрите также

  • Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации
Источник

УДК 65.015.13.011.56:006.354

Группа П87

ГОСУДАРСТВЕННЫЙ СТАНДАРТ СОЮЗА ССР

ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ.

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

 ГОСТ 34.201-89
 

ВИДЫ, КОМПЛЕКТНОСТЬ И ОБОЗНАЧЕНИЕ ДОКУМЕНТОВ ПРИ СОЗДАНИИ АВТОМАТИЗИРОВАННЫХ СИСТЕМ

Information technology. Set of standards for automated systems. Types, sets and indication of documents for automated systems design
ОКСТУ 0034

Дата введения 01.01.90

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

Пояснение терминов, применяемых в настоящем стандарте, приведены в приложении 1.

1. ВИДЫ И НАИМЕНОВАНИЕ ДОКУМЕНТОВ

1.1. Состав видов документов, разрабатываемых на стадии «Исследование и
обоснование создания АС» определяют в соответствии с разд. 3 ГОСТ 24.601, исходя
из требуемых результатов выполнения данной стадии.

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

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

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

Таблица 1

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

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

Таблица 2

Ста дия созда ния Наименование документа Код доку мента Часть проекта Принадлежность к Допол- нительные указания
проектно- сметной докумен- тации эксплуа- тационной докумен- тации
ЭП Ведомость эскизного проекта ЭП* ОР — — —
Пояснительная записка к эскизному проекту П1 ОР — — —
ЭП,ТП Схема организационной структуры СО ОР — — Допускается включать в документ П3 или ПВ
Схема структурная комплекса технических средств С1* ТО Х — Допускается включать в документ П9
Схема функциональной структуры С2* ОР — — При разработке документов СО, С1, С2, С3 на стадии ЭП допускается их включать в документ П1
Перечень заданий на разработку специализированных (новых) технических средств В9 ТО Х — При разработке на стадии ТП допускается включать в документ П2
Схема автоматизации С3* ТО Х — —
Технические задания на разработку специализированных (новых) технических средств — ТО — — В состав проекта на входят
ТП Задания на разработку строительных, электротехнических, санитарно-технических и других разделов проекта, связанных с созданием системы — ТО Х — В состав проекта на входят
Ведомость технического проекта ТП* ОР — — —
Ведомость покупных изделий ВП* ОР — — —
Перечень входных сигналов и данных В1 ИО — — —
Перечень выходных сигналов (документов) В2 ИО — — —
Перечень заданий на разработку строительных, электротехнических, санитарно-технических и других разделов проекта, связанных с созданием системы В3 ТО Х — Допускается включать в документ П2
Пояснительная записка к техническому проекту П2 ОР — — Включает план мероприятий по подготовке объекта к вводу системы в эксплуатацию
Описание автоматизируемых функций П3 ОР — — —
Описание постановки задач (комплекса задач) П4 ОР — — Допускается включать в документы П2 или П3
Описание информационного обеспечения системы П5 ИО — — —
Описание организации информационной базы П6 ИО — — —
ТП Описание систем классификации и кодирования П7 ИО — — —
Описание массива информации П8 ИО — — —
Описание комплекса технических средств П9 ТО — — Для задачи допускается включать в документ 46 по ГОСТ 19.101
Описание программного обеспечения ПА ПО — — —
Описание алгоритма (проектной процедуры) ПБ МО — — Допускается включать в документы П2, П3 или П4
Описание организационной структуры ПВ ОО — — —
План расположения С8 ТО Х — Допускается включать в документ П9
Ведомость оборудования и материалов — ТО Х — —
Локальный сметный расчет Б2 ОР Х — —
ТП, РД Проектная оценка надежности системы Б1 ОР — — —
Чертеж формы документа (видеокадра) С9 ИО — Х На стадии ТП допускается включать в документы П4 или П5
РД Ведомость держателей подлинников ДП* ОР — — —
Ведомость эксплуатационных документов ЭД* ОР — Х —
Спецификация оборудования В4 ТО Х — —
Ведомость потребности в материалах В5 ТО Х — —
Ведомость машинных носителей информации ВМ* ИО — Х —
Массив входных данных В6 ИО — Х —
РД Каталог базы данных В7 ИО — Х —
Состав выходных данных (сообщений) В8 ИО — Х —
Локальная смета Б3 ОР Х — —
Методика (технология) автоматизированного проектирования И1 ОО — Х —
Технологическая инструкция И2 ОО — Х —
Руководство пользователя И3 ОО — Х —
Инструкция по формированию и ведению базы данных (набора данных) И4 ИО — Х —
Инструкция по эксплуатации КТС ИЭ ТО — Х —
Схема соединений внешних проводок С4* ТО Х — Допускается выполнять в виде таблиц
Схема подключения внешних проводок С5* ТО Х — То же
Таблица соединений и подключений С6 ТО Х — —
Схема деления системы (структурная) Е1* ТО — — —
Чертеж общего вида ВО* ТО Х — —
Чертеж установки технических средств СА ТО Х — —
Схема принципиальная СБ ТО Х — —
Схема структурная комплекса технических средств С1* ТО Х — —
План расположения оборудования и проводок С7 ТО Х — —
Описание технологического процесса обработки данных (включая телеобработку) ПГ ОО — Х —
Общее описание системы ПД ОР — Х —
Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистемы, систем) ПМ* ОР — — —
Формуляр ФО* ОР — Х —
Паспорт ПС* ОР — Х —
*Документы, код которых установлен в соответствии с требованиями стандартов ЕСКД

(Измененная редакция, Изм. № 1)

Примечания:

  • 1. В таблице приняты следующие обозначения:
    • ЭП — эскизный проект;
    • ТП — технический проект;
    • РД — рабочая документация;
    • ОР — общесистемные решения;
    • ОО — решения по организационному обеспечению;
    • ТО — решения по техническому обеспечению;
    • ИО — решения по информационному обеспечению;
    • ПО — решения по программному обеспечению;
    • МО — решения по математическому обеспечению.
  • 2. Знак Х — обозначает принадлежность к проектно-сметной или эксплуатационной документации.
  • 3. Номенклатуру документов одного наименования устанавливают в зависимости от принятых при создании системы проектных решений

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

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

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

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

1.4. На стадиях «Изготовление несерийных компонентов КСА» и «Ввод в действие» разрабатывают следующие организационно-распорядительные документы:

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

2. КОМПЛЕКТНОСТЬ ДОКУМЕНТАЦИИ

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

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

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

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

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

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

3. ОБОЗНАЧЕНИЯ ДОКУМЕНТОВ

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

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

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

3.3. Обозначение документа имеет следующую структуру:

                  ___________
                 |___________|. XX. XX. X- X. M
                       |        |   |   |  |  |
Обозначение системы    |        |   |   |  |  |
(части системы)        |        |   |   |  |  |
Код документа                   |   |   |  |  |
Порядковый номер документа одного   |   |  |  |
наименования                        |   |  |  |
Номер редакции документа                |  |  |
Номер части документа                      |  |
Признак документа, выполненного на машинных   |
носителях                                     |

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

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

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

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

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

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

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

ПРИЛОЖЕНИЕ 1
Справочное

ПОЯСНЕНИЕ ТЕРМИНОВ, ПРИМЕНЯЕМЫХ В НАСТОЯЩЕМ СТАНДАРТЕ

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

Проектно-сметная документация на АС — часть документации на АС,
разрабатываемая для выполнения строительных и монтажных работ, связанных с
созданием АС.

Рабочая документация на АС — часть документации на АС, необходимой для
изготовления, строительства, монтажа и наладки автоматизированной системы в
целом, а также входящих в систему программно-технических,
программно-методических комплексов и компонентов технического, программного и
информационного обеспечения.

ПРИЛОЖЕНИЕ 2
Рекомендуемое

ПРАВИЛА ОБОЗНАЧЕНИЯ СИСТЕМ И ИХ ЧАСТЕЙ

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

                                 А.     Б.   ХХХ
Код организации-разработчика     |      |     |
Код классификационной характеристики    |     |
системы (ее части)                      |     |
Регистрационный номер                         |

2. Код организации-разработчика присваивают в соответствии с общесоюзным
классификатором предприятий, учреждений и организаций (ОКПО) или по правилам,
установленным отраслевыми НТД.

3. Код классификационной характеристики системы или ее части (подсистемы,
комплекса, компонента) присваивают в соответствии с правилами, установленными в
отрасли на основе 425 подкласса общесоюзного классификатора продукции и/или
общесоюзного классификатора подсистем и комплексов задач АСУ — 1 84 154.

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

ИНФОРМАЦИОННЫЕ ДАННЫЕ

1. РАЗРАБОТАН И ВНЕСЕН
Государственным комитетом СССР по стандартам

Министерством приборостроения, средств автоматизации и систем управления СССР

ИСПОЛНИТЕЛИ
И.П. Вахлаков; Я.Г. Виленчик; Н.М. Вицын, канд. техн. наук;
Ф.Р. Выдра, канд. техн. наук; С.В. Гаршина; Б.А. Дюков; Л.М. Зайденберг, канд.
техн. наук; А.П. Игошин, канд. техн. наук; Ю.Б. Ирз, канд. техн. наук
(руководитель темы); В.Ю. Королев; И.А. Коротеева; Е.С. Кранков, канд. техн.
наук; В.И. Махнач, д-р техн. наук; И.С. Митяев; А.М. Мустафина; Е.И. Некрылов,
канд. техн. наук; В.Ф. Попов; Е.Г. Савина; Н.В. Степанчикова; В.К. Чистов, канд.
техн. наук; П.А. Шалаев, канд. техн. наук

2. УТВЕРЖДЕН И ВВЕДЕН В ДЕЙСТВИЕ Постановлением Государственного комитата СССР по стандартам от 24.03.89 № 664

3. Срок проверки — 1999 г.; периодичность проверки — 10 лет

4. ВЗАМЕН ГОСТ 24.101-80, ГОСТ 24.102-80, РД 50-617-86

5. ССЫЛОЧНЫЕ НОРМАТИВНО-ТЕХНИЧЕСКИЕ ДОКУМЕНТЫ

Обозначение НТД, на которую дана ссылка Номер пункта
ГОСТ 2.102-68 1.3, 1.3.3, 2.3
ГОСТ 2.113-75 1.3.4
ГОСТ 2.601-68 1.3.3, 2.3
ГОСТ 19.101-77 1.3, 1.3.2, 2.4
ГОСТ 24.601-86 Вводная часть, 1.1
ГОСТ 34.602-89 1.2

Внесены изменения ¹ 1, (Утверждены и введены в действие
Постановлением Государственного комитета СССР по управлению качеством продукции
и стандартам от 29.12.90 № 3468, дата введения 01.07.91).

Текст ГОСТ 34.201-2020 Информационные технологии. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем

        ГОСТ 34.201-2020

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

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

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

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

Information technology. Set of standards for automated systems. Types, sets and indication of documents for automated systems design

МКС 01.040.35; 35.240

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

Предисловие

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

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

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

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

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

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

Краткое наименование страны по МК (ИСО 3166) 004-97

Код страны по МК (ИСО 3166) 004-97

Сокращенное наименование национального органа по стандартизации

Армения

АМ

ЗАО «Национальный орган по стандартизации и метрологии» Республики Армения

Беларусь

ВY

Госстандарт Республики Беларусь

Киргизия

KG

Кыргызстандарт

Россия

RU

Росстандарт

Узбекистан

UZ

Узстандарт

Украина

UA

Минэкономразвития Украины

(Поправка)

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 — Виды документов, разрабатываемых на стадиях «Эскизный проект», «Технический проект», «Рабочая документация»

Вид документа

Код документа

Назначение документа

Ведомость

В

Перечисление в систематизированном виде объектов, предметов и т.д.

Схема

С

Графическое изображение форм документов, частей, элементов системы и связей между ними в виде условных обозначений

Инструкция

И

Изложение состава действий и правил их выполнения пользователями и персоналом

Обоснование

Б

Изложение сведений, подтверждающих целесообразность принимаемых решений

Описание

П

Пояснение назначения системы, ее частей, принципов их действия и условий применения

Конструкторский документ

—

По ГОСТ 2.102

Программный документ

—

По ГОСТ 19.101

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

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

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

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

Ста-

дия созда-

ния

Наименование документа

Код доку-

мента

Часть проек-

та

Принадлежность к

Дополнительные указания

проектно-

сметной доку-

ментации

эксплуа-

тационной докумен-

тации

ЭП

Ведомость эскизного проекта

ЭП*

ОР

—

—

—

Пояснительная записка к эскизному проекту

П1

ОР

—

—

—

ЭП

Схема организационной структуры

СО

ОР

—

—

Допускается включать в документ ПЗ или ПВ

ТП

Структурная схема комплекса технических средств

С1*

ТО

Х

—

Допускается включать в документ П9

Схема функциональной структуры

С2*

ОР

—

—

При разработке документов С0, С1, С2, С3 на стадии ЭП допускается их включение в документ П1

Перечень заданий на разработку специализированных (новых) технических средств

В9

ТО

Х

—

При разработке на стадии ТП допускается включать в документ П2

Схема автоматизации

С3*

ТО

Х

—

—

Технические задания на разработку специализированных (новых) технических средств

—

ТО

—

—

В состав проекта не входят

ТП

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

—

ТО

Х

—

В состав проекта не входят

Ведомость технического проекта

ТП*

ОР

—

—

—

Ведомость покупных изделий

ВП*

ОР

—

—

Перечень входных данных

В1

ИО

—

—

—

Перечень выходных данных

В2

ИО

—

—

—

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

В3

ТО

Х

—

Допускается включать в документ П2

Пояснительная записка к техническому проекту

П2

ОР

—

—

Включает план мероприятий по подготовке объекта к вводу системы в эксплуатацию

Описание автоматизируемых функций

П3

ОР

—

—

—

Описание постановки задач (комплекса задач)

П4

ОР

—

—

Допускается включать в документы П2 или П3

Описание информационного обеспечения системы

П5

ИО

—

—

—

ТП

Описание организации информационной базы

П6

ИО

—

—

—

Описание систем классификации и кодирования

П7

ИО

—

—

—

Описание массива информации

П8

ИО

—

—

—

Описание комплекса технических средств

П9

ТО

—

—

Для задачи допускается включать в документ П6 по ГОСТ 19.101

Описание программного обеспечения

ПА

ПО

—

—

—

Описание алгоритма (проектной процедуры)

ПБ

МО

—

—

Допускается включать в документы П2, П3 или П4

Описание организационной структуры

ПВ

ОО

—

—

—

План расположения

С8

ТО

Х

—

Допускается включать в документ П9

Ведомость оборудования и материалов

—

ТО

Х

—

—

Локальный сметный расчет

Б2

ОР

Х

—

—

ТП, РД

Проектная оценка надежности системы

Б1

ОР

—

—

—

Шаблон документа

С9

ИО

—

Х

На стадии ТП допускается включать в документы П4 или П5

РД

Ведомость держателей подлинников

ДП*

ОР

—

—

—

Ведомость эксплуатационных документов

ЭД*

ОР

—

Х

—

Спецификация оборудования

В4

ТО

Х

—

—

Ведомость потребности в материалах

В5

ТО

Х

—

—

Описание информационного массива

В6

ИО

—

Х

—

Описание базы данных

В7

ИО

—

Х

—

Локальная смета

Б3

ОР

Х

—

—

Методика (технология) автоматизированного проектирования

И1

ОО

—

Х

—

Технологическая инструкция

И2

ОО

—

Х

—

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

И3

ОО

—

Х

—

РД

Инструкция по эксплуатации комплекса технических средств

ИЭ

ТО

—

Х

—

Схема соединения внешних проводок

С4*

ТО

Х

—

Допускается выполнять в виде таблиц

Схема подключения внешних проводок

С5*

ТО

Х

—

То же

Таблица соединений и подключений

С6

ТО

Х

—

—

Схема деления системы (структурная)

Е1*

ТО

—

—

—

Чертеж общего вида

ВО*

ТО

Х

—

—

Чертеж установки технических средств

СА

ТО

Х

—

—

Схема принципиальная

СБ

ТО

Х

—

—

Схема структурная комплекса технических средств

С1*

ТО

Х

—

—

План расположения оборудования и проводок

С7

ТО

Х

—

—

Описание технологического процесса обработки данных (включая телеобработку)

ПГ

ОО

—

Х

—

Общее описание системы

ПД

ОР

—

Х

—

Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистем, систем)

ПМ*

ОР

—

—

—

Формуляр

ФО*

ОР

—

Х

—

Паспорт

ПС*

ОР

—

Х

—

* Документы, код которых установлен в соответствии с требованиями стандартов Единой системы конструкторской документации (ЕСКД).

Примечания

1 В таблице приняты следующие обозначения: ЭП — эскизный проект; ТП — технический проект; РД — рабочая документация; ОР — общесистемные решения; ОО — решения по организационному обеспечению; ТО — решения по техническому обеспечению; ИО — решения по информационному обеспечению; ПО — решения по программному обеспечению; МО — решения по математическому обеспечению.

2 Знак «Х» означает принадлежность к проектно-сметной или эксплуатационной документации.

3 Номенклатуру документов одного наименования устанавливают в зависимости от принятых при создании системы проектных решений.

4 Код (обозначение) документов, отмеченных в графе «Принадлежность к проектно-сметной документации» знаком «Х», может быть установлен по требованиям стандартов Системы проектной документации для строительства (СПДС).

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

— разрабатывать групповые и базовые документы в соответствии с разделами 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 Код организации-разработчика представляет собой основной государственный регистрационный номер (ОГРН) из Единого государственного реестра юридических лиц (ЕГРЮЛ).

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

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

УДК 004:006.354

МКС 01.040.35; 35.240

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

Требования ГОСТ на автоматизированные системы в ИБ-проектах. Что изменилось и как это применять?

Время на прочтение
17 мин

Количество просмотров 40K

Зенин Николай Николаевич

главный архитектор проектов
компании Angara Security

Традиционно разработчики документации на автоматизированные системы при создании и обеспечении защиты этих систем применяли ГОСТы 34-й серии. С 2022 года наконец-то произошло обновление старых стандартов в рамках новой серии национальных и межгосударственных стандартов на автоматизированные системы (далее — ГОСТ на автоматизированные системы).

В этой статье мы проясним основные особенности применения ГОСТ на автоматизированные системы, а также разберемся в изменениях, которые произошли в 2022 году.

Состав ГОСТов на автоматизированные системы

С первой половины 2022 года вступили в действие новые стандарты (пункты 1–6) согласно Таблице 1.

Таблица 1 — Перечень действующих стандартов.

№

Ранее действовавший стандарт

Новый стандарт

Ссылка на документ

Статус (основание)

1)      

ГОСТ 34.601–90 «Автоматизированные системы. Стадии создания»

ГОСТ Р 59793–2021 «Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания»

protect.gost.ru

Действует с 30.04.2022 (приказ Росстандарта от 25.10.2021 №1285-ст)

2)      

ГОСТ 34.602–89 «Техническое задание на создание автоматизированной системы». Действие прекращено с 01.01.2022

ГОСТ 34.602–2020 «Техническое задание на создание автоматизированной системы»

protect.gost.ru

Действует с 01.01.2022 (приказ Росстандарта от 19.11.2021 № 1522-ст)

3)      

ГОСТ 34.603–92 «Виды испытаний автоматизированных систем». Действие прекращается с 30.04.2022

ГОСТ Р 59792–2021 «Комплекс стандартов на автоматизированные системы. Виды испытаний автоматизированных систем»

protect.gost.ru

Действует с 30.04.2022 (приказ Росстандарта от 25.10.2021 № 1284-ст)

4)      

ГОСТ 34.201–89 «Виды, комплектность и обозначение документов при создании автоматизированных систем». Действие прекращено с 01.01.2022

ГОСТ 34.201–2020 «Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Виды, комплектность и обозначение документов»

protect.gost.ru

Действует с 01.01.2022 (приказ Росстандарта от 19.11.2021 № 1521-ст)

5)      

РД 50–34.698–90 «Автоматизированные системы. Требования к содержанию документов». Действие прекращено (приказ Росстандарта от 12.02.2019 № 216)

ГОСТ Р 59795–2021 «Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов»

protect.gost.ru

Действует с 30.04.2022 (приказ Росстандарта от 25.10.2021 № 1297-ст)

6)      

ГОСТ 34.003–90 «Автоматизированные системы. Термины и определения». Действие прекращено с 01.01.2022

ГОСТ Р 59853–2021 «Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Термины и определения»

protect.gost.ru

Действует с 01.01.2022 (приказ Росстандарта от 19.11.2021 № 1520-ст)

7)      

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

Действует ранее принятый стандарт

protect.gost.ru

Издание (июль 2020) с поправками

8)       

ГОСТ Р 2.105–2019 «Единая система конструкторской документации. Общие требования к текстовым документам»

Действует ранее принятый стандарт

protect.gost.ru

Действует с 01.02.2020

9)      

ГОСТ Р 2.106–2019 «Единая система конструкторской документации. Текстовые документы»

Действует ранее принятый стандарт

protect.gost.ru

Действует с 01.02.2020

10)   

ГОСТ 7.32–2017 «Система стандартов по информации, библиотечному и издательскому делу. Отчет о научно-исследовательской работе. Структура и правила оформления»

Действует ранее принятый стандарт

protect.gost.ru

Действует 01.07.2018

11)   

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

Действует ранее принятый стандарт

protect.gost.ru

Измененная редакция, Изм. № 2

12)   

ГОСТ 19.101–77 «Единая система программной документации. Виды программ и программных документов» (ЕСПД)

Действует ранее принятый стандарт

protect.gost.ru

Измененная редакция, Изм. № 1

13)   

ГОСТ Р 51583–2014 «Защита информации. Порядок создания автоматизированных систем в защищенном исполнении. Общие положения»

Действует ранее принятый стандарт

protect.gost.ru

Переиздан в октябре 2018 года

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

Своды знаний, содержащиеся в ГОСТах, основаны на результатах исследований, на международных стандартах и на практическом опыте. Даже организациям, которым не требуется следовать во всем ГОСТу, стандарты разработки технической документации будут полезны в качестве чек-листа для проверки, «все ли продумано перед созданием системы?». Применение ГОСТов позволяет снизить риски, связанные с упущениями при проектировании, позволяет выставлять разработчикам требования на понятном языке.

Среди перечисленных стандартов наибольшее внимание в статье будет уделено двум из них, регламентирующим состав и содержание документации технического проекта:

  • ГОСТ 34.201–2020 (взамен ГОСТ 34.201–89), определяющий состав документов технического проекта;

  • ГОСТ Р 59795–2021 (взамен руководящего документа РД 50–34.698–90), определяющий содержание каждого разрабатываемого документа технорабочей документации.

Основные изменения стандартов

Основополагающие в проектировании автоматизированных систем стандарты, разработанные еще в 1989–1992 годах, не подвергались пересмотру 30 лет и, естественно, утратили свою актуальность. Они уже не учитывали современных тенденций развития технологий. Например, с тех времен, когда документы отчерчивали на кульмане, в составе проектной документации было принято разрабатывать «Чертеж формы документа (видеокадра)», а для хранения данных в картотеках с полу автоматизированной обработкой формировался «Каталог базы данных». Был непонятен статус старых стандартов (ведь было принято переиздавать стандарты как минимум раз в 10 лет, но этого не происходило).

И вот, наконец-то стандарты пересмотрены, переизданы и введены в действие.

  • Кардинально изменилась ситуация неопределенности требований к содержанию технорабочей документации, возникшая с момента отмены в 2019 году методических рекомендаций РД 50–34.698–90. Теперь требования к содержанию документации регламентированы ГОСТ Р 59795–2021.

  • Стали более четкими формулировки ГОСТ 34.201–2020, введенного взамен ГОСТ 34.201–89 (который устанавливал наименование, комплектность и обозначение документов), теперь устанавливает требования к видам, наименованию, комплектности и обозначению документов. Таким образом, новые требования к наименованию и содержанию документов ГОСТ на автоматизированные системы перешли из разряда методических рекомендаций в разряд требований.

Однако общий подход к разработке комплекта технорабочей документации на автоматизированные системы не пересматривался. Структура прежних стандартов не была подвержена существенным изменениям. Из новых стандартов исключены документы, которые не актуальны для современных автоматизированных систем:

  • Ведомость машинных носителей информации (ВМ);

  • Состав выходных данных (сообщений) (В8), при этом оставлен документ «Перечень выходных сигналов (документов)» (В2);

  • Инструкция по формированию и ведению базы данных (набора данных) (И4).

Остальные 55 документов, 4 из которых — с измененными формулировками (например, вместо «Чертеж формы документа (видеокадра)» — теперь «Шаблон документа», вместо «Каталог базы данных» — «Описание базы данных»), оставлены в перечне документов по ГОСТ 34.201–2020.

Состав работ по созданию систем

Основной стандарт, определяющий последовательность работ по созданию автоматизированных систем, — это ГОСТ Р 59793–2021 «Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания» (принят взамен ГОСТ 34.601–90). Данным стандартом определено 8 стадий создания автоматизированных систем, но, по сложившейся практике выполнения проектов, стадии объединяются, и работы выполняются в несколько этапов, перечисленных в Таблице 2.

Таблица 2 – Стадии работ по созданию системы.

Стадия по ГОСТ Р 59793–2021

Стадия (этап работ) на практике

Содержание работ

1. Формирование требований к АС

0) Предпроектный этап

Заказчик самостоятельно определяет требования пользователя к системе и размещает заказ на закупку

2. Разработка концепции АС

1) Обследование

Привлеченный исполнитель обследует инфраструктуру Заказчика и нормативную документацию, определяет угрозы безопасности информации, подготавливает Отчет об обследовании, Модель угроз, согласование которой может продолжаться в течение последующих стадий проекта

3. Техническое задание

2) Техническое задание

Выполняется разработка и утверждение Технического задания на создание системы

4. Эскизный проект

3) Технорабочее проектирование

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

5. Технический проект

6. Рабочая документация

7. Ввод в действие

4) Ввод в действие

Выполняются пуско-наладочные работы, подготовка персонала, проводятся испытания системы и, при необходимости, аттестация системы по требованиям безопасности информации

8. Сопровождение АС

5) Эксплуатация и сопровождение

Выполняются работы в соответствии с гарантийными обязательствами и послегарантийное обслуживание. Стадия работ продолжается до вывода системы из эксплуатации

Для упрощения применяемой терминологии часть понятий в данной статье объединены (в случаях, где не требуется разделение понятий):

  • под «созданием системы» подразумеваются как проекты создания, так и проекты модернизации (доработки) системы;

  • под «системой» подразумеваются как автоматизированные системы (состоящие из персонала, информации, комплекса технических и программных средств автоматизации целевой деятельности), так и информационные системы (аналогично автоматизированным системам, но без персонала), системы защиты информации;

  • под «системой защиты информации» подразумеваются как, собственно, система/подсистема защиты информации в соответствии с нормативными требованиями, так и системы/подсистемы информационной безопасности (в отличие от «защиты информации», термин «информационная безопасность» часто подразумевает послабление применяемых нормативных требований).

Отдельных комментариев заслуживают стадии: 1. «Формирование требований к АС», 3. «Техническое задание», 4-6, объединенные в этап работ на практике 3) «Технорабочее проектирование». Разберем их подробнее.

Техническое задание

Может возникать путаница в обозначении того, что считается Техническим заданием (Частным техническим заданием):

  • На стадии 1. «Формирование требований к АС» для публикации на портале закупок или модернизации существующей системы подготавливается документ с требованиями к системе, называемый по сложившейся практике «Техническим заданием». Однако, документ, создаваемый на данной стадии, остается только лишь требованиями пользователя к системе, и Техническим заданием не является.

  • На стадии 3. «Техническое задание» разрабатывается Техническое задание на систему, которое является Техническим заданием по ГОСТ на автоматизированные системы.

На стадии 3. «Техническое задание» определяются требования к системе в целом. На основании требований о защите информации государственных информационных систем, значимых объектов критической информационной инфраструктуры, персональных данных, автоматизированных систем управления, утвержденные Постановлением Правительства Российской Федерации от 06.07.2015 №676 и приказами ФСТЭК от 11.02.2013 №17, от 25.12.2017 №239, от 18.02.2013 №21, от 14.03.2014 №31, одновременно с определением требований, определяются и меры защиты информации, применение которых необходимо для нейтрализации актуальных угроз, выявленных по результатам моделирования угроз безопасности информации. Меры защиты включаются в Техническое задание на систему и затем при необходимости могут уточняться в рамках проектирования.

Технорабочее проектирование

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

  • Проектные решения (технический проект иногда называют «документацией на систему»). Данный блок описывает будущую систему в терминах принятых архитектурных и технических решений. Стадия эскизного проектирования — упрощенная версия технического проекта.

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

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

Практика применения требований ГОСТ на автоматизированные системы

Обязательность применения требований ГОСТ

В соответствии с Федеральным законом от 29.06.2015 №162-ФЗ «О стандартизации в Российской Федерации», добровольность применения документов по стандартизации — один из принципов стандартизации (статья 4).

ГОСТ становится обязательным,

  • если это установлено Федеральным законом (в случае защиты государственной тайны или в отношении оборонной продукции (статья 6) — что не является общим случаем для применения ГОСТ на автоматизированные системы);

  • если изготовитель/исполнитель принимает на себя требования (например, требования Технического задания) о применении национального/межгосударственного стандарта (статья 26 вышеуказанного 162-ФЗ).

Есть особые случаи, в которых необходимо учитывать требования ГОСТ на автоматизированные системы: создание автоматизированных систем в защищенном исполнении, создание государственных информационных систем, защита персональных данных, защита автоматизированных систем управления технологическими процессами, обеспечение безопасности критической информационной инфраструктуры, аттестация по требованиям безопасности информации. Нормативными требованиями в таких случаях предусматривается разработка:

  • Технического задания на создание подсистемы безопасности;

  • модели угроз безопасности информации;

  • документации на систему (проектной документации);

  • рабочей (эксплуатационной) документации.

В данных случаях необходимо руководствоваться требованиями ГОСТ на автоматизированные системы, даже если в современных трактовках вышеуказанных нормативных требований к разработке документации не употребляется прямая отсылка к ним, а, например, указываются цитаты из ГОСТ Р 59793–2021:

  • документация на систему (проектные решения) должна быть «в объеме, необходимом для описания полной совокупности проектных решений, достаточном для дальнейшего выполнения работ по созданию системы»;

  • рабочая документация должна содержать «все необходимые и достаточные сведения для обеспечения выполнения работ по вводу АС в действие и ее эксплуатации, а также для поддержания уровня эксплуатационных характеристик (качества) АС в соответствии с принятыми проектными решениями».

Так, например, на необходимость учета требований ГОСТ на автоматизированные системы при создании систем указывает действующая нормативная база, в частности:

  • ГОСТ Р 51583–2014 «Защита информации. Порядок создания автоматизированных систем в защищенном исполнении. Общие положения»;

  • Приказ ФСТЭК России от 11.02.2013 №17 «Об утверждении Требований о защите информации, не составляющей государственную тайну, содержащейся в государственных информационных системах»;

  • Постановление Правительства Российской Федерации от 06.07.2015 №676 (в редакции от 23.12.2021) «О требованиях к порядку создания, развития, ввода в эксплуатацию, эксплуатации и вывода из эксплуатации государственных информационных систем и дальнейшего хранения содержащейся в их базах данных информации».

Последний из указанных нормативных актов не содержит прямого указания на ГОСТ Р 59793–2021, но содержит цитату из него, дополненную требованиями по защите информации: «Этап разработки документации на систему и ее части включает разработку, согласование и утверждение документации в объеме, необходимом для описания полной совокупности проектных решений (в том числе по защите информации) и достаточном для дальнейшего выполнения работ по созданию системы».

ГОСТы на автоматизированные системы и связанные с ними стандарты регламентируют следующие 5 основных областей требований к проектированию систем:

  1. стадии проекта создания системы;

  2. состав проектной документации;

  3. содержание проектной документации;

  4. оформление проектной документации;

  5. последовательность приемки системы.

В Таблице 3 обзорно приводится, какие из этих областей требований к проектированию систем по ГОСТ на автоматизированные системы обязательны.

Таблица 3 — Обязательность отдельных областей требований к документации.

Область требований

Обязательность

Комментарии

1) стадии проекта создания системы

рекомендательный характер

Последовательность стадий работ по ГОСТ Р 59793–2021 объединяет «лучшие практики» создания систем

2) состав проектной документации

рекомендательный характер

ГОСТ 34.201–2020 содержит исчерпывающий перечень документов, из которого можно выбрать нужные по необходимости

3) содержание проектной документации

обязательно

ГОСТ Р 59795–2021 устанавливает требования к содержанию документации

4) оформление проектной документации

рекомендательный характер

Требования к оформлению документации установлены ЕСКД

5) последовательность приемки системы

обязательно

Созданная система должна быть оформлена надлежащим образом. Общие требования к проведению испытаний установлены ГОСТ Р 59792–2021

Состав документации

Если Вы приступаете к разработке проектной документации по ГОСТ на автоматизированные системы (в рамках создания или модернизации системы) либо оформляете требования к системе для размещения заказа на портале закупок, необходимо определить и требования к разработке документации (состав, содержание и оформление разрабатываемой документации).

Полный состав документации, определенный в ГОСТ 34.201–2020, — избыточен. Среди предложенных документов могут быть выбраны наиболее подходящие исходя из специфики задачи. Если требования заказчика не вполне определены, я предлагаю присмотреться к одному из предложенных в Таблице 4 подходу к проектированию (1…5) — набору документации, описываемой ГОСТами на автоматизированные системы. Один из таких подходов можно выбрать и применять в качестве рекомендации, от которой можно далее отталкиваться.

Таблица 4 — Рекомендуемые наборы документации.

Наименование документа

Код

1

2

3

4

5

1) Отчет об обследовании

—

☑

☑

☑

2) Модель угроз безопасности информации

—

☑

☑

☑

☑

3) Концепция автоматизированной системы

—

☑

☑

4) Техническое задание

ТЗ

☑

☑

☑

☑

☑

5) Ведомость технического проекта

ТП

☑

☑

☑

6) Схема структурная комплекса технических средств

С1

☑

☑

☑

7) Схема функциональной структуры

С2

☑

☑

☑

8) Пояснительная записка к техническому проекту

П2

☑

☑

☑

☑

9) Схема автоматизации

С3

☑

☑

10) Описание автоматизируемых функций

П3

☑

☑

11) Описание информационного обеспечения системы

П5

☑

12) Описание комплекса технических средств

П9

☑

☑

13) Описание программного обеспечения

ПА

☑

14) Схема организационной структуры

СО

☑

15) Описание организационной структуры

ПВ

☑

☑

16) План расположения

С8

☑

☑

17) Схема соединений внешних проводок

С4

☑

18) Таблица соединений и подключений

С6

☑

19) Чертеж установки технических средств

СА

☑

☑

20) Программа и методика испытаний

ПМ

☑

☑

☑

☑

☑

21) Ведомость эксплуатационных документов

ЭД

☑

☑

☑

22) Руководство администратора (технологическая инструкция)

И2

☑

☑

☑

☑

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

И3

☑

☑

☑

24) Инструкция по эксплуатации комплекса технических средств

ИЭ

☑

☑

25) Формуляр

ФО

☑

26) Паспорт

ПС

☑

Коды документов в Таблице 4 приведены в соответствии с ГОСТ 34.201–2020. Акты, протоколы, приказы, эскизный проект, редко разрабатываемые документы из списка 55 документов по ГОСТ 34.201–2020 не учитывались в данной таблице.

Набору 1 соответствует практическое отсутствие документации технического проекта и обоснования мер защиты на основе модели угроз (но хотя бы Техническое задание и программа испытаний должны присутствовать в каком-то виде).

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

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

Набору 4 соответствует расширенный состав документации, когда технорабочий проект должен быть всесторонне проработан.

Набор 5 редко требуется в настолько широком составе, даже для аттестации систем.

Содержание документации

Требования к содержанию документации установлены ГОСТ Р 59795–2021, на который (вместо РД 50–34.698–90) следует ссылаться при определении технических требований на проектирование системы.

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

  • Справочник объектов автоматизации (объектов защиты). Должен содержать перечни физических адресов, помещений (площадок), сегментов сети, оборудования, адресов и сетевых имен.

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

  • Справочник функциональных требований. Должен быть четко описан переход конкретных требований к результатам. Предпроектные технические требования после запуска проекта должны превратиться в Техническое задание (внесением уточнений по результатам обследования и определения угроз), а решения технического проекта должны стать подтверждением перехода от требований «должен» к «решено»: [Технические требования (предпроектный этап)] → [Техническое задание (описывает, как должно быть)] → [Технический проект (решения, принятые при проектировании)] → [Рабочая документация (описывает реализованные решения и настройки)].

  • Номенклатурный справочник. Должен содержать принятую в рамках проекта единую терминологию, правила наименования объектов автоматизации, перечень применимых нормативных документов и требований.

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

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

На рынке стали доступны среды автоматического формирования комплектов документации по ГОСТ на автоматизированные системы, включая модель угроз по новым требованиям ФСТЭК. Такие среды опираются в своей работе на систему справочных данных по проекту. Для предприятий мелкого и среднего бизнеса подобная услуга может сэкономить время на подготовку документации, если заказчиком предъявляются только базовые требования к содержанию и оформлению документации.

Оформление документации

Стандартом оформления технической документации принято считать ЕСКД (ГОСТ 2) «Единая система конструкторской документации». Требования к тестовым документам установлены ГОСТ 2.105–2019.

Согласно ГОСТ Р 59795–2021 (строки 4-26 в Таблице 4) оформление технической документации выполняют по ГОСТ 2.105 и ГОСТ 2.106, которыми установлены требования к оформлению текстовых документов и чертежей, включая рамку по границам листа, с надписью внизу рамки по ГОСТ 2.104 и с кодом документа по ГОСТ 34.201–2020.

Ранее требованиями ГОСТ 34.602–89 указывалось, что «ТЗ на АС оформляют… без рамки, основной надписи и дополнительных граф к ней». Однако, вступившим в силу ГОСТ 34.602–2020 данная оговорка заменена на «ТЗ на АС оформляют в виде текстового документа». Таким образом, Техническое задание на систему должно оформляться аналогично технорабочему проекту, в рамке по границам листа (если в заказе на разработку документации не будет указано обратное).

Оформление документов в рамке по границам листа формата по ГОСТ 2.301 — в свое время было замечательным решением для обеспечения бумажного документооборота (всегда можно было определить принадлежность листа документа к конструкторской документации и место любого листа по уникальной комбинации кода документа и номера листа). Но с переходом к электронному документообороту требования к наличию рамок стали менее актуальными. Если заказчик разработки документации считает, что рамки по границе листа затрудняют восприятие документа, от них можно отказаться, не нарушая требований ГОСТ. Для этого в заказе на разработку документации необходимо указать: «без рамки», — например, в такой формулировке: «Документация оформляется в виде текстового документа без рамки, основной надписи и дополнительных граф к ней».

Для производства профессионально составленной документации разработчикам (техническим писателям) рекомендуется применять соответствующие ГОСТ рекомендации специализированных руководств, одним из наиболее заслуженных среди которых считается «Справочник издателя и автора» (Мильчин А.Э, Чельцова Л.К.), — шестое издание 2021 года. 

Отдельных комментариев заслуживает ситуация с санкционными ограничениями и отзывом в 2022 году компанией Monotype возможности доступа на загрузку распространенных шрифтов Times New Roman, Arial с российских IP-адресов. Данное ограничение не запрещает использовать указанные шрифты на территории Российской Федерации, однако подталкивает разработчиков документации к установке и переходу к использованию шрифтов отечественного производства, из которых наибольшую известность заслужили шрифты компании «Паратайп» (Paratype):

  • PT Astra Serif – на смену Times New Roman;

  • PT Astra Sans – на смену Arial.

Из системы стандартов по информации, библиотечному и издательскому делу (ГОСТ Р 7.0.97-2016) исключены рекомендации по использованию проприетарных шрифтов из состава ОС Windows (Times New Roman, Arial, Courier New, Verdana), а в ГОСТ 2.105-2019 добавлено примечание о том, что применение таких шрифтов может привести к искажениям при отображении этих документов в других операционных системах (например, при переходе на отечественное ПО), в которых эти шрифты отсутствуют в связи с санкционными и лицензионными ограничениями.

Подытожим?

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

Написание технической документации очень ответственный этап проектирования. В процессе разработки создается очень много документов. Для их классификации существуют специальные требования по ГОСТ к оформлению технической документации по ГОСТу. Сегодня мы попробуем разобраться в том как  именно классифицируются документы и какие существуют требования

Нас иногда спрашивают, как правильно присвоить документу код, шифр, номер и т. п. ? Скажем сразу, что это не великая наука. Но, во-первых, не код и не шифр, а обозначение, во всяком случае, если мы намерены соблюдать требования ГОСТ 19 или ГОСТ 34. Во-вторых, давайте сначала разберемся, в чем смысл обозначений документов.

В советскую эпоху, в еще машинописно-бумажные времена обозначения документов служили для ведения архива. Представьте себе крупную организацию, которая заказывает или собственными силами разрабатывает много программ или автоматизированных систем. Технической документации у нее тоже накапливается много. Чтобы ориентироваться в ней, помимо всего прочего необходимо снабдить каждый документ уникальным идентификатором. В качестве такового отечественные стандарты предлагают использовать обозначение, формируемое по определенным регулярным правилам. О них и пойдет речь в данной статье ниже.

Обозначения документов нужны не прокурору, не Ростехрегулированию, не разработчику программы или системы, а, в первую очередь, Заказчику. Если ваш заказчик требует во что бы то ни стало снабдить созданные для него документы «кодом по госту», можно в ответ поинтересоваться, ведет ли он архив технической документации. К сожалению, в большинстве случаев ответ будет отрицательным. Если же заказчик располагает таким архивом, то, скорее всего, электронным, а не бумажным. В электронных архивах уникальные идентификаторы обычно присваиваются документам автоматически.

Таким образом, присвоение документам гостированных обозначений сегодня в значительной мере лишено смысла и представляет собой «магический ритуал». Как быть, если заказчик все-таки настаивает на его исполнении? Разумеется, исполнять.

Обозначения документов по автоматизированным системам

Структура обозначения системного документа в соответствии с ГОСТ 34.201-89 показана ниже. Расшифровка частей обозначения приведена в таблице.

Часть обозначения Значение
A код организации-разработчика системы. В ГОСТ 34.201-89 сказано: «Код организации-разработчика присваивают в соответствии с общесоюзным классификатором предприятий, учреждений и организаций (ОКПО) или по правилам, установленным отраслевыми НТД». По известным причинам общесоюзного классификатора сегодня с нами нет, зато существует Общероссийский классификатор предприятий и организаций (ОКПО). Код ОКПО входит в состав официальных реквизитов организации, и его должны знать у вас в бухгалтерии. Если вам очень не хочется звонить в бухгалтерию, попробуйте найти свою компанию в онлайновом справочнике, но имейте в виду, что надпись на табличке у дверей офиса не всегда совпадает с названием юридического лица.
B код классификационной характеристики типа системы или ее части. Согласно ГОСТ 34.201-89, этот код следует выбирать из общесоюзного классификатора продукции, на смену которому сегодня пришел Общероссийский классификатор продукции (ОКП). Он многократно опубликован в Интернете, вы без труда найдете его по приведенной здесь ссылке или с помощью поисковика. В этом классификаторе собрана вся возможная продукция от шагающих экскаваторов до булавок. Раздел классификатора, посвященный автоматизированным системам, начинается строкой 425000 Программно-технические комплексы для автоматизированных систем. Возможно, в классификаторе имеются другие строки, которые вам больше подходят по специфике системы. Попробуйте найти их обычной функцией поиска по тексту страницы. В качестве альтенативы ОКП стандарт предлагает использовать общесоюзный классификатор подсистем и комплексов задач АСУ (ОКПКЗ). Насколько нам известно, он был отменен, но ничем другим не заменен, таким образом, эта ссылка делается достоянием истории
CCC регистрационный номер автоматизированной системы или ее части. Предполагается, что разработчик организовал у себя учет выпускаемых автоматизированных систем и присваивает им регистрационные номера. Если у вас в компании это не принято, значит, вы не можете полноценно соблюдать требования КСАС. Начните новую жизнь, заведите журнал регистрации выпущенных систем. Нумерация систем ведется по каждому типу (т. е. коду классификационной характеристики, см. выше) систем отдельно. Как быть организации, которая ухитрилась выпустить 1000 однотипных автоматизированных систем, стандарт не говорит
DD код документа (точнее, типа документа) по ГОСТ 34.201-89. Например, код руководства пользователя — И3 (и-три), а код программы и методики испытаний —ПМ.
EE номер документа одного наименования. Допустим, у вас в комплекте документации три технологические инструкции для трех разных функциональных ролей. В этом случае у них будут номера 01, 02 и 03. Правила назначения этих номеров (по дате выпуска документа, по названиям в алфавитном порядке или как-нибудь иначе) не уточняются. Главное, чтобы номера шли последовательно с единицы. Если в комплект входит только один документ некоторого типа, например, одна пояснительная записка к техническому проекту, номер не присваивают, а соответствующая позиция в обозначении пропускается
F номер редакции документа. Речь идет о тех редакциях, которые вы официально передаете заказчику, а он их официально принимает и утверждает. Если в процессе рецензирования и согласования документа заказчик многократно присылал вам замечания, а вы ему в ответ исправленный файл, о новых редакциях документа речь не идет, это рабочие материалы и только. Новая редакция возникает в том случае, если заказчик утверждает новый вариант документа, сохраняя при этом предыдущий, и в принципе в каких-нибудь ситуациях может пользоваться ими обоими. В противном случае устаревший вариант можно аннулировать и забыть о нем навсегда. Номера присваивают редакциям, начиная со второй. В первой редакции соответствующая позиция в обозначении пропускается
G номер части документа. Документ можно физически разделить на несколько частей. Обычно так поступают, чтобы документ было удобнее читать или переплетать. Если документ не разделен на части, номер не присваивают, а соответствующая позиция в обозначении пропускается
M в 1989 году электронные документы еще были явлением новым и непривычным. Типичный документ представлял собой лист или стопку листов бумаги с согласующими и утверждающими подписями. Тот факт, что дискета или магнитная лента с записанным на ней текстом тоже может быть документом, требовал отдельного осмысления. Поэтому к обозначению таких документов добавляли буквуM. Как ни странно, эта практика и теперь не лишена оснований, поскольку у нас в стране в официальном документообороте фигурируют именно бумажные документы с оригинальными подписями компетентных лиц и «мокрыми» печатями организаций. Поэтому, например, технологическая инструкция, за несоблюдение которой сотрудника можно официально наказать, должна быть выполнена именно в таком виде. Но если заказчик требует от нас, допустим, текст программы (документ, предусмотренный ЕСПД), мы все-таки можем предоставить ему не грузовик листингов, а компакт-диск. Обозначение такого документа должно завершаться буквойM, которую отделяют от предыдущей части точкой (а не дефисом!)

В качестве примера присвоим обозначение технологической инструкции для пользователя этого сайта. Сайт будем рассматривать в качестве автоматизированной системы, которую мы разработали сами для себя, причем это был наш первый опыт разработки систем такого типа. Пользователем будем считать сотрудника «Мегасайт», который публикует на сайте статьи. Условимся также, что ответственный за публикацию — не единственная функциональная роль. Еще у нас есть ответственный за размещение рекламных баннеров, для которого написана своя технологическая инструкция. Действует первая редакция технологической инструкции, документ не разделен на части, существует в виде бумажного оригинала с подписями и печатями. С учетом перечисленных обстоятельств обозначение получается таким:

63755082.425750.001.И2.01, где

63755082 — код ООО «Мегасайт» согласно ОКПО.

425750 — код строки Программно-технические комплексы для автоматизации обработки информации в торговле, материально-техническом обеспечении согласно ОКП. Автор статьи полистал ОКП, подумал и решил, что данная характеристика подходит нашему сайту лучше всех остальных там предлагаемых. Возможно, он заблуждается.

001 — регистрационный номер автоматизированной системы этого типа в нашем внутреннем учете (давайте считать, что мы его ведем).

И2 — код технологической инструкции по ГОСТ 34.201-89.

01 — номер технологической инструкции в комплекте технической документации на сайт. Напомним, что есть еще одна, для менеджера по рекламным баннерам, у нее номер 02.

Обозначение технического задания на автоматизированную систему

В п. 3.2 ГОСТ 34.602-89 есть фраза, в которой упоминается некий код ТЗ: «Номера листов (страниц) проставляют, начиная с первого листа, следующего за титульным листом, в верхней части листа (над текстом, посередине) после обозначения кода ТЗ на АС».Вместе с тем, в ГОСТ 34.201-89 приведены коды документов, разрабатываемых на стадиях, начиная с эскизного проекта, но кода для ТЗ там нет, что несколько сбивает с толку.

При формировании кода ТЗ на АС можно принять во внимание п. 3.5. ГОСТ 34.602-89, в котором сказано: «При необходимости на титульном листе ТЗ на АС допускается помещать установленные в отрасли коды, например: гриф секретности, код работы, регистрационный номер ТЗ и др.», и присвоить код произвольно, сославшись на то, что так принято в отрасли или определено НТД конкретного предприятия. Кроме того, можно вспомнить, что по ГОСТ 24.101-80 у технического задания был код 2А, и присвоить документу обозначение по схеме, описанной выше. Но в общем это все уже напоминает схоластический подсчет количества чертей на кончике иглы.

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

Структура обозначения программного документа в соответствии с ГОСТ 19.103-77 показана ниже. Расшифровка частей обозначения приведена в таблице. Номер редакции, номер документа и номер части документа образуются так же, как для системных документов (в исторической перспективе наоборот, но мы просим читателя простить нам этот анахронизм).

Часть обозначения Значение
A код страны. В наше время разумно указывать двухбуквенный код в соответствии со стандартом ISO 3166-1: RU для России, KZ для Казахстана и т. д.
B код организации-разработчика. По аналогии с системными документами можно указывать код ОКПО
CCCCC регистрационный номер программы. Согласно ГОСТ 19.103-77, он должен присваиваться «в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом в установленном порядке». Как соблюдать это требование сегодня, нам неизвестно. Обратите внимание на год утверждения стандарта: 1977. Многое изменилось с тех пор в нашей жизни
DD номер редакции документа
EE код вида документа в соответствии с ГОСТ 19.101-77
FF номер документа данного вида
G номер части документа

Начальная часть обозначения, A.B.CCCCC-DD, служит обозначением самой программы и одновременно главного связанного с ней документа, спецификации.

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

Любую программу или автоматизированную систему можно рассматривать как изделие и документировать на общих основаниях, руководствуясь ЕСКД (ГОСТ 2). Этой же серией стандартов следует пользоваться при документировании технических средств, например серверов, рабочих станций, всевозможных специализированных устройств и т. п. Правила присвоения обозначений конструкторским документам устанавливает ГОСТ 2.201-80. Здесь мы воздержимся от пересказа этого документа, но не сомневаемся, что теперь читатель без труда найдет и освоит его.

Обозначения листов утверждения

Если документ снабжен листом утверждения, у последнего должно быть свое обозначение. Оно формируется по элементарному правилу: к обозначению документа следует добавить шифр ЛУ, отделив его дефисом, например: 63755082.425750.001.И2.01-ЛУ.

О пользе обозначений со сдержанным оптимизмом

Внимательный читатель заметил, что если бы все организации аккуратно придерживались таких правил, обозначения документов оказались бы уникальными в пределах страны. Тогда можно было бы, предположим, учредить национальный каталог технической документации, через который любой инженер мог бы запросить нужный ему документ. Наверно это облегчило бы интеграцию автоматизированных систем разных ведомств, а ведь мы сегодня испытываем много всяких бюрократических неудобств именно из-за их изолированности. Например, пенсионеры вынуждены брать в ЗАГСе справку, что они еще живы, и лично доставлять ее в Собес, только тогда им выписывают всякие надбавки и льготы. Спрашивается, почему бы автоматизированным системам ЗАГСа и Собеса не работать с единым массивом данных. С другой стороны, умудренный опытом читатель заметит, что эти рассуждения грешат утопизмом, и будет прав.

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

Источник

Понравилась статья? Поделить с друзьями:
  • Просьба работников к руководству
  • Инструкция вахтеру сторожу при чрезвычайных ситуациях
  • Ангиофлюкс 250 ле инструкция по применению цена отзывы аналоги
  • Процедура замены паспорта в 45 лет через госуслуги пошаговая инструкция
  • Мильгамма уколы инструкция по применению цена в омске