admin / 12.04.2018
26.04.2018г.
ИСПОЛЬЗОВАНИЕ ТРЕБОВАНИЙ ГОСТ 19 и 34 СЕРИИ ПРИ ОФОРМЛЕНИИ ДОКУМЕНТАЦИИ В IT-ПРОЕКТАХ ДЛЯ ГОСУДАРСТВЕННЫХ СТРУКТУР
Введение
Современный мир невозможно себе представить без средств автоматизации, которые со стремительной скоростью повсеместно внедряются в коммерческих и государственных структурах, что обеспечивает более эффективную работу бизнеса и государственного сектора. Внедрение тех или иных средств автоматизации как правило, предполагает разработку документации на различных стадиях, таких как: формирования требований к информационной системе; на стадии технического проекта; стадии разработки рабочей документации.
При этом, бывают ситуации, когда разработчики документации и заказчик не всегда имеют одинаковое представление о количестве, структуре и содержании разрабатываемых документов. Это приводит к тому, что результаты работ не устраивают заказчика, приходится дополнительно тратить ресурсы на доработку документов. Использование требований ГОСТ при разработке документации позволяет избежать подобных ситуаций, т.к. несмотря на бытующее мнение об отставании стандартов от современных технологий, ГОСТ предоставляет четкую структуру разрабатываемой документации, обладает свойствами полноты и непротиворечивости, а также снимает спорные вопросы между исполнителем и заказчиком к результатам работ. Тем более, что в большинстве государственных организаций разработка документации по ГОСТ является обязательным условием. Далее мы попробуем разобраться в тонкостях разработки документации по требованиям ГОСТ.
При разработке автоматизированных систем (АС) по ГОСТ 34 в IT-проектах для госструктур зачастую возникает вопрос: по каким ГОСТам оформлять документацию? В ГОСТ 34 нет явных указаний на то, по каким стандартам оформлять конкретные документы, разрабатываемые в рамках создания АС, кроме требований к оформлению ТЗ. Попробуем выяснить, какие ГОСТы используются при оформлении документов в случае отсутствия точных указаний в государственном контракте или конкурсном техническом задании (ТЗ). Данный материал в первую очередь, предназначен для IT-специалистов, желающих разобраться, как оформляются документы в IT-проектах по требованиям ГОСТ.
Определение стандартов оформления документации
Оформление документов в ГОСТ 34 зависит от вида документа (конструкторский или программный), и стадии создания АС, на которой готовится документ.
Перечень документов, разрабатываемых на различных стадиях создания АС приведен в ГОСТ 34.201-89 «Виды, комплектность и обозначение документов при создании автоматизированных систем». В нем приведены следующие требования:
Теперь разберем подробнее, как определить стандарты оформления в различных проектах.
Оформление ТЗ
С ТЗ всё достаточно ясно: в ГОСТ 34.602-89 приведен стандарт его оформления: п.3.2. гласит, что «ТЗ на АС оформляют в соответствии с требованиями ГОСТ 2.105 на листах формата А4 по ГОСТ 2.301 без рамки, основной надписи и дополнительных граф к ней».
Оформление программной документации
С программными документами, разрабатываемыми в рамках ИТ-проекта, также есть чёткое указание использовать ГОСТ 19 серии в части оформления: вышеприведённый ГОСТ 19.101-77 входит в серию ГОСТов 19-й серии «Единая система программной документации» (ЕСПД). ЕСПД — комплекс государственных стандартов Российской Федерации, устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации.
Документация в ЕСПД оформляется по ГОСТ 19.104-78 «Единая система программной документации. Основные надписи», ГОСТ 19.105-78 «Единая система программной документации. Общие требования к программным документам», ГОСТ 19.106-78 «Единая система программной документации. Требования к программным документам, выполненным печатным способом».
Оформление конструкторской документации
Теперь рассмотрим ГОСТ 2.102-2013. Этот стандарт входит в серию ГОСТов 2-й серии «Единая система конструкторской документации» (ЕСКД). ЕСКД — межгосударственный комплекс стандартов, устанавливающих взаимосвязанные нормы и правила по разработке, оформлению и обращению конструкторской документации, разрабатываемой и применяемой на всех стадиях жизненного цикла изделия (при проектировании, изготовлении, эксплуатации, ремонте и др.)
Документация в ЕСКД оформляется по нескольким стандартам. Наиболее часто используемыми из них (применительно к ИТ-сфере) являются ГОСТ 2.105-95 «Единая система конструкторской документации. Общие требования к текстовым документам» и ГОСТ 2.106-96 «Единая система конструкторской документации. Текстовые документы».
На первый взгляд из ГОСТ 34 серии непонятно, как оформлять документацию на АС. Нередко в рамках ИТ-проекта, особенно для государственных заказчиков, в ТЗ бывают требования по оформлению документации согласно ГОСТ 2.105-95 и ГОСТ 2.106-96. Но следует ли оформлять документы по этим ГОСТам в случае, если в явном виде требования к оформлению отсутствуют?
Как правильно оформить?
В ГОСТ 2-й серии приведены требования к назначению каждого стандарта и обозначена отрасль его применения: ГОСТ 2.102-2013 – стандарт устанавливает виды и комплектность конструкторских документов на изделия всех отраслей промышленности.
Если ГОСТ 2.102-2013 распространяется на изделия всех отраслей, в том числе и ИТ-сферу, давайте разберёмся, а что является конструкторским документом?
Согласно ГОСТ 2.001-2013 «Единая система конструкторской документации (ЕСКД). Общие положения»:
А) «3.1.2 конструкторский документ: Документ, который в отдельности или в совокупности с другими документами определяет конструкцию изделия и имеет содержательную и реквизитную части, в том числе установленные подписи»
Б) «3.1.5 конструкторская документация: Совокупность конструкторских документов, содержащих данные, необходимые для проектирования (разработки), изготовления, контроля, приемки, поставки, эксплуатации, ремонта, модернизации, утилизации изделия»
На этом можно было бы и остановиться, логически сопоставив требования к составу документов нашего ИТ-проекта с положениями, приведенными выше, и определив, относится ли каждый из документов к конструкторским или нет и выполнив оформление по стандартам ГОСТ 2-й серии.
Основные ГОСТы 2-й серии для ИТ-проекта в части оформления
Теперь посмотрим на основные ГОСТы 2-й серии, наиболее часто применяемые для оформления документов в ИТ-проекте. Как правило, в части оформления используют:
ГОСТ 2.105-95 – стандарт устанавливает общие требования к выполнению текстовых документов на изделия машиностроения, приборостроения и строительства;
ГОСТ 2.106-96 – стандарт устанавливает формы и правила выполнения конструкторских документов изделий машиностроения и приборостроения.
У читателя может возникнуть вопрос, можем ли мы применять эти ГОСТы для АС, если они предназначены для изделий машиностроения и приборостроения?
Согласно определению «Большой Советской энциклопедии», «Приборостроение -отрасль машиностроения, выпускающая средства измерения, анализа, обработки и представления информации, устройства регулирования, автоматические и автоматизированные системы управления; область науки и техники, разрабатывающая средства автоматизации и системы управления», то есть всё, что нужно по нашей теме современных информационных технологий.
Кроме этого, если заглянуть в ГОСТ 34.003-90 «Автоматизированные системы. Термины и определения», этот стандарт определяет АС как «систему, состоящую из персонала и комплекса средств автоматизации его деятельности, реализующую информационную технологию выполнения установленных функций».
Таким образом, АС относится к отрасли приборостроения и, следовательно, конструкторские документы АС оформляются по ГОСТ 2.105-95 и ГОСТ 2.106-96.
Теперь давайте рассмотрим основные моменты оформления проектной документации по ГОСТ 2.105-95 и ГОСТ 2.106-96.
Основные моменты при оформлении по ГОСТ 2. 105
Рассмотрим основные параметры оформления по ГОСТ 2-й серии.
Согласно ГОСТ 2.105-95 расстояние от рамки формы до границ текста в начале и в конце строк должно быть не менее 3 мм. Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10 мм. Абзацы в тексте начинают отступом, равным пяти ударам пишущей машинки (15 — 17 мм).
В ГОСТ 2.105-95 не определены параметры для оформления текста в электронном виде: название шрифта, высота шрифта, межстрочный интервал. Поэтому параметры оформления документов в электронном виде это, как правило, предмет договоренности с заказчиком.
В начале работы по оформлению в электронном виде определяются параметры для форматирования:
Таблица — используемый шрифт текста, межстрочный интервал, толщина границ таблицы, ширина таблицы, отступ в ячейке, название размещается над таблицей. Форматирование названия Таблицы выполняется таким же образом, как у основного текста документа. По ГОСТ 2.105-95 высота строк таблицы должна быть не менее 8 мм. Высота шрифта строк таблицы также может быть согласована с заказчиком.
Иллюстрации в документе следует располагать по центру. Название размещается непосредственно под иллюстрацией. Форматирование названия – как у текста документа.
Правила оформления таблиц
Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости, в приложении к документу.
Таблицы, за исключением таблиц приложений, нумеруют арабскими цифрами сквозной нумерацией. Например: «Таблица 1».
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например: «Таблица В.1».
Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой. Например, в разделе 4 номер будет «Таблица 4.3».
Название таблицы должно отражать ее содержание, быть точным, кратким. Название состоит из слова «Таблица», номера таблицы и текста. В ГОСТ 2.105-95 не определено использование в названии таблицы дефиса или тире. На практике может использоваться тире, по аналогии использования в названии рисунка тире. Например, «Таблица 5 – Выполняемые работы, содержание и сроки». Точка в конце названия не ставится. Название размещают над таблицей слева.
В ГОСТ 2.105-95 в п.п 4.4.3 приведено следущее требование: «На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера». На практике слово «таблица» склоняется в тексте по правилам русского языка. Например: «Краткое описание назначения и основных характеристик подсистем ИС МП второй очереди представлено в таблице 1».
Если таблица размещается на нескольких страницах, следует отобразить ее заголовок в начале каждой страницы.
В ГОСТ 2.105-95 есть необязательное требование в п.4.4.7: «если в конце страницы таблица прерывается и ее продолжение будет на следующей странице, в первой части таблицы нижнюю горизонтальную линию, ограничивающую таблицу, допускается не проводить.». На практике нижнюю горизонтальную линию, проводят, так ее отсутствие ухудшает восприятие таблицы пользователем.
Правила оформления иллюстраций
К иллюстрациям относятся графические изображения (схемы, графики, фотографии, рисунки).
Иллюстрации, за исключением иллюстраций приложений, нумеруются арабскими цифрами, при этом нумерация сквозная. Например: «Рисунок 3».
Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например: «Рисунок В.6».
Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например, в разделе 5 номер будет «Рисунок 5.2».
Допускается не нумеровать мелкие иллюстрации (мелкие рисунки), размещенные непосредственно в тексте и на которые в дальнейшем по тексту нет ссылок.
Требования ГОСТ 2.105-95 к расположению: «иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в конце его».
В ГОСТ 2.105-95 в п. 4.3.1 указано следующее: «при ссылках на иллюстрации следует писать «… в соответствии с рисунком 2» при сквозной нумерации и «… в соответствии с рисунком 1.2» при нумерации в пределах раздела».
Название пишется под иллюстрацией в формате «Рисунок 1 – Детали прибора».
Интересный факт: если ошибку в бумажном документе замазать и поверх написать исправление черными чернилами, это будет по ГОСТу. ГОСТ 2.105-95 допускает исправления документов в бумажном виде. Об этом гласит п.3.7: «Опечатки, описки и графические неточности, обнаруженные в процессе выполнения документа, допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправленного текста (графика) машинописным способом или черными чернилами, пастой или тушью рукописным способом. Повреждения листов текстовых документов, помарки и следы не полностью удаленного прежнего текста (графика) не допускаются».
То есть, если вы что-то распечатали и нашли ошибку, то её можно исправить вручную приведенным выше способом.
Оформление по ГОСТ 2. 106-96
ГОСТ 2.106-96 устанавливает формы и правила выполнения конструкторских документов. Для каждого типа документа в ГОСТ 2.106-96 приведен шаблон оформления рамок документа.
ГОСТ 2.106-96 определяет не только форму рамок, но и основную надпись в рамке. Пример из ГОСТ 2.106-96: «ПЗ составляют на формах 9 и 9а приложения А, а необходимые схемы, таблицы и чертежи в бумажной форме допускается выполнять на листах любых форматов, установленных ГОСТ 2.301, при этом основную надпись и дополнительные графы к ней выполняют в соответствии с требованиями ГОСТ 2.104 (форма 2а)».
Резюме
В дополнение к вышесказанному можно сказать, что при разработке АС по ГОСТ 34 в IT-проектах для государственных структур в случае отсутствия точных указаний в государственном контракте или конкурсном ТЗ программная и конструкторская документация должна оформляться по следующим ГОСТам:
Необходимо проверять ГОСТы на актуальность и использовать последнюю редакцию стандартов, поскольку они, хотя и редко, но всё же обновляются. Надеюсь, статья поможет вам лучше ориентироваться в требованиях ГОСТ, а в случае необходимости вы всегда можете обратиться к специалистам.
К списку публикаций
Содержание
ГОСТ 34.601-90 Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания.
Комплекс стандартов на автоматизированные системы |
ГОСТ 34.601-90 |
АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. СТАДИИ СОЗДАНИЯ. |
|
Information technology. Set of standards for automated systems. Stages of development. |
Дата введения
с 01.01.1992г.
Настоящий стандарт распространяется на автоматизированные системы (АС), используемые в различных видах деятельности (исследование, проектирование, управление и т.п.), включая их сочетания, создаваемые в организациях, объединениях и на предприятиях (далее — организациях).
Стандарт устанавливает стадии и этапы создания АС. В приложении 1 приведено содержание работ на каждом этапе.
1.1. Процесс создания АС представляет собой совокупность упорядоченных во времени, взаимосвязанных, объединённых в стадии и этапы работ, выполнение которых необходимо и достаточно для создания АС, соответствующей заданным требованиям.
1.2. Стадии и этапы создания АС выделяются как части процесса создания по соображениям рационального планирования и организации работ, заканчивающихся заданным результатом.
1.3. Работы по развитию АС осуществляют по стадиям и этапам, применяемым для создания АС.
1.4. Состав и правила выполнения работ на установленных настоящим стандартом стадиях и этапах определяют в соответствующей документации организаций, участвующих в создании конкретных видов АС.
Перечень организаций, участвующих в работах по созданию АС, приведён в приложении 2.
2.1.
Стадии и этапы создания АС в общем случае приведены в таблице.
Стадии |
Этапы работ |
1. Формирование требований к АС |
1.1. Обследование объекта и обоснование необходимости создания АС. 1.2. Формирование требований пользователя к АС. 1.3. Оформление отчёта о выполненной работе и заявки на разработку АС (тактико-технического задания) |
2. Разработка концепции АС. |
2.1. Изучение объекта. 2.2. Проведение необходимых научно-исследовательских работ. 2.3. Разработка вариантов концепции АС, удовлетворяющего требованиям пользователя. 2.4. Оформление отчёта о выполненной работе. |
3. Техническое задание. |
Разработка и утверждение технического задания на создание АС. |
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. Послегарантийное обслуживание. |
2.2. Стадии этапы, выполняемые организациями — участниками работ по созданию АС, устанавливаются в договорах и техническом задании на основе настоящего стандарта.
Допускается исключить стадию «Эскизный проект» и отдельные этапы работ на всех стадиях, объединять стадии «Технический проект» и «Рабочая документация» в одну стадию «Технорабочий проект». В зависимости от специфики создаваемых АС и условий их создания допускается выполнять отдельные этапы работ до завершения предшествующих стадий, параллельное во времени выполнение этапов работ, включение новых этапов работ.
ПРИЛОЖЕНИЕ 1
(справочное)
1. На этапе 1.1. «Обследование объекта и обоснование необходимости создания в АС» общем случае проводят:
2. На этапе 1.2. «Формирование требований пользователя к АС» проводят:
3.
На этапе 1.3. «Оформление отчёта о выполненной работе и заявки на разработку АС (технико-технического задания)» проводят оформление отчета о выполненных работах на данной стадии и оформление заявки на разработку АС (тактико-технического задания) или другого заменяющего её документа с аналогичным содержанием.
4. На этапах 2.1. «Изучение объекта» и 2.2. «Проведение научно-исследовательских работ» организация-разработчик проводит детальное изучение объекта автоматизации и необходимые научно-исследовательские работы (НИР), связанные с поиском путей и оценкой возможности реализации требований пользователя, оформляют и утверждают отчёты о НИР.
5. На этапе 2.3. «Разработка вариантов концепции АС и выбор варианта концепции АС, удовлетворяющего требованиям пользователя» в общем случае, проводят разработку альтернативных вариантов концепции создаваемой АС и планов их реализации; оценку необходимых ресурсов на их реализацию и обеспечение функционирования; оценку преимуществ и недостатков каждого варианта; определение порядка оценки качества и условий приёмки системы; оценку эффектов, получаемых от системы.
6. На этапе 2.4. «Оформление отчёта о выполненной работе» подготавливают и оформляют отчет, содержащий описание выполненных работ на стадии описания и обоснования предлагаемого варианта концепции системы.
7. На этапе 3.1. «Разработка и утверждение технического задания на создание АС» проводят разработку, оформление, согласование и утверждение технического задания на АС и, при необходимости, технических заданий на части АС.
8. На этапе 4.1. «Разработка предварительных проектных решений по системе и её частям» определяются: функции АС; функции подсистем, их цели и эффекты; состав комплексов задач и отдельных задач; концепция информационной базы, её укрупнённая структура; функции системы управления базой данных; состав вычислительной системы; функции и параметры основных программных средств.
9. На этапе 5.1. «Разработка проектных решений по системе и её частям» обеспечивает разработку общих решений по системе и её частям, функционально-алгоритмической структуре системы, по функциям персонала и организационной структуре, по структуре технических средств, по алгоритмам решения задач и применяемым языкам, по организации и ведению информационной базы, системе классификации и кодирования информации, по программному обеспечению.
10. На этапах 4.2. и 5.2. «Разработка документации на АС и её части» проводят разработку, оформление, согласование и утверждение документации в объёме, необходимом для описания полной совокупности принятых проектных решений и достаточном для дальнейшего выполнения работ по созданию АС. Виды документов — по ГОСТ 34.201-89.
11. На этапе 5.3. «Разработка и оформление документации на поставку изделий для комплектования АС и (или) технических требований (технических заданий) на их разработку» проводят: подготовку и оформление документации на поставку изделий для комплектования АС; определение технических требований и составление ТЗ на разработку изделий, не изготовляемых серийно.
12. На этапе 5.4 «Разработка заданий на проектирование в смежных частях проекта объекта автоматизации» осуществляют разработку, оформление, согласование и утверждение заданий на проектирование в смежных частях проекта объекта автоматизации для проведения строительных, электротехнических, санитарно-технических и других подготовительных работ, связанных с созданием АС.
13. На этапе 6.1 «Разработка рабочей документации на систему и её части» осуществляют разработку рабочей документации, содержащей все необходимые и достаточные сведения для обеспечения выполнения работ по вводу АС в действие и её эксплуатации, а также для поддержания уровня эксплуатационных характеристик (качества) системы в соответствии с принятыми проектными решениями, её оформление, согласование и утверждение. Виды документов по ГОСТ 34.201-89.
14. На этапе 6.2 «Разработка или адаптация программ» проводят разработку программ и программных средств системы, выбор, адаптацию и (или) привязку приобретаемых программных средств, разработку программной документации в соответствии с ГОСТ 19.101.
15. На этапе 7.1 «Подготовка объекта автоматизации к вводу АС в действие» проводят работы по организационной подготовке объекта автоматизации к вводу АС в действие, в том числе:
16. На этапе 7.2 «Подготовка персонала» проводят обучение персонала и проверку его способности обеспечить функционирование АС.
17. На этапе 7.3 «Комплектация АС поставляемыми изделиями (программными и техническими средствами, программно-техническими комплексами, информационными изделиями)» обеспечивают получение комплектующих изделий серийного и единичного производства, материалов и монтажных изделий, проводят входной контроль их качества.
18. На этапе 7.4 «Строительно-монтажные работы» проводят:
19. На этапе 7.5 «Пусконаладочные работы» проводят:
20. На этапе 7.6 «Проведение предварительных испытаний» осуществляют:
21. На этапе 7.7 «Проведение опытной эксплуатации» проводят:
22. На этапе 7.8 «Проведение приёмочных испытаний» проводят:
23. На этапе 8.1 «Выполнение работ в соответствии с гарантийными обязательствами» осуществляются работы по устранению недостатков, выявленных при эксплуатации АС в течении установленных гарантийных сроков, внесению необходимых изменений в документацию по АС.
24.
На этапе 8.2 «Послегарантийное обслуживание» осуществляют работы по:
ПРИЛОЖЕНИЕ 2
(справочное)
1. Организация-заказчик (пользователь), для которой создаются АС и которая обеспечивает финансирование, приемку работ и эксплуатацию АС, а также выполнение отдельных работ по созданию АС.
2. Организация-разработчик, которая осуществляет работы по созданию АС, представляет заказчику совокупность научно-технических услуг на разных стадиях и этапах создания, а также разрабатывает и поставляет различные программные и технические средства АС.
3. Организация-поставщик, которая изготавливает и поставляет программные и технические средства по заказу разработчика или заказчика.
4. Организация-генпроектировщик объекта автоматизации.
5. Организации-проектировщики различных частей проекта объекта автоматизации для проведения строительных, электротехнических, санитарно-технических и других подготовительных работ, связанных с созданием АС.
6. Организации строительные, монтажные, наладочные и другие.
Примечания:
Приведенные в этом разделе документы не являются официально распространяемыми. Для получения учтенных экземпляров обратитесь в соответствующие службы вашего региона.
Поиск по сайту www.cad.dp.ua:
Пользовательский поиск
Требования к содержанию документов по функциональной части.
Copyright © Сайт поддержки пользователей САПР by Victor Tkachenko
Назад | (Взамен ГОСТ 24.101-80, ГОСТ 24.102-80, РД 50-617-86) |
УДК 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. Состав видов документов, разрабатываемых на стадии «Исследование и обоснование создания АС» определяют в соответствии с разд. 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.3.2. Виды документов на программные средства, используемые при создании АС (ее частей), — по ГОСТ 19.101.
1.3.3. Виды документов на технические средства, используемые при создании АС (ее частей), — по ГОСТ 2.102 и по ГОСТ 2.601 в части эксплуатационных документов.
1.3.4. В зависимости от применяемых методов проектирования и специфики создаваемых АС допускается:
1.4. На стадиях «Изготовление несерийных компонентов КСА» и «Ввод в действие» разрабатывают следующие организационно-распорядительные документы:
2.1. Перечень наименований разрабатываемых документов и их комплектность на систему и ее части должен быть определен в техническом задании на создание автоматизированной системы (подсистемы).
Примечание. Комплектность проектно-сметных документов определяют в соответствии с правилами, установленными системой проектной документации для строительства (СПДС).
2.2. На каждый комплект должна быть составлена ведомость документов.
2.3. Комплектность документации, обеспечивающей разработку, изготовление, приемку и монтаж технических средств, — по ГОСТ 2.102. Комплектность эксплуатационной документации на эти средства — по ГОСТ 2.601.
2.4. Комплектность документации на программные средства вычислительной техники — по ГОСТ 19.101.
2.5. При самостоятельной разработке части системы документы на нее комплектуют в соответствии с требованиями настоящего стандарта.
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.602-89 ТЗ должно содержать следующие разделы (приведены в сокращенном виде):
1.Пример:
Полное наименование системы: Автоматизированная система "Управление" Условное обозначение: АСУ
1.
1. шифр темы или шифр (номер) договора;
1. Пример:
Договор № ХХХ от ДД.ММ.ГГГГ
1. 1.наименование предприятий (объединений) разработчика и заказчика (пользователя) системы и их реквизиты;
1. Пример:
ЗАКАЗЧИК Наименование заказчика: ООО "МИР" Юридический адрес заказчика: 142345, г. Москва, ул. Тверская, дом 15 Почтовый адрес заказчика: 142345, г. Москва, ул. Тверская, дом 15 Фактический адрес заказчика: 142345, г. Москва, ул. Тверская, дом 15 Телефон: +7 903 456 67 67 Факс: +7 903 453 34 54 Адрес электронной почты: Pro@mir.com ОГРН: 4554545445454 ИНН: 4343434345 КПП: 453345443 БАНК: ЗАО "БанкСтрой", г. Москва БИК: 444454554 РС: 564456456456454453445 КС: 43223423{{[[Шаблон:❷]}}400000000234
ИСПОЛНИТЕЛЬ Наименование исполнителя: ООО "ДЯТЕЛ" Юридический адрес заказчика: 142345, г. Москва, ул. Ленина, дом 34 Почтовый адрес заказчика: 142345, г. Москва, ул. Ленина, дом 34 Фактический адрес заказчика: 142345, г. Москва, ул. Ленина, дом 34 Телефон: +7 495 345 63 63 Факс: +7 495 433 34 54 Адрес электронной почты: Gena@gizni.net ОГРН: 4554545445454 ИНН: 4343434345 КПП: 453345443 БАНК: ЗАО "БанкСтрой", г. Москва БИК: 444454554 РС: 564456456456454453445 КС: 43223423400000000234
1 1. перечень документов, на основании которых создается система, кем и когда утверждены эти документы;
2. Назначение и цели создания системы
3. Характеристика объекта автоматизации
1 краткие сведения об объекте автоматизации или ссылки на документы, содержащие такую информацию;
2 сведения об условиях эксплуатации объекта автоматизации и характеристиках окружающей среды.
4. Требования к системе
1. Требования к системе в целом;
2. Требования к функциям (задачам), выполняемым системой;
3. Требования к видам обеспечения.
5. Состав и содержание работ по созданию системы
6. Порядок контроля и приемки системы
7. Требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие
8. Требования к документированию
9. Источники разработки: документы и информационные материалы (технико-экономическое обоснование, отчеты о законченных научно-исследовательских работах, информационные материалы на отечественные, зарубежные системы-аналоги и др.), на основании которых разрабатывалось ТЗ и которые должны быть использованы при создании системы.
©2015-2018 poisk-ru.ru
Все права принадлежать их авторам. Данный сайт не претендует на авторства, а предоставляет бесплатное использование.
Нарушение авторских прав и Нарушение персональных данных
Содержание
Ниже представлен пример (образец) проектного документа «Пояснительная записка к техническому проекту на создание автоматизированной системы«, основанный на методических указаниях РД 50-34.698-90. Данный документ формируется IT-специалистом на стадии технического проектирования информационной системы.
В качестве примера разработки информационной системы использован проект внедрения информационно-аналитической системы «Корпоративное хранилище данных».
На странице ниже приведено содержание пояснительной записки технического проекта в соответствии с ГОСТ, внутри каждого из разделов кратко приведены требования к содержанию и текст примера заполнения (выделяется вертикальной чертой).
Разделы пояснительной записки:
Основные технические решения
Решения по структуре системы, подсистем, средствам и способам связи для информационного обмена между компонентами системы
Решения по взаимосвязям АС со смежными системами, обеспечению ее совместимости
Решения по режимам функционирования, диагностированию работы системы
Решения по персоналу и режимам его работы
Сведения об обеспечении заданных в техническом задании потребительских характеристик системы, определяющих ее качество
Состав функций, комплексов задач реализуемых системой
Состав и размещение комплексов технических средств
Решения по составу информации, объему, способам ее организации, видам машинных носителей, входным и выходным документам и сообщениям, последовательности обработки информации и другим компонентам
Методы и средства разработки
Мероприятия по подготовке объекта автоматизации к вводу системы в действие
Пояснительная записка к техническому проекту на создание автоматизированной системы «Корпоративное хранилище данных»
1.1. Наименование системы
1.1.1. Полное наименование системы
Полное наименование — Корпоративное хранилище данных.
1.1.2. Краткое наименование системы
Краткое наименование — КХД, Система.
1.2.
Основания для проведения работ
Указывается номер и дата договора. Перечень документов, на основании которых создается система, кем и когда утверждены документы.
Например: Работа выполняется на основании договора № … от … между …
1.3. Наименование организаций – Заказчика и Разработчика
Заказчик: ОАО Заказчик Адрес фактический: г. Москва . Телефон / Факс: +7 (495) 2222222 begin_of_the_skype_highlighting +7 (495) 2222222 end_of_the_skype_highlighting
Разработчик: ЗАО Разработчик Адрес фактический: г. Москва . Телефон / Факс: +7 (495) 3333333 begin_of_the_skype_highlighting +7 (495) 3333333 end_of_the_skype_highlighting
1.4 Цели, назначение и область использования системы
Определяются цели (чего хочет достичь организация Заказчика от внедрения системы); назначение (для каких пользователей предназначена); области использования АИС (какие виды деятельности организации Заказчика охватывает система).
Информация для разделов «Наименование системы», «Основания для проведения работ», «Наименование организаций – Заказчика и Разработчика», «Цели, назначение и область использования системы» берется из одноименных разделов технического задания на создание корпоративного хранилища данных.
Для продолжения скачивания необходимо собрать картинку:
В этом разделе собраны шаблоны документов для разработки технической документации согласно ГОСТ 19, ГОСТ 34 и др. Надеемся они Вам пригодятся. Обсудить все тонкости разработки технической документации согласно ГОСТ вы можете на форуме разработчиков технической документации или в комментариях под каждым из шаблонов.
Все шаблоны предоставляются бесплатно!
Если не нашли шаблона, то пишите здесь
Если у Вас есть шаблоны документов, которых еще нет в этом каталоге, то просим прислать их на нашу почту. Помогите своим коллегам!
Благодарность за помощь в пополнении коллекции выражаем: Максиму Казначееву
Настоящий шаблон устанавливает состав и требования к содержанию документа «Пояснительная записка к техническому проекту». Разделы шаблона соответствуют требованиям РД 50-34.698-90.
В зависимости от особенностей документа отдельные разделы (подразделы) допускается объединять, а также вводить новые разделы (подразделы).
Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
ПЗ на ТП включает (по согласованию с заказчиком) план мероприятий по подготовке объекта к вводу системы в эксплуатацию.
Допускается включать в ПЗ следующие документы технического проекта:
«Описание алгоритма (проектной процедуры)» — ПБ (мат. обеспечение);
«Описание постановки задачи (комплекса задач)» — П4 (общесистемные решения);
«Перечень заданий на разработку специализированных (новых) технических средств» — В9 (проектно-сметная документация, техническое обеспечение);
«Перечень заданий на разработку строительных, электротехнических, санитарно-технических и других разделов проекта, связанных с созданием системы» — В3 (проектно-сметная документация, техническое обеспечение).
Posted on30.11.2017by. This entry was posted in Название категории. Bookmark the permalink.
FILED UNDER : IT