Title Лек 5_6 Документация АСОИиУ ✅

Лекция 5-6. Документация АСОИиУ. Стандарты оформления документации. Порядок разработки документации АСОИиУ. Документация АСОИиУ В процессе жизненного цикла АСОИиУ необходимо разрабатывать огромное количество разнообразной документации. Документация является неотъемлемой частью любой АСОИиУ. Актуальность Одним из болезненных вопросов в разработке любого ПО, и особенно сложных АСОИиУ всегда был и остаётся процесс документирования этой самой разработки. Вам возможно доводилось участвовать в проекте, который делают уже пару лет, но, при этом, никто никак не можете с ним током разобраться. А все потому что из документов есть одно техническое задание, да и то написано оно было в начале прошлого века, и совершенно не отражает и половины функционала системы. За время пока ведется проект, разработчики и заказчики встречались сто раз, у каждого есть записи на черновиках, но люди приходят, уходят, черновики забирают с собой, черновики теряются или вообще о них знают не все разработчики. Такое случается очень часто, особенно когда небольшие внешне перспективные и быстро растущие команды берутся за сложный и долгосрочный проект. И это, честно говоря, очень печальное и байтораздирающее зрелище. Поэтому во ВСЕХ проектах НЕОБХОДИМО изначально построить процесс так, чтобы неопознанного и неописанного функционала не было, все члены команды вовремя получали актуальную информацию и вообще был мир во всём. Документация на программу Повторюсь, что комплект документов и жизненный цикл процесса создания АСУ регламентируется ГОСТ Р 59793–2021 и включает следующие стадии и этапы работ табл. 5.1: Таблица 5.1 - Стадии и этапы работ жизненного цикла АСУ Стадии (знать) Этапы работ (иметь четкое представление) 1. Формирование требований к АС 1.1. Обследование объекта и обоснование необходимости создания АС 1.2. Формирование требований пользователя к АС 1.3. Оформление отчета о выполненной работе и заявки на разработку АС 2. Разработка концепции АС 2.1. Изучение объекта 2.2. Проведение необходимых научно-исследовательских работ 2.3 Разработка вариантов концепции АС и выбор варианта концепции АС 2.4. Оформление отчета о выполненной работе 3. Техническое задание 3.1. Разработка и утверждение технического задания на создание АС 4. Эскизный проект 4.1. Разработка предварительных проектных решений по системе и ее частям 4.2. Разработка документации на АС и ее части 5. Технический проект 5.1, Разработка проектных решений по системе и ее частям 5,2 Разработка документации на АС и ее части 5.3. Разработка и оформление документации на поставку изделий для комплектования АС и (или) технических требований (технических заданий) на их разработку 5.4. Разработка заданий на проектирование в смежных частях проекта 6. Рабочая документация 6.1 Разработка рабочей документации на систему и ее части 6.2. Разработка или адаптация программ 7. Ввод в действие 7.1. Подготовка объекта автоматизации к вводу АС в действие 7.2. Подготовка персонала 7.3. Комплектация АС поставляемыми изделиями 7.4 Строительно-монтажные работы 7.5. Пусконаладочные работы 7.6. Проведение предварительных испытаний 7.7. Проведение опытной эксплуатации 7.8. Проведение приемочных испытаний 8. Сопровождение АС 8.1. Выполнение работ в соответствии с гарантийными обязательствами 8.2. Послегарантийное обслуживание 1
Допускается исключать стадию «Эскизный проект» и отдельные этапы работ на всех стадиях, объединять стадии «Технический проект» и «Рабочая документация» в одну стадию. В зависимости от специфики создаваемых АС и условий их создания допускается выполнять отдельные этапы работ до завершения предшествующих стадий, параллельное во времени выполнение этапов работ, включение новых этапов работ. Содержание работ. На этапе 1.1. Обследование объекта и обоснование необходимости создания в АС общем случае проводят: а) сбор данных об объекте автоматизации и осуществляемых видах деятельности; б) оценку качества функционирования объекта и осуществляемых видах деятельности, выявление проблем, решение которых возможно средствами автоматизации; в) оценку (технико-экономической, социальной и т.д.) целесообразности создания АС. На этапе 1.2. Формирование требований пользователя к АС проводят: а) подготовку исходных данных для формирования требований АС (характеристика объекта автоматизации, описание требований к системе, ограничения допустимых затрат на разработку, ввод в действие и эксплуатацию, эффект, ожидаемый от системы, условия создания и функционирования системы); б) формулировку и оформление требований пользователя к АС. На этапе 1.3. Оформление отчёта о выполненной работе и заявки на разработку АС (технико-технического задания) проводят оформление отчета о выполненных работах на данной стадии и оформление заявки на разработку АС (тактико-технического задания) или другого заменяющего её документа с аналогичным содержанием. На этапах 2.1. Изучение объекта и 2.2. Проведение научно-исследовательских работ организация-разработчик проводит детальное изучение объекта автоматизации и необходимые научно-исследовательские работы (НИР), связанные с поиском путей и оценкой возможности реализации требований пользователя, оформляют и утверждают отчёты о НИР. На этапе 2.3. Разработка вариантов концепции АС и выбор варианта концепции АС, удовлетворяющего требованиям пользователя в общем случае, проводят разработку альтернативных вариантов концепции создаваемой АС и планов их реализации; оценку необходимых ресурсов на их реализацию и обеспечение функционирования; оценку преимуществ и недостатков каждого варианта; определение порядка оценки качества и условий приёмки системы; оценку эффектов, получаемых от системы. На этапе 2.4. Оформление отчёта о выполненной работе подготавливают и оформляют отчет, содержащий описание выполненных работ на стадии описания и обоснования предлагаемого варианта концепции системы. На этапе 3.1. Разработка и утверждение технического задания на создание АС проводят разработку, оформление, согласование и утверждение технического задания на АС и, при необходимости, технических заданий на части АС. На этапе 4.1. Разработка предварительных проектных решений по системе и её частям определяются: функции АС; функции подсистем, их цели и эффекты; состав комплексов задач и отдельных задач; концепция информационной базы, её укрупнённая структура; функции системы управления базой данных; состав вычислительной системы; функции и параметры основных программных средств. На этапе 5.1. Разработка проектных решений по системе и её частям обеспечивает разработку общих решений по системе и её частям, функционально-алгоритмической структуре системы, по функциям персонала и организационной структуре, по структуре технических средств, по алгоритмам решения задач и применяемым языкам, по организации и ведению 2
информационной базы, системе классификации и кодирования информации, по программному обеспечению. На этапах 4.2. и 5.2. Разработка документации на АС и её части проводят разработку, оформление, согласование и утверждение документации в объёме, необходимом для описания полной совокупности принятых проектных решений и достаточном для дальнейшего выполнения работ по созданию АС. Виды документов определяются по ГОСТ 34.201. На этапе 5.3. Разработка и оформление документации на поставку изделий для комплектования АС и (или) технических требований (технических заданий) на их разработку проводят: подготовку и оформление документации на поставку изделий для комплектования АС; определение технических требований и составление ТЗ на разработку изделий, не изготовляемых серийно. На этапе 5.4 Разработка заданий на проектирование в смежных частях проекта объекта автоматизации осуществляют разработку, оформление, согласование и утверждение заданий на проектирование в смежных частях проекта объекта автоматизации для проведения строительных, электротехнических, санитарнотехнических и других подготовительных работ, связанных с созданием АС. На этапе 6.1 Разработка рабочей документации на систему и её части осуществляют разработку рабочей документации, содержащей все необходимые и достаточные сведения для обеспечения выполнения работ по вводу АС в действие и её эксплуатации, а также для поддержания уровня эксплуатационных характеристик (качества) системы в соответствии с принятыми проектными решениями, её оформление, согласование и утверждение. Виды документов определяются по ГОСТ 34.201. На этапе 6.2 Разработка или адаптация программ проводят разработку программ и программных средств системы, выбор, адаптацию и (или) привязку приобретаемых программных средств, разработку программной документации в соответствии с ГОСТ 19.101. На этапе 7.1 Подготовка объекта автоматизации к вводу АС в действие проводят работы по организационной подготовке объекта автоматизации к вводу АС в действие, в том числе: реализацию проектных решений по организационной структуре АС; обеспечение подразделений объекта управления инструктивно-методическими материалами; внедрение классификаторов информации. На этапе 7.2 Подготовка персонала проводят обучение персонала и проверку его способности обеспечить функционирование АС. На этапе 7.3 Комплектация АС поставляемыми изделиями (программными и техническими средствами, программно-техническими комплексами, информационными изделиями) обеспечивают получение комплектующих изделий серийного и единичного производства, материалов и монтажных изделий. Проводят входной контроль их качества. На этапе 7.4 Строительно-монтажные работы проводят: выполнение работ по строительству специализированных зданий (помещений) для размещения технических средств и персонала АС; сооружение кабельных каналов; выполнение работ по монтажу технических средств и линий связи; испытание смонтированных технических средств; сдачу технических средств для проведения пусконаладочных работ. На этапе 7.5 Пусконаладочные работы проводят автономную наладку технических и программных средств, загрузку информации в базу данных и проверку системы её ведения; комплексную наладку всех средств системы. На этапе 7.6 Проведение предварительных испытаний осуществляют: а) испытания АС на работоспособность и соответствие техническому заданию в соответствии с программой и методикой предварительных испытаний; 3
б) устранение неисправностей и внесение изменений в документацию на АС, в том числе эксплуатационную в соответствии с протоколом испытаний; в) оформление акта о приёмке АС в опытную эксплуатацию. На этапе 7.7 Проведение опытной эксплуатации проводят: опытную эксплуатацию АС; анализ результатов опытной эксплуатации АС; доработку (при необходимости) программного обеспечения АС; дополнительную наладку (при необходимости) технических средств АС; оформление акта о завершении опытной эксплуатации. На этапе 7.8 Проведение приёмочных испытаний проводят: а) испытания на соответствие техническому заданию в соответствии с программой и методикой приёмочных испытаний; б) анализ результатов испытания АС и устранение недостатков, выявленных при испытаниях; в) оформление акта о приёмке АС в постоянную эксплуатацию. На этапе 8.1 Выполнение работ в соответствии с гарантийными обязательствами осуществляются работы по устранению недостатков, выявленных при эксплуатации АС в течении установленных гарантийных сроков, внесению необходимых изменений в документацию по АС. На этапе 8.2 Послегарантийное обслуживание осуществляют работы по: а) анализу функционирования системы; б) выявлению отклонений фактических эксплуатационных характеристик АС от проектных значений; в) установлению причин этих отклонений; г) устранению выявленных недостатков и обеспечению стабильности эксплуатационных характеристик АС; д) внесению необходимых изменений в документацию на АС. Межгосударственный стандарт ГОСТ 34.201-2020 "Информационные технологии. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем" устанавливает виды и наименование документов разрабатываемых при создании и использовании АС. Состав видов документов, разрабатываемых на стадии «Исследование и обоснование создания АС» определяют в соответствии ГОСТ Р 59793–2021, исходя из требуемых результатов выполнения данной стадии. На стадии «Техническое задание» разрабатывают Техническое задание (ТЗ) на создание автоматизированной системы в соответствии с требованиями ГОСТ 34.602–2020. Допускается разрабатывать частные ТЗ на отдельные системы (подсистемы, комплексы задач, программно-технические комплексы, компоненты технического и программного обеспечений и т. п.) Может возникать путаница в обозначении того, что считается Техническим заданием (Частным техническим заданием): На стадии 1. «Формирование требований к АС» для публикации на портале закупок или модернизации существующей системы подготавливается документ с требованиями к системе, называемый по сложившейся практике «Техническим заданием». Однако, документ, создаваемый на данной стадии, остается только лишь требованиями пользователя к системе, и Техническим заданием не является. А вот на стадии 3. «Техническое задание» разрабатывается именно Техническое задание на систему, которое и является Техническим заданием по ГОСТ на автоматизированные системы. Виды документов, разрабатываемых на стадиях «Эскизный проект», «Технический проект», «Рабочая документация» приведены в табл. 5.2. 4
Таблица 5.2 - Виды документов, разрабатываемых на стадиях «Эскизный проект», «Технический проект», «Рабочая документация». Вид документа Код документа Назначение документа Ведомость В Перечисление в систематизированном виде объектов, предметов и т. д. Схема С Графическое изображение форм документов, частей, элементов системы и связей между ними в виде условных обозначений Инструкция и Изложение состава действий и правил их выполнения персоналом Обоснование Б Изложение сведений, подтверждающих целесообразность принимаемых решений Описание П Пояснение назначения системы, ее частей, принципов их действия и условий применения Конструкторский документ По ГОСТ 2.102 Программный документ По ГОСТ 19.101 Наименование конкретных документов, разрабатываемых при проектировании системы в целом или ее части определяются ГОСТ 34.201, и включают 55 наименований документов. Номенклатуру документов одного наименования устанавливают в зависимости от принятых при создании системы проектных решений. Вся техническая документация на программный продукт (АСОИиУ, программу) разрабатывается в соответствии с требованиями ГОСТ ЕСПД и её можно разделить на следующие две категории: Программная документация – документация, содержащая сведения, необходимые для разработки, изготовления, эксплуатации и сопровождения программы (программного изделия). Эксплуатационная документация – документация, необходимая для обеспечения функционирования и эксплуатации программного изделия. Различают следующую документацию на программный продукт табл. 5.3. Таблица 5.3 - Документация на программный продукт Спецификация Состав программы и документации на нее Ведомость держателей подлинников Перечень предприятий, на которых хранят подлинники программных документов Текст программы Запись программы с необходимыми комментариями Описание программы Сведения о логической структуре и функционировании программы Программа и методика испытаний Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля Техническое задание Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний Пояснительная записка Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений Эксплуатационные документы Сведения для обеспечения функционирования и эксплуатации программы 5