Разработка документации на автоматизированные системы


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

Для того чтобы представить порядок документирования разработки автоматизированных систем, следует уточнить, что понимать под этим термином. В ГОСТ 34.003-90[1] автоматизированная система (АС) определена как система, состоящая из персонала и комплекса средств автоматизации его деятельности, реализующая информационную технологию выполнения установленных функций. Из этого определения можно сделать вывод, что любая АС обязательно включает в себя три составляющие: технические средства (ТС), программное обеспечение (ПО) и персонал. Таким образом, для отражения жизненного цикла такого изделия, как АС, должна быть разработана документация на ТС и ПО, а также – на саму АС (основной комплект документов на АС). Эти документы можно разделить на две категории: документация, отражающая процесс разработки, и документация для персонала (эксплуатационная документация (ЭД)). При этом ТС и ПО могут включаться в состав системы как готовые изделия, тогда с ними при покупке приобретается и комплект ЭД. Если ТС и ПО разрабатываются при создании АС, то на них выпускается не только ЭД, а полный комплект технической документации.

Конструкторская документация (КД) на ТС разрабатывается в соответствии  требованиями ЕСКД, программная документация (ПД) на ПО – по требованиям ЕСПД. Виды, наименование, комплектность и обозначение документов на саму АС, разрабатываемых на всех стадиях создания, устанавливает ГОСТ 34.201[2]. Этот стандарт распространяется на различные типы АС – управления, исследования, проектирования и т. п., включая их сочетание. Стадии создания АС определены
ГОСТ 34.601[3].

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


Стадия и этапы работ

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

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

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

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

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

 

 

 

Рекомендации по содержанию и оформлению документов  по стадиям 1 и 2 приведены в приложении 1
РД 50-34.698-90[4]

 

1.1 Обследование объекта и обоснование необходимости создания АС

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

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

1.2 Формирование требований пользователя к АС

Требования пользователя к АС

Формулировка и оформление требований пользователя к АС

1.3 Оформление отчёта о выполненной работе и заявки на разработку АС (тактико-технического задания)

Отчёт о выполненной работе

­–

Описание текущего состояния объекта, целесообразность и основные направления автоматизации, принципиально важные требования к будущей АС

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

 

 

 

2.1 Изучение объекта

Отчёты по НИР

Поиск путей и оценка возможности реализации требований пользователя,

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

2.2 Проведение необходимых научно-исследовательских работ (НИР)

2.3 Разработка вариантов концепции АС, удовлетворяющего требованиям пользователя

2.4 Оформление отчёта о выполненной работе

Отчёт о выполненной работе

Описание выполненных работ на стадии описания и обоснования предлагаемого варианта концепции системы

3 Разработка технического задания (ТЗ)

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

ТЗ на АС разрабатывают на систему в целом, предназначенную для работы самостоятельно или в составе другой системы.

Дополнительно могут быть разработаны ТЗ на части АС

Состав, содержание, правила оформления документа «Техническое задание на создание (развитие или модернизацию) системы» приведены в ГОСТ 34.602-89[5]

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

 

 

 

 

4.1 Разработка предварительных проектных решений по системе и её частям

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

ЭП

Содержит перечень всех документов, разработанных на соответствующей стадии и применяемых из проектов других АС

­–

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

П1

По п. 2.2
РД 50-34.698-90

4.2 Разработка документации на АС и её части

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

С0

По п. 2.15

РД 50-34.698-90

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

С1

По п. 4.9
РД 50-34.698-90

Проектно-сметная документация

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

С2

По п. 2.3
РД 50-34.698-90

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

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

С3

По п. 4.1
РД 50-34.698-90

Проектно-сметная документация

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

В9

Определяется совместно с заказчиком по
ГОСТ Р 15.201-2000[6]

Проектно-сметная документация

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

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

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

 

 

 

 

5.1. Разработка проектных решений по системе и её частям.

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

П2

По п. 2.2
РД 50-34.698-90

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

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

П3

По п. 2.5
РД 50-34.698-90

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

П4

По п. 2.6
РД 50-34.698-90

Допускается включать в П2, П3

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

П5

По п. 5.3
РД 50-34.698-90

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

П6

По п. 5.5
РД 50-34.698-90

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

П7

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

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

П8

По п. 5.7
РД 50-34.698-90

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

П9

По п. 4.2
РД 50-34.698-90

Для задачи допускается включать в документ 46 (руководство по техническому обслуживанию) по 
ГОСТ 19.101[7]

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

ПА

По п. 6.1
РД 50-34.698-90

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

ПБ

По п. 7.1
РД 50-34.698-90

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

ПВ

По п. 3.1
РД 50-34.698-90

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

Б1

По п. 2.10
РД 50-34.698-90

5.2. Разработка документации на АС и её части

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

ТП

Содержит перечень всех документов, разработанных на соответствующей стадии и применяемых из проектов других АС

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

ВП

По ГОСТ 2.106-96[8]

Перечень входных сигналов и данных

В1

По п. 5.1
РД 50-34.698-90

Перечень выходных сигналов (документов)

В2

По п. 5.2
РД 50-34.698-90

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

С8

По п. 4.3
РД 50-34.698-90

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

Чертёж формы документа (видеокадра)

С9

 

Допускается включать в П4 или П5

5.3. Разработка и оформление документации на поставку изделий для комплектования АС и (или) технических требований (технических заданий) на их разработку.

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

По п. 4.20
РД 50-34.698-90

Проектно-сметная документация

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

Б2

По п. 2.7
РД 50-34.698-90

Проектно-сметная документация

5.4. Разработка заданий на проектирование в смежных частях проекта объекта автоматизации.

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

В3

­–

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

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

Проектно-сметная документация.

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

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

 

 

 

 

6.1 Разработка рабочей документации на систему и её части

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

Е1

По ГОСТ 2.711-82[9]

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

С1

По п. 4.9

РД 50-34.698-90

Проектно-сметная документация

 

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

С4

По п. 4.10

РД 50-34.698-90

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

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

С5

По п. 4.11

РД 50-34.698-90 Допускается выполнять в виде таблиц

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

С6

По п. 4.12

РД 50-34.698-90

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

С7

По п. 4.4

РД 50-34.698-90

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

СБ

По п. 4.16

РД 50-34.698-90

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

ВО

По п. 4.14

РД 50-34.698-90

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

СА

По п. 4.15

РД 50-34.698-90

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

В4

По ГОСТ 21.110-95[10]

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

В5

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

ПД

По п. 2.11

РД 50-34.698-90

Эксплуатационная документация

Инструкция по эксплуатации КТС

ИЭ

По п. 4.19

РД 50-34.698-90

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

И1

По п. 3.2

РД 50-34.698-90

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

И2

По п. 3.3

РД 50-34.698-90

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

И3

По п. 3.4

РД 50-34.698-90

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

И4

По п. 5.12

РД 50-34.698-90

Массив входных данных

В6

По п. 5.9

РД 50-34.698-90

Каталог базы данных

В7

По п. 5.10

РД 50-34.698-90

Состав выходных данных (сообщений)

В8

По п. 5.11

РД 50-34.698-90

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

ПГ

По п. 3.5

РД 50-34.698-90

Формуляр

ФО

По п. 2.9

РД 50-34.698-90

Паспорт

ПС

По п. 2.8

РД 50-34.698-90

Ведомость машинных носителей информации

ВМ

По п. 5.4

РД 50-34.698-90

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

ЭД

По п. 2.13

РД 50-34.698-90

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

ПМ

По п. 2.14

РД 50-34.698-90

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

ДП

ПО ГОСТ 2.106-96

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

Б3

По п. 2.7

РД 50-34.698-90

Проектно-сметная документация

6.2 Разработка или адаптация программ

Разработка программ и программных средств системы, выбор, адаптация и (или) привязка приобретаемых программных средств, разработка программной документации в соответствии с
ГОСТ 19.101-77

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

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

- акт завершения работ;

- акт приёмки в опытную эксплуатацию;

- журнал опытной эксплуатации;

- акт приёмки в промышленную эксплуатацию;

- план-график работ;

- приказ о составе приёмочной комиссии;

- приказ о проведении работ;

- программа работ;

- протокол испытаний;

- протокол согласования.

Приложение 2
РД 50-34.698-90

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

8.1 Выполнение работ в соответствии с гарантийными обязательствами

Организационно-распорядительная документация.

8.2 Послегарантийное обслуживание

Извещения об изменениях

ИИ

По п. 7

ГОСТ Р 21.1101-2013[11]

* – Отдельные документы эскизного проекта допускается включать в состав технического проекта после углублённой проработки технических решений.


 

В зависимости от применяемых методов проектирования и специфики создаваемых АС допускается объединять документы, расширять номенклатуру документов, разрабатывать групповые и базовые документы в соответствии с ГОСТ 2.113-75[12],  выпускать документы отдельными самостоятельными частями, соответствующими разделам основного документа.

При оформлении документации на АС следует руководствоваться положениями соответствующих стандартов ЕСКД. Каждый лист графического и текстового документа, как правило, оформляют основной надписью и дополнительными графами к ней в соответствии с требованиями
ГОСТ 2.104-2006[13]. Основную надпись располагают в правом нижнем углу листа. На листах формата А4 основную надпись располагают вдоль короткой стороны листа.

Текстовые документы (а также текстовые части проектно-сметной документации) выполняют по ГОСТ 2.105-95[14].

Все графические документы выполняют на листах установленного формата. Форматы листов выбирают в соответствии с требованиями, установленными ГОСТ 2.301-68[15] и ГОСТ 2.004-79[16], при этом основные форматы являются предпочтительными. При выборе форматов следует учитывать:

˗ объем и сложность проектируемого изделия;

˗ необходимую степень детализации данных, обусловленную назначением документа;

˗ условия хранения и обращения документации;

˗ особенности и возможности техники выполнения и копирования документа.

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

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

Линии изображают в виде горизонтальных и вертикальных отрезков. Следует добиваться наименьшего числа изломов и пересечений линий связи. Расстояние между двумя соседними параллельными линиями должно быть не менее 3 мм, между двумя соседними линиями графического обозначения, между отдельными условными графическими обозначениями – не менее 2 мм. На схеме не рекомендуется применять более трёх типоразмеров линий по толщине. Выбранные толщины должны быть постоянными во всем комплекте чертежей на систему. Для уменьшения количества линий, изображаемых на схеме, рекомендуется применять условное графическое слияние отдельных линий по правилам, установленным ГОСТ 2.721-74[17]. Каждая линия в месте слияния должна быть помечена условным порядковым номером, допускается помечать линии буквами или сочетанием букв и цифр. Каждый условный номер должен встречаться на линии групповой связи два раза.

Линии, соединяющие графические обозначения, на схемах, показывают, как правило, полностью. Допускается обрывать линии связи, если они затрудняют чтение схемы. Обрывы линий заканчивают стрелками. Около стрелок указывают места обозначений прерванных линий, например подключения или необходимые характеристики цепей (полярность, потенциал и т.д.). При выполнении схемы на нескольких листах линии, переходящие из одного листа на другой, обрывают за пределами изображения схемы. Рядом с обрывом линий указывают обозначение или наименование, присвоенное данной линии (номер провода, наименование сигнала), а в круглых скобках – номер листа, на который переходит линия связи и номер зоны (при её наличии), например (5,А6) – линия переходит на лист 5 в зону А6, или же обозначение документа при выполнении схем самостоятельными документами.

Расположение и формы записи текстовых данных на электрических схемах устанавливает
ГОСТ 2.701-84[18]. Текстовые данные в зависимости от их содержания и назначения могут располагаться:

- рядом с графическим обозначением (по возможности справа и сверху от обозначения);

- внутри графических обозначений;

- рядом с линиями, в разрыве линий или в конце линий;

- на свободном поле схемы.

Элементы (устройства, функциональные группы), входящие в систему и изображённые на схеме, должны иметь буквенно-цифровые обозначения в соответствии со стандартами на правила выполнения конкретных видов схем. Типы условных обозначений и правила их построения устанавливает
ГОСТ 2.710-81[19]. Для построения условных обозначений используют прописные буквы латинского алфавита, арабские цифры. Обозначение записывают в виде последовательности букв, цифр и знаков в одну строку без пробелов. Позиционные обозначения проставляются сверху вниз, слева направо внутри функциональной группы или по всему чертежу.

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

В документах следует применять стандартизированные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417-2002[20].

Организационно-распорядительная документация должна разрабатываться с учётом требований ГОСТ Р 6.30-97[21].

Для отражения жизненного цикла АС должна быть разработана документация на ТС и ПО, а также – основной комплект документов на саму АС. КД на ТС выпускается в соответствии с требованиями ЕСКД. ПД разрабатывается в соответствии с требованиями ЕСПД. Состав и содержание документации на саму АС определяется требованиями стандартов КСАС.

АС2.png

Так же стоит отметить, что разработка документации на АС может проводиться и без учёта требований КСАС. Такой подход к разработке документации на АС имеет место, например, при создании изделий военной техники: содержание, обозначение, оформление и комплектность конструкторской, технологической и программной документации, разрабатываемой в процессе выполнения опытно-конструкторских работ и их составных частей, а также порядок её согласования, утверждения и изменения должен соответствовать требованиям стандартов ЕСКД, ЕСПД, ЕСТД и прочей нормативной документации по согласованию с заказчиком (по ГОСТ РВ 15.002-2003[22]). В этом случае для регламентирования состава и содержания комплекта документов на АС используются стандарты ЕСКД и ЕСПД. Обозначение документам присваивается в соответствии с требованиями ГОСТ 2.201-80[23] и внутренних правил на предприятии разработчика. При этом содержание документов может быть изменено и дополнено с учётом специфики разрабатываемого изделия. Главный принцип остаётся тем же, что и при разработке по КСАС: комплект документации должен максимально полно отражать все стадии жизненного цикла изделия.

Перечень разрабатываемых документов на систему и её части должен определяется в ТЗ. Полный комплект документации на АС должен содержать весь набор данных для создания, внедрения и сопровождения системы. При разработке документов следует руководствоваться требованиями указанных в данной статье стандартов. Это поможет разработать грамотные, наглядные документы, содержащие необходимый объём информации.




[1] ГОСТ 34.003-90 – Информационная технология. Комплекс стандартов на автоматизированные системы (КСАС). Автоматизированные системы. Термины и определения

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

[3] ГОСТ 34.601-90 – КСАС. Автоматизированные системы. Стадии создания.

[4] РД 50-34.698-90 – Методические указания. КСАС. Автоматизированные системы. Требования к содержанию документов

[5] ГОСТ 34.602-90 – КСАС. Автоматизированные системы. Техническое задание на создание автоматизированной системы

[6] ГОСТ Р 15.201-2000 Система разработки и постановки продукции на производство (СРПП). Продукция производственно-технического назначения. Порядок разработки и постановки продукции на производство

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

[8] ГОСТ 2.106-96 – Единая система конструкторской документации. Текстовые документы

[9] ГОСТ 2.711-82 – Единая система конструкторской документации. Схема деления изделия на составные части

[10] ГОСТ 21.110-95– Система проектной документации для строительства. Правила выполнения спецификации оборудования, изделий и материалов

[11] ГОСТ Р 21.1101-2013 – Система проектной документации для строительства. Основные требования к проектной и рабочей документации

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

[13] ГОСТ 2.104-2006 – Единая система конструкторской документации. Основные надписи

[14] ГОСТ 2.105-96 – Единая система конструкторской документации. Текстовые документы

[15] ГОСТ 2.301-68 ­– Единая система конструкторской документации. Форматы

[16] ГОСТ 2.004-79 – Единая система конструкторской документации. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ

[17] ГОСТ 2.721-74 – Единая система конструкторской документации. Обозначения условные графические в схемах.Обозначения общего применения 

[18] ГОСТ 2.701-84 – Единая система конструкторской документации. Схемы, виды и типы. Общие требования к выполнению

[19] ГОСТ 2.710-81 – Единая система конструкторской документации. Обозначения буквенно-цифровые в электрических схемах

[20] ГОСТ 8.417-2002 – Государственная система обеспечения единства измерений (ГСИ). Единицы величин

[21] ГОСТ Р 6.30-97 – Требования к оформлению документов

[22] ГОСТ РВ 15.002-2003 – Система разработки и постановки продукции на производство. Военная техника. Система менеджмента качества. Общие требования

[23] ГОСТ 2.201-80 – Единая система конструкторской документации. Обозначение изделий и конструкторских документов


Если у вас возникли вопросы обратитесь к нашим экспертам и получите грамотную консультацию.