Единого понимания, что такое «производственная инструкция», какова ее структура и что она должна содержать, нет, поэтому у многих специалистов возникают сложности при ее составлении. Попробуем разобраться в этом.
Организация, эксплуатирующая ОПО, обязана проводить подготовку и аттестацию работников в области промышленной безопасности[1]. И если с ИТР все более-менее понятно — они обязаны проходить обучение по промышленной безопасности в порядке повышения квалификации по дополнительным образовательным программам (не менее 16 часов) и аттестацию в законном порядке, то с рабочими все не так однозначно.
Работники ОПО обязаны проходить подготовку в области промышленной безопасности в соответствии с требованиями к таким работникам, установленными федеральными нормами и правилами в области промышленной безопасности[2] (далее — ФНП). Формы указанной подготовки определяются организацией, эксплуатирующей ОПО. Производственная инструкция (далее — ПИ) является одним из инструментов такой подготовки.
При этом ФНП не раскрывают понятие ПИ, не устанавливают требования к ее содержанию. В некоторых ФНП указывается, что на ОПО должны быть инструкции с другим названием, например технологические инструкции, рабочие инструкции или технологические регламенты. Единого понимания, что такое «производственная инструкция», какова ее структура и что она должна содержать, нет, поэтому у многих специалистов возникают сложности при ее составлении. Попробуем разобраться с этими вопросами.
Что такое «производственная инструкция»?
Двоякое применение термина
Термин «производственная инструкция» на практике имеет двоякое толкование.
В кадровом деле этот термин употребляют наряду с термином «должностная инструкция», только применительно к профессиям рабочих. Согласно письму Роструда от 24.11.2008 № 6234-ТЗ «для определения содержания выполняемой трудовой функции работников, замещающих определенные должности, следует составлять и утверждать должностные инструкции, а для определения содержания выполняемой трудовой функции работников, принимаемых на работу по профессиям рабочих, следует разрабатывать и утверждать производственные (по профессии) инструкции».
Роструд исходит из того, что указанные инструкции создаются по тем же принципам, что и должностные, однако, поскольку труд рабочих по большинству профессий не предполагает активного взаимодействия с другими работниками, принятия самостоятельных решений и т. д., то в них не так подробно детализируются права, взаимосвязи, ответственность и другие элементы их статуса в соответствии с заключенным трудовым договором.
Таким образом, по мнению Роструда, производственные инструкции разрабатываются для рабочих и они аналогичны должностным инструкциям для ИТР.
В промышленной безопасности термин «производственная инструкция» понимается как документ, который разрабатывается организацией, применяется для определенных видов работ и содержит требования к технологическим и вспомогательным процессам, не указанные в технологической документации.
Обязанность разрабатывать ПИ для работников прямо или косвенно установлена в ФНП. Соответственно, ПИ разрабатываются для работников, которые связаны с деятельностью на ОПО. К этим видам деятельности относятся:
• проектирование и строительство ОПО;
• эксплуатация и капитальный ремонт ОПО;
• реконструкция и техническое перевооружение;
• консервация и ликвидация ОПО;
• монтаж и наладка ТУ, применяемых на ОПО;
• обслуживание и ремонт ТУ, применяемых на ОПО.
По мнение многих юристов-кадровиков, ПИ в той или иной степени регламентируют вопросы охраны труда и безопасного выполнения работ, это некий алгоритм действий работника с определенным оборудованием, в т. ч. опасным, направленный на обеспечение безопасных условий труда и предотвращение производственного травматизма.
Например, в п. 6 ФНП № 512[3] приведены требования к наличию различной производственно-технологической и эксплуатационной документации, а также даны их определения:
Инструкции подразделяются на технологические, производственные, по эксплуатации, по порядку пуска и остановки агрегатов.
Технологическая инструкция представляет собой документ с описанием операций технологического процесса (технологического метода) изготовления определенного вида продукции.
Производственная инструкция представляет собой документ с описанием рабочего процесса (метода) для определенных видов работ или операций, содержащий требования к технологическим или вспомогательным процессам.
Инструкция по эксплуатации представляет собой документ, содержащий сведения о применении, использовании и безопасной эксплуатации агрегата (линии, технического устройства).
Требования безопасности, установленные Правилами (имеются ввиду ФНП), для включения их в технологические или производственные инструкции обязательны.
Технологические и производственные инструкции разрабатываются с учетом квалификационных требований или профессиональных стандартов по соответствующим профессиям рабочих, руководства по эксплуатации оборудования, а также особенностей технологического или вспомогательного процесса, установленных проектной и/или технической документацией.
Инструкция по порядку пуска и остановки агрегатов документально устанавливает алгоритм запуска технологического процесса или агрегатов (линий, оборудования, технических устройств). Инструкция по порядку пуска и остановки агрегатов должна включать: пуск, нормальную работу, остановку и аварийные ситуации. Порядок операций в инструкции должен соответствовать принципиальным электрическим схемам и учитывать требования производственной документации.
Инструкции по порядку пуска и остановки агрегатов обязательны при сложном, многоступенчатом порядке запуска и остановки производственного процесса, выполняемого под визуальным контролем работника-оператора.
Необходимость применения инструкции по эксплуатации организация определяет самостоятельно.
Инструкции должны быть разработаны с учетом производственной документации.
В различных ФНП применяется различная терминология для обозначения инструкций, например: инструкция по безопасному производству работ, безопасной эксплуатации оборудования, инструкция по порядку пуска и остановки агрегатов и т. п.
ФНП, в которых есть требование разработать ПИ и другие инструкции, мы свели в табл. 1.
Производственные, должностные, по охране труда — в чем отличие
Из вышесказанного следует, что ПИ не являются аналогом должностных инструкций: они не определяют трудовые функции, а устанавливают требования безопасности к производству работ, эксплуатации оборудования (см. табл. 2).
Инструкция — это документ, в котором даются указания по осуществлению каких-либо процессов, действий по работе[4].
При этом и ПИ, и должностные инструкции могут разрабатываются на основе одних и тех же нормативных актов.
ПИ не являются и инструкциями по охране труда. Отличия мы свели в табл. 3.
Организационные вопросы создания ПИ
На основе каких документов разрабатывать ПИ?
До 21 декабря 2019 г. при разработке ПИ можно было просто ссылаться на п. 26 Положения об организации обучения и проверки знаний рабочих организаций, поднадзорных Федеральной службе по экологическому, технологическому и атомному надзору[5], где было сказано: «В организациях должны быть разработаны и утверждены в порядке, установленном в этих организациях, производственные инструкции, которые разрабатываются на основании квалификационных требований, указанных в квалификационных справочниках, и/или профессиональных стандартах по соответствующим профессиям рабочих, а также с учетом особенностей технологических процессов конкретного производства».
Но Положение утратило силу, поэтому при разработке ПИ остается руководствоваться требованиями профильных для вашей деятельности ФНП (см. табл. 1), ПОТ, типовыми инструкциями по безопасности, руководствами (инструкциями) по эксплуатации оборудования, инструкциями по применению исходных материалов, паспортами безопасности химических веществ, нормативно-технической документацией, методическими рекомендациями, а также технологической документацией, принятыми в организации.
Кто должен составлять ПИ?
ТК РФ не уделяет ПИ никакого внимания, поэтому нет и указаний, кто должен заниматься их составлением и оформлением. В каждой организации этот вопрос решается по-разному.
[1] Часть 1 ст. 9 Федерального закона от 21.07.1997 № 116-ФЗ (в ред. от 14.11.2023; далее — Федеральный закон № 116-ФЗ).
[2] Перечень Федеральных норм и правил и Правил безопасности в области промышленной безопасности приведён в Приказе Ростехнадзора от 17.10.2016 № 421 (в ред. от 13.12.2023) «Об утверждении перечней правовых актов, содержащих обязательные требования, соблюдение которых оценивается при проведении мероприятий по контролю в рамках осуществления видов государственного контроля (надзора), отнесенных к компетенции Федеральной службы по экологическому, технологическому и атомному надзору».
[3] Федеральные нормы и правила в области промышленной безопасности «Правила безопасности процессов получения или применения металлов», утв. Приказом Ростехнадзора от 09.12.2020 № 512.
[4] Постановление Минтруда России от 10.09.1993 № 152 «Нормы времени на работы по автоматизированной архивной технологии и документационному обеспечению органов управления».
[5] Утв. Приказом Ростехнадзора от 29.01.2007 № 37.
Материал публикуется частично. Полностью его можно прочитать в журнале «Промышленная безопасность» № 1, 2024.
Разработка руководства по эксплуатации
При выпуске в обращение технически сложной продукции в состав ее сопроводительной документации должно входить руководство по эксплуатации. Документ содержит основные правила использования, хранения и транспортировки изделия, особенности обслуживания и способы применения, позволяющие максимально продлить срок службы. РЭ также включает подробное описание продукта, в том числе, технические характеристики, параметры, конструкцию, принцип действия, инструкцию по сборке и ремонту в случае поломки.
Для чего разрабатывается РЭ?
Основной целью разработки руководства по эксплуатации является обеспечение безопасной долгосрочной работы оборудования и исключение риска причинения вреда здоровью человека. Без РЭ невозможно пройти процедуру оценки соответствия товара и получить разрешительный документ: сертификат или декларацию.
Такие сертификационные документы необходимы для законного производства и импорта оборудования и устройств.
Требования к содержанию документа
Содержание руководства по эксплуатации регламентировано действующими нормативно-правовыми актами и может незначительно отличаться в зависимости от вида и назначения продукции. Однако, несмотря на это, РЭ включает следующие обязательные разделы:
- полное наименование изделия;
- основные технические характеристики, сведения о конструктивных особенностях, основных свойствах устройства;
- составные элементы, формирующие комплектность изделия;
- принцип работы;
- меры предосторожности и обеспечения безопасной эксплуатации;
- этапы сборки и монтажа;
- указания по регулировке и наладке:
- информация о периодическом сервисном обслуживании и ремонте;
- возможные причины возникновения поломок, ошибок и правила их устранения;
- условия гарантии производителя;
- данные о периоде службы и ресурсе;
- сведения о транспортировке и упаковке;
- порядок вывода из эксплуатации и утилизации;
- данные об испытательных мероприятиях продукции;
- информация о вводе в эксплуатацию.
Дополнительные схемы, рисунки, фотографии, чертежи и таблицы способствуют более правильному восприятию пользователем сложной технической информации.
Нормативные документы
Порядок разработки инструкции по эксплуатации отражен в национальных стандартах:
- ГОСТ 2.601-2013 регулирует требования к содержанию руководства пользователя;
- ГОСТ 2.610-2006 содержит основные правила оформления РЭ.
Документом по составлению РЭ, имеющим международный статус, является технический регламент Таможенного союза. ТР ТС 010/2011, включающий в себя стандарты безопасности машин и оборудования, содержит расширенные требования к оформлению руководства по эксплуатации на технически сложные объекты.
Именно данный регламент предполагает создание РЭ как неотъемлемую часть процесса проектирования изделия. Также требования к разработке РЭ содержаться в других узкоспециализированных нормативно-технических документах международного торгово-экономического альянса (ЕАЭС), например: ТР ТС 032/2013, ТР ТС 016/2011
Правила оформления
Вся информация, изложенная в руководстве по эксплуатации, должна соответствовать требованиям действующих нормативно-технических актов. Содержание РЭ должно быть достаточным для использования как специалистом, так и простым пользователем. Документ должен быть изложен понятно и доступно, чтобы у потребителя не возникало трудностей в процессе эксплуатации продукции. Особенно это касается технически сложных объектов, машин и механизмов, подлежащих обязательной сертификации, — анализ РЭ в этом случае является важным этапом процедуры оценки соответствия.
Также в инструкции по эксплуатации должны быть отражены меры предосторожности и указания по оценке технического состояния изделия для определения необходимости текущего и внепланового ремонта. Специалисты сервисного обслуживания довольно часто используют РЭ в работе, поэтому при его составлении необходимо это учитывать, так как документ должен содержать исчерпывающую информацию, необходимую экспертам.
Согласно требованиям ТР ТС 010, руководство по эксплуатации подобно обоснованию безопасности — документу, который разрабатывается при проектировании. Таким образом, многие разделы РЭ идентичны или тесно переплетаются с положениями ОБ.
Необходимая документация
- заявка на разработку РЭ;
- информация о предприятии, инициирующем разработку инструкции по эксплуатации (наименование, реквизиты, учредительные и регистрационные документы);
- документация на изделие, устройство или оборудование.
Заказать разработку РЭ или ознакомиться с дополнительной информацией можно у сотрудников сертификационного центра «ГОСТ Р». Консультации бесплатны!
Отправьте заявку
Технологическая инструкция (ТИ) — это важный документ, который описывает технологические процессы, методы и правила выполнения различных производственных операций. ТИ необходима для обеспечения стабильного качества продукции, соблюдения технологических норм и повышения эффективности производства. Разработка технологической инструкции является ключевым этапом в организации производственного процесса.
Среднее время прочтения: 7-10 мин
Оставьте заявку, и за это время менеджер проконсультирует вас именно по вашей продукции.
Содержание:
1. Зачем нужна технологическая инструкция
2. Правила разработки технологических инструкций
3. Области применения технологических инструкций
4. Где можно заказать разработку ТИ
5. Заключение
Зачем нужна технологическая инструкция
Технологическая инструкция выполняет несколько важных функций:
- Обеспечение качества продукции: ТИ описывает все этапы технологического процесса, что позволяет обеспечить стабильное качество продукции и минимизировать производственные дефекты.
- Соблюдение стандартов и нормативов: ТИ помогает соблюдать требования государственных стандартов и технических регламентов, что особенно важно при сертификации продукции.
- Повышение эффективности производства: ТИ оптимизирует производственные процессы, улучшая их последовательность и устраняя лишние операции, что приводит к снижению затрат и увеличению производительности.
- Обучение персонала: ТИ служит руководством для сотрудников, помогая им правильно выполнять технологические операции и быстро адаптироваться к новым задачам.
- Управление производственными рисками: ТИ позволяет идентифицировать и контролировать потенциальные риски на различных этапах технологического процесса.
Правила разработки технологических инструкций
Процесс разработки технологической инструкции должен соответствовать установленным стандартам и включать несколько ключевых этапов:
- Сбор информации: на этом этапе собирается вся необходимая информация о технологическом процессе, включая данные о материалах, оборудовании, условиях производства и требованиях к качеству продукции.
- Анализ и структурирование данных: полученные данные анализируются и структурируются для создания логичной и последовательной инструкции. Важно учитывать все технологические операции и их взаимосвязь.
- Оформление документа: требования к оформлению технологических инструкций установлены ГОСТ 3.1105-2011. В соответствии с этим стандартом ТИ должна содержать следующие разделы:
- Введение
- Область применения
- Описание технологического процесса
- Описание оборудования и инструментов
- Требования к материалам
- Технические характеристики и параметры
- Правила безопасности и охраны труда
- Контроль качества
- Заключение
- Проверка и утверждение: разработанная ТИ проверяется на соответствие требованиям ГОСТ и внутренним стандартам предприятия. После проверки документ утверждается руководством.
- Внедрение и обучение персонала: после утверждения ТИ внедряется в производственный процесс. Проводится обучение персонала для ознакомления с новыми технологическими инструкциями.
Области применения технологических инструкций
Технологические инструкции применяются в различных областях производства, включая:
- Непрерывные технологические процессы: например, технологические процессы металлургического производства, химического производства и т. п.
- Специализированные технологические процессы: процессы, связанные с отдельными методами изготовления или ремонта изделий, формы документов которых не установлены стандартами ЕСТД.
- Общие и повторяющиеся работы: например, приготовление электролитических растворов, клеев, смол, компаундов, смесей материалов и т. д.
- Эксплуатация средств технологического оснащения: описание правил эксплуатации оборудования и инструментов.
- Физические и химические явления: описание явлений, возникающих при выполнении технологических операций.
- Настроечные и регулировочные работы: описание процессов настройки и регулировки оборудования.
Где можно заказать разработку ТИ
Разработку технологических инструкций можно заказать в специализированных центрах, которые занимаются подготовкой технической документации. Наш центр по разработке технологической документации предлагает полный спектр услуг, включая:
- Сбор и анализ информации: мы собираем все необходимые данные о вашем производственном процессе.
- Разработка и оформление ТИ: наши специалисты разработают и оформят технологическую инструкцию в соответствии с требованиями ГОСТ 3.1105-2011.
- Проверка: мы проводим проверку на соответствие всем стандартам.
Наши преимущества:
• Профессионализм: команда опытных специалистов с многолетним опытом работы в области разработки технической документации.
• Индивидуальный подход: мы учитываем особенности каждого клиента и разрабатываем инструкции, соответствующие специфике вашего производства.
• Комплексные услуги: от сбора информации до разработки всех документов — мы обеспечиваем полный цикл услуг.
Обратившись к нам, вы получите профессиональную поддержку на всех этапах разработки технологической инструкции, что обеспечит высокое качество вашей продукции и эффективность производственных процессов.
Заключение
Разработка ТИ требует тщательного подхода и соблюдения всех установленных требований. Наш центр готов помочь вам на всех этапах разработки технологической документации. Обратившись к нам, вы получите профессиональную поддержку и уверенность в успехе вашего предприятия.
Получить просчет на почту
Опишите нам свою продукцию или цель сертификации. Менеджер пришлет подробную информацию или запросит, что нужно для точного просчета.
| Техническая документация |
Техническая документация — это набор документов, используемых предприятием при проектировании, изготовлении и эксплуатации любых технических решений, объектов и продукции.
К видам технической документации относятся:
-
- конструкторская документация;
- программная документация;
- документация на автоматизированные системы;
- технологическая документация, технические условия.
К основным этапам разработки технической документации относятся:
-
- формирование целей и задач разработки;
- определение предмета документирования;
- формирование требований к документации;
- составление текста документации;
- согласование документации с предприятием — заказчиком;
- передача комплекта документации предприятию – заказчику.
К одному из видов технической документации относятся технические условия (ТУ), документ, который должен содержать полный комплекс требований к продукции, ее изготовлению, транспортировке и хранению, указания по эксплуатации, контролю и приемке. ТУ является техническим документом, который разрабатывается по решению предприятия – заказчика производителя продукции. Технические условия разрабатываются на одно конкретное изделие или группу изделий.
Для разработки ТУ от предприятия – заказчика требуется предоставление следующего перечня документов:
-
- код ОКПО изготовителя;
- наименование изделия, перечень модификаций;
- техническое описание изделия, перечень технических параметров и область применения;
- описание технологического процесса производства продукции;
- методы и средства контроля испытаний, способы упаковки, транспортировки и хранения изделий;
- способы упаковки и упаковочный материал, перечень документов, вкладываемых в упаковку;
- требования безопасности при изготовлении и эксплуатации изделия;
- сроки гарантии.
Данная статья посвящена разработке эксплуатационной документации для конструкторских, программных изделий и автоматизированных систем. Рассмотрены основные виды ЭД, их коды и обозначения. Также приведены ссылки на стандарты в соответствии с которыми разрабатывается эксплуатационная документация.
1. ЕСКД
В соответствии с ГОСТ 2.102-2003 (Единая система конструкторской документации (ЕСКД). Виды и комплектность конструкторских документов), эксплуатационная документация — это документы, предназначенные для использования при эксплуатации, обслуживании и ремонте изделия в процессе эксплуатации. Разрабатываются такие документы на этапе рабочего проектирования. Номенклатуру и обязательность разработки определяет ГОСТ 2.601-2013 (ЕСКД. Эксплуатационные документы). Правила выполнения определенных ЭД приведены в ГОСТ 2.610-2006 (ЕСКД. Правила выполнения эксплуатационных документов). Общие требования к оформлению документации — по ГОСТ 2.105-95 (ЕСКД. Общие требования к текстовым документам).
В ГОСТ 2.601 приведено определение эксплуатационного документа:
Эксплуатационный документ – конструкторский документ, который в отдельности или в совокупности с другими документами определяет правила эксплуатации (например, руководство по эксплуатации) изделия и/или отражает сведения, удостоверяющие гарантированные изготовителем значения основных параметров и характеристик (свойств) изделия, гарантии и сведения по его эксплуатации в течение установленного срока службы (например, формуляр).
Где эксплуатация изделия – это стадия жизненного цикла изделия с момента принятия его потребителем от предприятия-изготовителя или ремонтного предприятия до отправки в ремонт или списания.
Сведения об изделии, помещаемые в ЭД, должны быть достаточными для обеспечения правильной и безопасной эксплуатации изделий в течение установленного срока службы. При необходимости, в ЭД приводят указания о требуемом уровне подготовке обслуживающего персонала.
Виды, комплектность и выполнение (электронное или бумажное) ЭД устанавливает разработчик, опираясь на требования ТЗ и ЕСКД.
Ниже представлена таблица, где определены виды и номенклатура эксплуатационных документов в соответствии с ЕСКД.
|
Вид документа |
Код вида доку-мента |
Определение |
Степень обязатель- |
Дополнительное указание |
|
Руководство по эксплуатации |
РЭ |
Документ, содержащий сведения о конструкции, принципе действия, характеристиках (свойствах) изделия, его составных частях и указания, необходимые для правильной и безопасной эксплуатации изделия (использования по назначению, технического обслуживания, текущего ремонта, хранения и транспортирования) и оценок его технического состояния при определении необходимости отправки его в ремонт, а также сведения по утилизации изделия и его составных частей |
о |
– |
|
Инструкция по монтажу, пуску, регулированию и обкатке изделия |
ИМ |
Документ, содержащий сведения, необходимые для монтажа, наладки, пуска, регулирования, обкатки и сдачи изделия и его составных частей в эксплуатацию на месте его применения |
о |
ИМ составляют на монтаж, пуск, регулирование и обкатку изделия на месте его применения и в случае, если эти требования нецелесообразно или невозможно изложить в РЭ |
|
Формуляр |
ФО |
Документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, сведения, отражающие техническое состояние данного изделия, сведения о сертификации и утилизации изделия, а также сведения, которые вносят в период его эксплуатации (длительность и условия работы, техническое обслуживание, ремонт и другие данные) |
+ |
Документ составляют на изделия, в период эксплуатации которых необходимо вносить сведения о значениях основных параметров и характеристиках (свойствах) изделия, отражающих техническое состояние данного изделия и/или данные о процессе эксплуатации (длительности и условиях работы, данные о проведении технического обслуживания, ремонта и другие данные) |
|
Паспорт |
ПС |
Документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, а также сведения о сертификации и утилизации изделия |
+ |
ПС составляют на изделия, для которых объем необходимых для эксплуатации данных и основных показателей незначителен и в период эксплуатации которого нет необходимости вносить сведения о значениях и/или подтверждении этих показателей |
|
Этикетка |
ЭТ |
Документ, содержащий гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, сведения о сертификации изделия |
+ |
ЭТ составляют на изделия, для которых данные, необходимые для эксплуатации, не превышают пяти-шести основных показателей, когда для подтверждения этих показателей нет необходимости составлять ФО (ПС) и технически их невозможно и/или нецелесообразно маркировать на изделии |
|
Каталог изделий |
КИ |
Документ, содержащий перечень деталей, сборочных единиц и комплексов изделия с иллюстрациями и сведения об их количестве, расположении в изделии, взаимозаменяемости, конструктивных особенностях, материалах и др. |
о |
КИ составляют на изделия, для которых в течение времени эксплуатации предусмотрены неоднократный ремонт и замены составных частей |
|
Нормы расхода запасных частей |
НЗЧ |
Документ, содержащий номенклатуру запасных частей изделия и их количество, расходуемое на нормируемое количество изделий за период их эксплуатации |
о |
Под НЗЧ на период эксплуатации одного изделия понимают среднее ожидаемое за этот период количество замен составных частей из-за отказов и выработки ресурсов |
|
Нормы расхода материалов |
НМ |
Документ, содержащий номенклатуру материалов и их количество, расходуемое на нормированное количество изделий за период их эксплуатации |
о |
Под НМ на период эксплуатации понимают среднее ожидаемое за этот период количество расходуемых материалов |
|
Ведомость комплекта |
ЗИ |
Документ, содержащий номенклатуру, назначение, количество и места укладки запасных частей, инструментов, принадлежностей и материалов, расходуемых за срок службы изделия |
о |
ЗИ поставляют на изделия, с которыми совместно поставляют прилагаемые к ним комплекты ЗИП, а также наборы ЗИП, поставляемые отдельно от изделия, для эксплуатации которых предназначается ЗИП. Если количество наименований изделий и материалов незначительно, то ЗИ допускается не разрабатывать, а их номенклатуру перечислять в ФО или ПС |
|
Учебно-технические плакаты |
УП |
Документы, содержащие сведения о конструкции изделия, принципах действия, приемах использования, техническом обслуживании, областях технических знаний с необходимыми иллюстрациями |
о |
УП выпускают по ГОСТ 2.605 (ЕСКД. Плакаты учебно-технические. Общие технические требования) |
|
Инструкции эксплуатационные специальные |
ИС |
Документы, содержащие специальные требования, относящиеся к использованию по назначению, техническому обслуживанию, текущему ремонту, хранению, транспортированию и утилизации, оформленные в виде самостоятельных частей ЭД или в виде приложений к ним |
о |
Документы составляют на изделия, для которых в течение времени эксплуатации следует выполнять специальные требования, относящиеся к использованию по назначению, техническому обслуживанию, текущему ремонту, хранению, транспортированию и утилизации |
|
Ведомость эксплуатационных документов |
ВЭ |
Документ, устанавливающий комплект эксплуатационных документов и места укладки документов, поставляемых с изделием и |
+ |
ВЭ составляют на изделия, в комплект эксплуатационных документов которых входят два и более самостоятельных эксплуатационных документа |
|
Условные обозначения: + – документ обязательный; о – необходимость разработки документа устанавливает разработчик (по согласованию с заказчиком). Примечание – В зависимости от назначения изделия, условий эксплуатации и объёма помещаемых сведений в обязательном порядке разрабатывают либо ФО, либо ПС, либо ЭТ, либо включают один из этих документов в объединённый ЭД. |
В зависимости от особенностей изделия и объёма сведений о нём, допускается разделять документ на части или разрабатывать объединённый ЭД.
2. Автоматизированные системы
При разработке решений в области информационных технологий стандарты ЕСКД применяются к документации на технические средства. Документация на автоматизированные системы разрабатывается по Комплексу стандартов на автоматизированные системы (КСАС, ГОСТ 34.*).
В соответствии с определением по ГОСТ 34.003-90 (Информационная технология. Комплекс стандартов на автоматизированные системы (КСАС). Автоматизированные системы. Термины и определения) эксплуатационная документация на автоматизированную систему (АС) – это часть рабочей документации на АС, предназначенная для использования при эксплуатации системы, определяющая правила действия персонала и пользователей системы при ее функционировании, проверке и обеспечении ее работоспособности. Перечень наименований разрабатываемых документов и их комплектность на систему и ее части должен быть определен в техническом задании на создание автоматизированной системы (подсистемы). Ниже приведена таблица, в которой приведены виды и номенклатура эксплуатационных документов в соответствии с КСАС.
|
Вид документа |
Код вида документа |
Часть проекта |
Дополнительные указания |
|
Чертеж формы документа (видеокадра) |
С9 |
ИО |
В документе должно быть приведено изображение формы документа или видеокадра в соответствии с требованиями государственных стандартов унифицированной системы документации, Р 50-77 и необходимые пояснения. На стадии ТП допускается включать в документы Описание постановки задач (комплекса задач) Описание информационного обеспечения системы |
|
Ведомость эксплуатационных документов |
ЭД |
ОР |
Документ содержит перечень эксплуатационных документов согласно ГОСТ 34.201. Ведомость заполняют по разделам — частям проекта АС |
|
Ведомость машинных носителей информации |
ВМ |
ИО |
Ведомость машинных носителей информации содержит обозначения, наименования документов, выполненных на машинных носителях. Запись документов осуществляется в порядке возрастания присвоенных обозначений |
|
Массив входных данных |
В6 |
ИО |
Документ содержит перечень входных данных с указанием их наименований, кодовых обозначений и значности реквизитов, а также наименований и кодовых обозначений документов или сообщений, содержащих эти данные |
|
Каталог базы данных |
В7 |
ИО |
Каталог базы данных содержит перечень объектов предметной области АС, информация о которых включена в базу данных |
|
Состав выходных данных (сообщений) |
В8 |
ИО |
Документ содержит перечень выходных данных с указанием их наименований, кодовых обозначений и значности реквизитов, а также наименований и кодовых обозначений документов или сообщений, содержащих эти данные |
|
Методика (технология) автоматизированного проектирования |
И1 |
ОО |
Документ описывает выбранные математические методы, используемые при проектировании, указывают состав и назначение проектных процедур, порядок взаимодействия проектных процедур в процессе выполнения |
|
Технологическая инструкция |
И2 |
ОО |
Документ «Технологическая инструкция» разрабатывают на операцию или комплекс операций технологического процесса обработки данных. В документе указывают наименование технологической операции (операций), на которую разработан документ, и приводят сведения о порядке и правилах выполнения операций (операции) технологического процесса обработки данных. В инструкции приводят перечень должностей персонала, на которые распространяется данная инструкция. Номенклатуру технологических инструкций определяют, исходя из принятого процесса обработки данных. Структуру документа устанавливает разработчик в зависимости от содержания |
|
Руководство пользователя |
И3 |
ОО |
Документ содержит полное описание системы, указания пользователю по подготовке к работе, освоению, эксплуатации системы, действиях при возникновении проблем в работе системы. |
|
Инструкция по формированию и ведению базы данных (набора данных) |
И4 |
ИО |
Документ описывает правила подготовки данных, порядок и средства заполнения, процедуры изменения, порядок и средства восстановления базы данных |
|
Инструкция по эксплуатации КТС |
ИЭ |
ТО |
Документ содержит указания о порядок работы, проверке правильности функционирования, меры безопасности, действиях в разных режимах при работе с комплексом технических средств системы |
|
Описание технологического процесса обработки данных (включая телеобработку) |
ПГ |
ОО |
Документ описывает технологический процесс сбора и обработки данных на периферийных устройствах при децентрализованной обработки данных и технологический процесс обработки данных на вычислительном центре |
|
Общее описание системы |
ПД |
ОР |
Документ содержит сведения о системе, ее архитектуре, принципах функционирования и необходимых ресурсах |
|
Формуляр |
ФО |
ОР |
Определения – по ГОСТ 2.601 |
|
Паспорт |
ПС |
ОР |
Требования к содержанию документов приведены в РД 50-34.698-90 (Методические указания. Информационная технология. Комплекс стандартов и руководящих документов на автоматизированные системы. Автоматизированные системы требования к содержанию документов).
Содержание документов является общим для всех видов АС и, при необходимости, может дополняться разработчиком документов в зависимости от особенностей создаваемой АС. Допускается включать в документы дополнительные разделы и сведения, объединять и исключать разделы.
Общие требования к изложению текста документов – по ГОСТ 2.105-95 ЕСКД. Общие требования к текстовым документам.
3. ЕСПД
Сведения для обеспечения функционирования и эксплуатации программ (компонентов, комплексов) приводятся в эксплуатационной программной документации. Комплектность эксплуатационной документации на программные средства определяется по ГОСТ 19.101-77 (Единая система программной документации (ЕСПД). Виды программ и программных документов). Состав комплекта ЭД на программу зависит от её архитектуры, назначения и особенностей целевой аудитории. Необходимость составления того или иного документа определяется на этапе разработки и утверждения технического задания на программу. Ниже приведена таблица, в которой приведён перечень ЭД на программы.
|
Вид эксплуатационного документа |
Код вида документа |
Дополнительные указания |
|
Ведомость эксплуатационных документов |
20 |
В документе приводят перечень эксплуатационных документов на программу. Выполняется в соответствии с требованиями |
|
Формуляр |
30 |
В документе указывают основные характеристики программы, комплектность и общие сведения об эксплуатации программы. Выполняется в соответствии с требованиями |
|
Описание применения |
31 |
В документе приводят сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств, входных и выходных данных. Выполняется в соответствии с требованиями ГОСТ 19.502-78 |
|
Руководство системного программиста |
32 |
В документе приводят сведения для установки, проверки, обеспечения функционирования, интеграции в систему и настройки программы в определённых условиях применения ее, устранения аварийных ситуаций. Требования к содержанию и оформлению – по ГОСТ 19.503-79 |
|
Руководство программиста |
33 |
В документе приводят сведения по эксплуатации (сопровождению) программы. Выполняется по ГОСТ 19.504-79 |
|
Руководство оператора |
34 |
Документ содержит сведения о порядке действий оператора при использовании программы. Требования к содержанию и оформлению – по ГОСТ 19.505-79 |
|
Описание языка |
35 |
Документ содержит описание синтаксиса и семантики языка, элементов и конструкций, встроенных функций. Выполняется по ГОСТ 19.506-79 |
|
Руководство по техническому обслуживанию |
46 |
В документе приводят сведения для применения тестовых и диагностических программ при обслуживании технических средств. |
Правила оформления программных документов для печатного способа выполнения установлены ГОСТ 19.106-78 (ЕСПД. Требования к программным документам, выполненным печатным способом).
В стандартах ЕСПД отсутствуют методические указания о том, как разработать документацию, они дают только перечень типов документов со списком разделов первого уровня для каждого и указания о том, какие сведения должны быть в нем изложены. Среди стандартов ИСО/МЭК есть ряд документов, касающихся процессов документирования при разработках в сфере информационных технологий. В отличие от ЕСПД, они содержат минимум требований к составу и структуре документов, при этом в них дано множество указаний, направленных на получение документов высокого качества. Возможно, комплексное применение указанных нормативных документов при разработке эксплуатационной документации на программы позволит повысить качество, информативность и полезность таких документов.
Ниже приведена таблица, в которую включены стандарты ИСО/МЭК, касающиеся процессов разработки программной и системной документации.
| Обозначение | Наименование |
| ГОСТ Р ИСО/МЭК 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 | Системы обработки информации.Документация пользователя и информация на упаковке для потребительских программных пакетов. |
