exam03 1 - stankin/design-part-1 GitHub Wiki
Виды документов на автоматизированные системы. Требования к содержанию и оформлению.
Реферат к лекции 3. Проектная документация на информационные системы.
Выполнил: Кузьмин Антон, ИДБ-18-05
Проверил: Модин Кирилл, ИДБ-18-05
В современном мире невозможно представить себе разработку сложного технического продукта без комплекта документации, который описывает техническое задание продукта, его жизненный цикл, составляющие продукта.
Автоматизированная система — автоматизированная система - организационно-техническая система, обеспечивающая выработку решений на основе автоматизации информационных процессов в различных сферах деятельности (управление, проектирование, производство и тому подобное) или их сочетаниях.
Виды и наименования документов
Состав видов документов, разрабатываемых на стадии "Исследование и обоснование создания АС" определяют в соответствии с разд.3 ГОСТ 34.601, исходя из требуемых результатов выполнения данной стадии. На стадии "Техническое задание" разрабатывают Техническое задание (ТЗ) на создание автоматизированной системы в соответствии с требованиями ГОСТ 34.602. Допускается разрабатывать частные ТЗ на отдельные системы (подсистемы, комплексы задач, программно-технические комплексы, компоненты технического и программного обеспечений и т.п.). Виды документов, разрабатываемых на стадиях "Эскизный проект", "Технический проект", "Рабочая документация", приведены в табл.1.
Таблица 1
| Вид Документа | Код документа | Назначение документа |
|---|---|---|
| Ведомость | В | Перечисление в систематизированном виде объектов, предметов и т.д. |
| Схема | С | Графическое изображение форм документов, частей, элементов системы и связей между ними в виде условных обозначений |
| Инструкция | И | Изложение состава действий и правил их выполнения персоналом |
| Обоснование | Б | Изложение сведений, подтверждающих целесообразность принимаемых решений |
| Описание | П | Пояснение назначения системы, ее частей, принципов их действия и условий применения |
| Конструкторский документ | По ГОСТ 2.102 | |
| Программный документ | По ГОСТ 19.101 |
Процесс создания технической документации на АС представляет собой совокупность взаимосвязанных стадий (этапов) работ, представленных в табл. 2[2].
Таблица 2
| № | Стадия | Рекомендуемые к разработке документы | Выполняемые работы |
|---|---|---|---|
| 1 | Формирование требований к АС | отчеты по НИР | обследование объекта и обоснование необходимости создания АС; формирование требований пользователя к АС; оформление отчёта о выполненной работе и заявки на разработку АС; |
| 2 | Разработка концепции АС | концепция АС | изучение объекта; проведение необходимых научно-исследовательских работ; разработка вариантов концепции АС, удовлетворяющего требованиям пользователя; оформление отчёта о выполненной работе; |
| 3 | Техническое задание (ТЗ) | техническое задание | Разработка и утверждение технического задания на создание АС |
| 4 | Эскизный проект (ЭП) | пояснительная записка к эскизному проекту; документы, аналогичные ТП, но с наименьшей детализацией; | разработка предварительных проектных решений по системе и её частям; разработка документации на АС ТП и её части; |
| 5 | Технический проект (ТП) | описание автоматизируемых функций; описание постановки задач (комплекса задач); описание информационного обеспечения системы; описание организации информационной базы; описание программного обеспечения; описание алгоритма (проектной процедуры); | разработка проектных решений по системе и её частям; разработка документации на АС и её части; разработка и оформление документации на поставку изделий для комплектования АС и (или) технических требований (технических заданий) на их разработку; разработка заданий на проектирование в смежных частях проекта объекта автоматизации; |
| 6 | Рабочая документация (РД) | описание технологического процесса обработки данных; программа и методика испытаний; руководство пользователя; паспорт; | разработка рабочей документации на систему и её части; разработка или адаптация программ; |
| 7 | Ввод в действие | подготовка объекта автоматизации к вводу АС ТП в действие; подготовка персонала; комплектация АС поставляемыми изделиями (программными и техническими средствами, программно-техническими комплексами, информационными изделиями); строительно-монтажные работы; пусконаладочные работы; проведение предварительных испытаний; проведение опытной эксплуатации; проведение приёмочных испытаний; | |
| 8 | Сопровождение АС | выполнение работ в соответствии с гарантийными обязательствами; послегарантийное обслуживание; |
Полный перечень документов, разработка которых необходима при создании автоматизированной системы, указан в ГОСТ 34.201-89.
Комплектность документации
Пояснения терминов, применяемых в настоящем стандарте, приведены в приложении 1.
1.1. Перечень наименований разрабатываемых документов и их комплектность на систему и ее части должен быть определен в техническом задании на создание автоматизированной системы (подсистемы).
Примечание. Комплектность проектно-сметных документов определяют в соответствии с правилами, установленными системой проектной документации для строительства (СПДС).
2.2. На каждый комплект должна быть составлена ведомость документов.
2.3. Комплектность документации, обеспечивающей разработку, изготовление, приемку и монтаж технических средств, - по ГОСТ 2.102. Комплектность эксплуатационной документации на эти средства - по ГОСТ 2.601.
2.4. Комплектность документации на программные средства вычислительной техники - по ГОСТ 19.101.
2.5. При самостоятельной разработке части системы документы на нее комплектуют в соответствии с требованиями настоящего стандарта.
Обозначение документов
3.1. Каждому разработанному документу должно быть присвоено самостоятельное обозначение. Документ, выполненный на разных носителях данных, должен иметь одно обозначение. К обозначению документов, выполненных на машинных носителях, добавляют букву "М".
Заимствованным документам сохраняют ранее присвоенные обозначения.
3.2. Настоящие правила не распространяются на документы, правила обозначения которых регламентированы государственными стандартами других систем документации.
3.3. Обозначение документа имеет следующую структуру (рис. 1) :
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. Признак документа, выполненного на машинных носителях, вводят при необходимости. Букву "М" отделяют от предыдущего обозначения точкой.
Требования к содержанию и оформлению
Общие положения ГОСТ 2.105-95
Более подробно с условиями к содержанию и оформлению отдельных документов можно ознакомиться
3.1 Текстовые документы подразделяют на документы, содержащие, в основном, сплошной текст (технические условия, паспорта, расчеты, пояснительные записки, инструкции и т.п.), и документы, содержащие текст, разбитый на графы (спецификации, ведомости, таблицы и т.п.).
Текстовые документы выполняют в бумажной форме и (или) в форме электронного документа (ДЭ).
Допускается в текстовых документах, содержащих текст, разбитый на графы, использовать сокращения слов по ГОСТ 2.316.
3.2 Текстовые документы выполняют на формах, установленных соответствующими стандартами Единой системы конструкторской документации (ЕСКД) и Системы проектной документации для строительства (СПДС).
Требования, специфические для некоторых видов текстовых документов (например, эксплуатационных документов), приведены в соответствующих стандартах.
3.3 Подлинники текстовых документов выполняют одним из следующих способов:
-
машинописным, при этом следует выполнять требования ГОСТ 13.1.002. Шрифт пишущей машинки должен быть четким, высотой не менее 2,5 мм, лента только черного цвета (полужирная);
-
рукописным - чертежным шрифтом по ГОСТ 2.304 с высотой букв и цифр не менее 2,5 мм. Цифры и буквы необходимо писать четко черной тушью;
-
с применением печатающих и графических устройств вывода ЭВМ (ГОСТ 2.004);
-
на электронных носителях данных.
3.4 Копии текстовых документов выполняют одним из следующих способов:
-
типографским - в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом;
-
ксерокопированием - при этом рекомендуется размножать способом двустороннего копирования;
-
светокопированием;
-
микрофильмированием;
-
на электронных носителях данных.
3.5 Вписывать в текстовые документы, изготовленные машинописным способом, отдельные слова, формулы, условные знаки (рукописным способом), а также выполнять иллюстрации следует черными чернилами, пастой или тушью.
3.6 Расстояние от рамки формы до границ текста в начале и в конце строк - не менее 3 мм.
Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10 мм.
Абзацы в тексте начинают отступом, равным пяти ударам пишущей машинки (15-17 мм).
Пример выполнения текстового документа приведен в приложении А.
3.7 Опечатки, описки и графические неточности, обнаруженные в процессе выполнения документа, допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправленного текста (графики) машинописным способом или черными чернилами, пастой или тушью рукописным способом.
Повреждения листов текстовых документов, помарки и следы неполностью удаленного прежнего текста (графика) не допускаются.
После внесения исправлений документ должен удовлетворять требованиям микрофильмирования, установленным ГОСТ 13.1.002.
3.8 Для размещения утверждающих и согласующих подписей к текстовым документам рекомендуется составлять титульный лист и (или) лист утверждения в соответствии с разделом 6 настоящего стандарта.
Обязательность и особенности выполнения титульных листов оговорены в стандартах ЕСКД и СПДС на правила выполнения соответствующих документов.
3.9 К текстовым документам рекомендуется выпускать лист регистрации изменений в соответствии с ГОСТ 2.503 и ГОСТ 21.101.
3.10 Содержательная и реквизитная части ДЭ должны соответствовать требованиям стандарта ЕСКД.
Структура и состав реквизитов ДЭ должны обеспечивать его обращение в рамках программных средств (отображение, внесение изменений, печать, учет и хранение в базах данных, а также передачу в другие автоматизированные системы) с соблюдением при этом нормативных требований по оформлению текстовых документов.
Полный перечень требований указан в ГОСТ 2.105-95
Элементы (устройства, функциональные группы), входящие в систему и изображённые на схеме, должны иметь буквенно-цифровые обозначения в соответствии со стандартами на правила выполнения конкретных видов схем. Для построения условных обозначений используют прописные буквы латинского алфавита, арабские цифры. Обозначение записывают в виде последовательности букв, цифр и знаков в одну строку без пробелов. Позиционные обозначения проставляются сверху вниз, слева направо внутри функциональной группы или по всему чертежу.
На схеме допускается помещать различные технические данные, характеризующие систему в целом и отдельные её элементы. Эти сведения помещают либо около графических обозначений, либо на свободном поле схемы, как правило, над основной надписью.
В документах следует применять стандартизированные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417-2002[20].
Организационно-распорядительная документация должна разрабатываться с учётом требований ГОСТ Р 6.30-97[21].
Для отражения жизненного цикла АС должна быть разработана документация на ТС и ПО, а также – основной комплект документов на саму АС. КД на ТС выпускается в соответствии с требованиями ЕСКД. ПД разрабатывается в соответствии с требованиями ЕСПД. Состав и содержание документации на саму АС определяется требованиями стандартов КСАС (рис. 2):
Так же стоит отметить, что разработка документации на АС может проводиться и без учёта требований КСАС. Такой подход к разработке документации на АС имеет место, например, при создании изделий военной техники: содержание, обозначение, оформление и комплектность конструкторской, технологической и программной документации, разрабатываемой в процессе выполнения опытно-конструкторских работ и их составных частей, а также порядок её согласования, утверждения и изменения должен соответствовать требованиям стандартов ЕСКД, ЕСПД, ЕСТД и прочей нормативной документации по согласованию с заказчиком (по ГОСТ РВ 15.002-2003[22]). В этом случае для регламентирования состава и содержания комплекта документов на АС используются стандарты ЕСКД и ЕСПД. При этом содержание документов может быть изменено и дополнено с учётом специфики разрабатываемого изделия. Главный принцип остаётся тем же, что и при разработке по КСАС: комплект документации должен максимально полно отражать все стадии жизненного цикла изделия.
Перечень разрабатываемых документов на систему и её части должен определяется в ТЗ. Полный комплект документации на АС должен содержать весь набор данных для создания, внедрения и сопровождения системы.
❌ Так и осталось за кадром: как определяются требования к содержанию документов на АС?.
! С требованиями к содержанию все не так просто:
! 1. ЕСПД и ЕСКД не имеют прямого отношения к документации на АС.
! 2. РД 50-34.698-90 отменен без замены
! 3. ГОСТ Р ИСО/МЭК 15910-2002 и аналогичные определяют требования только к отдельным видам документов
! Фактически требования к содержанию являются предметом соглашения между заказчиком и исполнителем
! в каждом конкретном контракте. Единых официальных требований не существует.