Заглавная страница Избранные статьи Случайная статья Познавательные статьи Новые добавления Обратная связь КАТЕГОРИИ:  Археология Биология Генетика География Информатика История Логика Маркетинг Математика Менеджмент Механика Педагогика Религия Социология Технологии Физика Философия Финансы Химия ЭкологияТОП 10 на сайте Приготовление дезинфицирующих растворов различной концентрацииТехника нижней прямой подачи мяча. Франко-прусская война (причины и последствия) Организация работы процедурного кабинета Смысловое и механическое запоминание, их место и роль в усвоении знаний Коммуникативные барьеры и пути их преодоления Обработка изделий медицинского назначения многократного применения Образцы текста публицистического стиля Четыре типа изменения баланса Задачи с ответами для Всероссийской олимпиады по праву 
Мы поможем в написании ваших работ! ЗНАЕТЕ ЛИ ВЫ?
Влияние общества на человека
Приготовление дезинфицирующих растворов различной концентрации Практические работы по географии для 6 класса Организация работы процедурного кабинета Изменения в неживой природе осенью Уборка процедурного кабинета Сольфеджио. Все правила по сольфеджио Балочные системы. Определение реакций опор и моментов защемления |
Документация сопровождения и эксплуатационная документация
ЕСКД В соответствии с ГОСТ 2.102-2003 (Единая система конструкторской документации (ЕСКД). Виды и комплектность конструкторских документов), эксплуатационная документация - это документы, предназначенные для использования при эксплуатации, обслуживании и ремонте изделия в процессе эксплуатации. Разрабатываются такие документы на этапе рабочего проектирования. Номенклатуру и обязательность разработки определяет ГОСТ 2.601-2013 (ЕСКД. Эксплуатационные документы). Правила выполнения определенных ЭД приведены в ГОСТ 2.610-2006 (ЕСКД. Правила выполнения эксплуатационных документов). Общие требования к оформлению документации - по ГОСТ 2.105-95 (ЕСКД. Общие требования к текстовым документам). В ГОСТ 2.601 приведено определение эксплуатационного документа: Эксплуатационный документ – конструкторский документ, который в отдельности или в совокупности с другими документами определяет правила эксплуатации (например, руководство по эксплуатации) изделия и/или отражает сведения, удостоверяющие гарантированные изготовителем значения основных параметров и характеристик (свойств) изделия, гарантии и сведения по его эксплуатации в течение установленного срока службы (например, формуляр). Где эксплуатация изделия – это стадия жизненного цикла изделия с момента принятия его потребителем от предприятия-изготовителя или ремонтного предприятия до отправки в ремонт или списания. Сведения об изделии, помещаемые в ЭД, должны быть достаточными для обеспечения правильной и безопасной эксплуатации изделий в течение установленного срока службы. При необходимости, в ЭД приводят указания о требуемом уровне подготовке обслуживающего персонала. Виды, комплектность и выполнение (электронное или бумажное) ЭД устанавливает разработчик, опираясь на требования ТЗ и ЕСКД. Ниже представлена таблица, где определены виды и номенклатура эксплуатационных документов в соответствии с ЕСКД. Условные обозначения: + – документ обязательный; о – необходимость разработки документа устанавливает разработчик (по согласованию с заказчиком). Примечание – В зависимости от назначения изделия, условий эксплуатации и объёма помещаемых сведений в обязательном порядке разрабатывают либо ФО, либо ПС, либо ЭТ, либо включают один из этих документов в объединённый ЭД.
В зависимости от особенностей изделия и объёма сведений о нём, допускается разделять документ на части или разрабатывать объединённый ЭД.
Дополнительное указание | |||||||||||
| Руководство по эксплуатации | РЭ | Документ, содержащий сведения о конструкции, принципе действия, характеристиках (свойствах) изделия, его составных частях и указания, необходимые для правильной и безопасной эксплуатации изделия (использования по назначению, технического обслуживания, текущего ремонта, хранения и транспортирования) и оценок его технического состояния при определении необходимости отправки его в ремонт, а также сведения по утилизации изделия и его составных частей | о | – | ||||||||
| Инструкция по монтажу, пуску, регулированию и обкатке изделия | ИМ | Документ, содержащий сведения, необходимые для монтажа, наладки, пуска, регулирования, обкатки и сдачи изделия и его составных частей в эксплуатацию на месте его применения | о | ИМ составляют на монтаж, пуск, регулирование и обкатку изделия на месте его применения и в случае, если эти требования нецелесообразно или невозможно изложить в РЭ | ||||||||
| Формуляр | ФО | Документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, сведения, отражающие техническое состояние данного изделия, сведения о сертификации и утилизации изделия, а также сведения, которые вносят в период его эксплуатации (длительность и условия работы, техническое обслуживание, ремонт и другие данные) | + | Документ составляют на изделия, в период эксплуатации которых необходимо вносить сведения о значениях основных параметров и характеристиках (свойствах) изделия, отражающих техническое состояние данного изделия и/или данные о процессе эксплуатации (длительности и условиях работы, данные о проведении технического обслуживания, ремонта и другие данные)
| ||||||||
| Паспорт | ПС | Документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, а также сведения о сертификации и утилизации изделия
| + | ПС составляют на изделия, для которых объем необходимых для эксплуатации данных и основных показателей незначителен и в период эксплуатации которого нет необходимости вносить сведения о значениях и/или подтверждении этих показателей | ||||||||
| Этикетка | ЭТ | Документ, содержащий гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, сведения о сертификации изделия | + | ЭТ составляют на изделия, для которых данные, необходимые для эксплуатации, не превышают пяти-шести основных показателей, когда для подтверждения этих показателей нет необходимости составлять ФО (ПС) и технически их невозможно и/или нецелесообразно маркировать на изделии | ||||||||
| Каталог изделий | КИ | Документ, содержащий перечень деталей, сборочных единиц и комплексов изделия с иллюстрациями и сведения об их количестве, расположении в изделии, взаимозаменяемости, конструктивных особенностях, материалах и др. | о | КИ составляют на изделия, для которых в течение времени эксплуатации предусмотрены неоднократный ремонт и замены составных частей | ||||||||
| Нормы расхода запасных частей | НЗЧ | Документ, содержащий номенклатуру запасных частей изделия и их количество, расходуемое на нормируемое количество изделий за период их эксплуатации | о | Под НЗЧ на период эксплуатации одного изделия понимают среднее ожидаемое за этот период количество замен составных частей из-за отказов и выработки ресурсов | ||||||||
| Нормы расхода материалов | НМ | Документ, содержащий номенклатуру материалов и их количество, расходуемое на нормированное количество изделий за период их эксплуатации | о | Под НМ на период эксплуатации понимают среднее ожидаемое за этот период количество расходуемых материалов | ||||||||
| Ведомость комплекта запасных частей, инструмента и принадлежностей | ЗИ | Документ, содержащий номенклатуру, назначение, количество и места укладки запасных частей, инструментов, принадлежностей и материалов, расходуемых за срок службы изделия | о | ЗИ поставляют на изделия, с которыми совместно поставляют прилагаемые к ним комплекты ЗИП, а также наборы ЗИП, поставляемые отдельно от изделия, для эксплуатации которых предназначается ЗИП. Если количество наименований изделий и материалов незначительно, то ЗИ допускается не разрабатывать, а их номенклатуру перечислять в ФО или ПС | ||||||||
| Учебно-технические плакаты | УП | Документы, содержащие сведения о конструкции изделия, принципах действия, приемах использования, техническом обслуживании, областях технических знаний с необходимыми иллюстрациями | о | УП выпускают по ГОСТ 2.605 (ЕСКД. Плакаты учебно-технические. Общие технические требования) | ||||||||
| Инструкции эксплуатационные специальные | ИС | Документы, содержащие специальные требования, относящиеся к использованию по назначению, техническому обслуживанию, текущему ремонту, хранению, транспортированию и утилизации, оформленные в виде самостоятельных частей ЭД или в виде приложений к ним | о |
Документы составляют на изделия, для которых в течение времени эксплуатации следует выполнять специальные требования, относящиеся к использованию по назначению, техническому обслуживанию, текущему ремонту, хранению, транспортированию и утилизации
| ||||||||
| Ведомость эксплуатационных документов | ВЭ | Документ, устанавливающий комплект эксплуатационных документов и места укладки документов, поставляемых с изделием и | + | ВЭ составляют на изделия, в комплект эксплуатационных документов которых входят два и более самостоятельных эксплуатационных документа | ||||||||
Автоматизированные системы
При разработке решений в области информационных технологий стандарты ЕСКД применяются к документации на технические средства. Документация на автоматизированные системы разрабатывается по Комплексу стандартов на автоматизированные системы (КСАС, ГОСТ 34. *).
В соответствии с определением по ГОСТ 34.003-90 (Информационная технология. Комплекс стандартов на автоматизированные системы (КСАС). Автоматизированные системы. Термины и определения) эксплуатационная документация на автоматизированную систему (АС) – это часть рабочей документации на АС, предназначенная для использования при эксплуатации системы, определяющая правила действия персонала и пользователей системы при ее функционировании, проверке и обеспечении ее работоспособности. Перечень наименований разрабатываемых документов и их комплектность на систему и ее части должен быть определен в техническом задании на создание автоматизированной системы (подсистемы). Ниже приведена таблица, в которой приведены виды и номенклатура эксплуатационных документов в соответствии с КСАС.
Требования к содержанию документов приведены в РД 50-34.698-90 (Методические указания. Информационная технология. Комплекс стандартов и руководящих документов на автоматизированные системы. Автоматизированные системы требования к содержанию документов).
Содержание документов является общим для всех видов АС и, при необходимости, может дополняться разработчиком документов в зависимости от особенностей создаваемой АС. Допускается включать в документы дополнительные разделы и сведения, объединять и исключать разделы.
Общие требования к изложению текста документов – по ГОСТ 2.105-95 ЕСКД. Общие требования к текстовым документам.
| Вид документа | Код вида документа | Часть проекта | Дополнительные указания | ||
| Чертеж формы документа (видеокадра) | С9 | ИО | В документе должно быть приведено изображение формы документа или видеокадра в соответствии с требованиями государственных стандартов унифицированной системы документации, Р 50-77 и необходимые пояснения. На стадии ТП допускается включать в документы Описание постановки задач (комплекса задач) Описание информационного обеспечения системы | ||
| Ведомость эксплуатационных документов | ЭД | ОР | Документ содержит перечень эксплуатационных документов согласно ГОСТ 34.201. Ведомость заполняют по разделам - частям проекта АС | ||
| Ведомость машинных носителей информации | ВМ | ИО | Ведомость машинных носителей информации содержит обозначения, наименования документов, выполненных на машинных носителях. Запись документов осуществляется в порядке возрастания присвоенных обозначений | ||
| Массив входных данных | В6 | ИО | Документ содержит перечень входных данных с указанием их наименований, кодовых обозначений и значности реквизитов, а также наименований и кодовых обозначений документов или сообщений, содержащих эти данные | ||
| Каталог базы данных | В7 | ИО | Каталог базы данных содержит перечень объектов предметной области АС, информация о которых включена в базу данных | ||
| Состав выходных данных (сообщений) | В8 | ИО | Документ содержит перечень выходных данных с указанием их наименований, кодовых обозначений и значности реквизитов, а также наименований и кодовых обозначений документов или сообщений, содержащих эти данные | ||
| Методика (технология) автоматизированного проектирования | И1 | ОО | Документ описывает выбранные математические методы, используемые при проектировании, указывают состав и назначение проектных процедур, порядок взаимодействия проектных процедур в процессе выполнения | ||
| Технологическая инструкция | И2 | ОО | Документ "Технологическая инструкция" разрабатывают на операцию или комплекс операций технологического процесса обработки данных. В документе указывают наименование технологической операции (операций), на которую разработан документ, и приводят сведения о порядке и правилах выполнения операций (операции) технологического процесса обработки данных. В инструкции приводят перечень должностей персонала, на которые распространяется данная инструкция. Номенклатуру технологических инструкций определяют, исходя из принятого процесса обработки данных. Структуру документа устанавливает разработчик в зависимости от содержания | ||
| Руководство пользователя | И3 | ОО | Документ содержит полное описание системы, указания пользователю по подготовке к работе, освоению, эксплуатации системы, действиях при возникновении проблем в работе системы. | ||
| Инструкция по формированию и ведению базы данных (набора данных) | И4 | ИО | Документ описывает правила подготовки данных, порядок и средства заполнения, процедуры изменения, порядок и средства восстановления базы данных | ||
| Инструкция по эксплуатации КТС | ИЭ | ТО | Документ содержит указания о порядок работы, проверке правильности функционирования, меры безопасности, действиях в разных режимах при работе с комплексом технических средств системы | ||
| Описание технологического процесса обработки данных (включая телеобработку) | ПГ | ОО | Документ описывает технологический процесс сбора и обработки данных на периферийных устройствах при децентрализованной обработки данных и технологический процесс обработки данных на вычислительном центре | ||
| Общее описание системы | ПД | ОР | Документ содержит сведения о системе, ее архитектуре, принципах функционирования и необходимых ресурсах | ||
| Формуляр | ФО | ОР | Определения – по ГОСТ 2.601
| ||
| Паспорт | ПС | ОР |
ЕСПД
Сведения для обеспечения функционирования и эксплуатации программ (компонентов, комплексов) приводятся в эксплуатационной программной документации. Комплектность эксплуатационной документации на программные средства определяется по ГОСТ 19.101-77 (Единая система программной документации (ЕСПД). Виды программ и программных документов). Состав комплекта ЭД на программу зависит от её архитектуры, назначения и особенностей целевой аудитории. Необходимость составления того или иного документа определяется на этапе разработки и утверждения технического задания на программу. Ниже приведена таблица, в которой приведён перечень ЭД на программы.
Правила оформления программных документов для печатного способа выполнения установлены ГОСТ 19.106-78 (ЕСПД. Требования к программным документам, выполненным печатным способом).
В стандартах ЕСПД отсутствуют методические указания о том, как разработать документацию, они дают только перечень типов документов со списком разделов первого уровня для каждого и указания о том, какие сведения должны быть в нем изложены. Среди стандартов ИСО/МЭК есть ряд документов, касающихся процессов документирования при разработках в сфере информационных технологий. В отличие от ЕСПД, они содержат минимум требований к составу и структуре документов, при этом в них дано множество указаний, направленных на получение документов высокого качества. Возможно, комплексное применение указанных нормативных документов при разработке эксплуатационной документации на программы позволит повысить качество, информативность и полезность таких документов.
Еще ниже приведена таблица, в которую включены стандарты ИСО/МЭК, касающиеся процессов разработки программной и системной документации.
| Вид эксплуатационного документа | Код вида документа | Дополнительные указания |
| Ведомость эксплуатационных документов | 20 | В документе приводят перечень эксплуатационных документов на программу. Выполняется в соответствии с требованиями ГОСТ 19.507-79 |
| Формуляр | 30 | В документе указывают основные характеристики программы, комплектность и общие сведения об эксплуатации программы. Выполняется в соответствии с требованиями ГОСТ 19.501-78 |
| Описание применения | 31 | В документе приводят сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств, входных и выходных данных. Выполняется в соответствии с требованиями ГОСТ 19.502-78 |
| Руководство системного программиста | 32 | В документе приводят сведения для установки, проверки, обеспечения функционирования, интеграции в систему и настройки программы в определённых условиях применения ее, устранения аварийных ситуаций. Требования к содержанию и оформлению – по ГОСТ 19.503-79 |
| Руководство программиста | 33 | В документе приводят сведения по эксплуатации (сопровождению) программы. Выполняется по ГОСТ 19.504-79 |
| Руководство оператора | 34 | Документ содержит сведения о порядке действий оператора при использовании программы. Требования к содержанию и оформлению – по ГОСТ 19.505-79 |
| Описание языка | 35 | Документ содержит описание синтаксиса и семантики языка, элементов и конструкций, встроенных функций. Выполняется по ГОСТ 19.506-79 |
| Руководство по техническому обслуживанию | 46 | В документе приводят сведения для применения тестовых и диагностических программ при обслуживании технических средств. |
| Обозначение | Наименование |
| ГОСТ Р ИСО/МЭК 12207-99 | Информационная технология. Процессы жизненного цикла программных средств |
| ГОСТ Р ИСО/МЭК ТО 15271-2002 | Информационная технология. Руководство по применению ГОСТ Р ИСО/МЭК 12207 Процессы жизненного цикла программных средств |
| ГОСТ Р ИСО/МЭК 9126-93 | Информационная технология. Оценка программной продукции. Характеристики качества и руководство по их применению |
| ГОСТ Р ИСО/МЭК 15910-2002 | Информационная технология. Процесс создания документации пользователя программного средства |
| ГОСТ Р ИСО/МЭК ТО 9294-93 | Информационная технология. Руководство по управлению документированием программного обеспечения |
| ГОСТ Р ИСО/МЭК 15288-2005 | Информационная технология. Системная инженерия. Процессы жизненного цикла систем |
| ISO/IEC 15289 | Системная и программная инженерия. Содержание информационных продуктов (документации) процессов жизненного цикла систем и программных средств |
| ISO/IEC 26514 | Системная и программная инженерия. Требования для проектировщиков и разработчиков документации пользователя |
| ISO/IEC 26513 | Системная и программная инженерия. Требования по экспертизе и тестированию документации пользователя |
| ГОСТ Р 51904-2002 | Программное обеспечение встроенных систем. Общие требования к разработке и документированию |
| ISO/IEC 18019:2004 | Программная инженерия. Руководство по разработке и подготовке пользовательской документации на прикладные программные средства |
| ISO 6592:2000 | Обработка информации. Руководство по документации для вычислительных систем |
| ГОСТ Р ИСО 9127-94 | Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов. |
