Меню

Гост для оформления инструкций по настройке



Техническая документация

разработка техдокументации — аванпроекты, НИР, ОКР — СРПП (ВТ), ЕСКД, ЕСПД, КСАС

Инструкция

Инструкция (instruction) по ГОСТ Р 7.0.60-2020

Официальное издание, содержащее правила по регулированию производственной и общественной деятельности или пользованию изделиями и (или) услугами [из 3.2.10.5.1 ГОСТ Р 7.0.60-2020]

Инструкция по монтажу, пуску, регулированию и обкатке изделия (ИМ) по ГОСТ 2.601-95

В ИМ включают сведения, необходимые для правильной подготовки к монтажу, проведению монтажных работ, пуска, регулирования и обкатки (при необходимости) изделий.

В случае, если подготовку к монтажу, монтаж, пуск, регулирование и обкатку изделия на месте его применения осуществляет персонал, который в дальнейшем будет его эксплуатировать, то все необходимые для этого сведения помещают в РЭ [из п. 5.2.1 ГОСТ 2.601-95]

ИМ содержит следующие разделы, которым предшествует введение без заголовка:

[из п. 5.2.2 ГОСТ 2.601-95]

  • назначение, область применения и состав ИМ;
  • переченьдокументов, которыми надлежит дополнительно руководствоваться при проведении работ, а также сведения о порядке использования ранее выпущенных аналогичных инструкций;
  • принятые в ИМ обозначениясоставных частей изделия и др.

[из п. 5.2.3 ГОСТ 2.601-95]

Инструкция (И) [из п. 3 табл. 1 ГОСТ 34.201-89]

Изложение состава действий и правил их выполнения персоналом [из п. 3 табл. 1 ГОСТ 34.201-89]

Инструкция по летной эксплуатации бортового оборудования [из подр. 7.2 ГОСТ 18675-2012]

ИЛЭО является документом, содержащим описание, информацию о технических характеристиках и правила летной эксплуатации ПИ пилотажно-навигационного, радиосвязного и другого бортового оборудования, устанавливаемого на ВС. ИЛЭО составляется разработчиком ПИ и используется разработчиком ВС при подготовке ЛР (РЛЭ) на ВС [из п. 7.2.1 ГОСТ 18675-2012]

ИЛЭО следует формировать из следующих разделов:

  • «Лист регистрации изменений»;
  • «Введение» («Общие сведения»);
  • «Описание устройства и принципа действия»;
  • «Технические характеристики (данные)»;
  • «Органы управления и индикации»;
  • «Описание выдаваемой информации (индикации на дисплее)»;
  • «Инструкции по действиям пилота (при нормальной эксплуатации для всех режимов работы и при отказах)»;
  • «Приложения».

[из п. 7.2.2 ГОСТ 18675-2012]

Лист регистрации изменений

Раздел «Лист регистрации изменений» выполняют по форме, приведенной на рисунке 5 [из п. 7.2.3 ГОСТ 18675-2012]

Введение (Общие сведения)

Раздел «Введение» («Общие сведения») — согласно 7.1.9.1 (без подраздела «Лист регистрации изменений») [из п. 7.2.4 ГОСТ 18675-2012]

Описание устройства и принципа действия

В раздел «Описание устройства и принципа действия» помещают сведения аналогично 7.3.10.4 в кратком изложении [из п. 7.2.5 ГОСТ 18675-2012]

Технические характеристики

В раздел «Технические характеристики» помещают сведения аналогично 7.3.10.2, необходимые для летной эксплуатации [из п. 7.2.6 ГОСТ 18675-2012]

Органы управления и индикации

В раздел «Органы управления и индикации» помещают иллюстрации и описание (пояснение) всех органов управления и индикации [из п. 7.2.7 ГОСТ 18675-2012]

Описание выдаваемой информации

В раздел «Описание выдаваемой информации» помещают сведения о назначении и использовании информации, выдаваемой индикаторами и дисплеями, по каждому режиму работы, а также соответствующие иллюстрации [из п. 7.2.8 ГОСТ 18675-2012]

Инструкции по действиям пилота

В раздел «Инструкции по действиям пилота» помещают сведения, состоящие из двух подразделов: «Нормальная эксплуатация» и «Действия при отказах». В подразделе «Нормальная эксплуатация» помещают все необходимые инструкции по включению, проверке и использованию (применению) в полете на всех режимах работы с необходимыми иллюстрациями. В подразделе «Действия при отказах» помещают сведения по действиям в случае возникновения отказов в полете с перечнями признаков отказа, выдаваемых сообщений и иллюстрациями соответствующих режимов индикации [из п. 7.2.9 ГОСТ 18675-2012]

Читайте также:  Настройка времени на кассе атол

Приложения

В раздел «Приложения» помещают дополнительную и справочную информацию по усмотрению разработчика ПИ [из п. 7.2.10 ГОСТ 18675-2012]

Источник

Правила оформления руководства по эксплуатации в Москве

Руководство по эксплуатации (РЭ) описывает характеристики, конструкцию и правила использования объекта, для которого оно составлено.

Без этого сопроводительного документа не обходится бытовая техника, различные приборы, оборудование, машины и многие другие товары народного потребления и промышленного назначения.

Второе название РЭ – инструкция по эксплуатации.

Цель разработки руководства

Группы лиц, которым может понадобиться инструкция – это не только обычные потребители, но и специалисты, осуществляющие ремонт и техническое обслуживание, сотрудники предприятий.

Главная цель документа – описать, как правильно использовать объект, чтобы он выполнял свои прямые функции, а также обеспечить при этом безопасность пользователя. Также в инструкции дается информация об оценке технического состояния и осуществлении ремонта изделия.

РЭ относится к категории конструкторской документации, наряду с паспортом на изделие, сборочной схемой и габаритными чертежами. Все перечисленное может понадобиться:

  • Когда изготавливается новое изделие (для передачи заказчику);
  • При сертификации продукции (передается в сертификационный центр);
  • При импорте и таможенных досмотрах.

Требования к руководству по эксплуатации

Нормативно-технические акты, устанавливающие требования к РЭ:

  • ГОСТ 2.601-2013 – описывает виды эксплуатационных документов, требования к ним и комплектность;
  • ГОСТ 2.610-2006 – устанавливает правила составления различных эксплуатационных документов, в том числе РЭ.

Согласно этим нормативам, руководство должно содержать информацию о конструкции, описание работы, свойствах изделия, указания для его безопасного использования. Описание эксплуатации не должно ограничиваться только использованием по прямому назначению. Необходимо, чтобы оно включало также и правила транспортировки, хранения, обслуживания и ремонта, проведения оценки технического состояния, информацию о правильной утилизации.

Дополнительные требования к РЭ описывает ТР ТС 010/2011, действующий с 2013 года. В частности, они касаются характеристик безопасности машин и оборудования. Так, ТР ТС устанавливает необходимость доводить до потребителя информацию о потенциальной опасности при недопустимой эксплуатации. В инструкции должны прописываться ограничения условий применения и те меры безопасности, которые необходимо предпринимать, используя оборудование.

ГОСТ на оформление РЭ

Согласно требованиям стандартов – двух профильных ГОСТов, РЭ должно быть составлено по установленному образцу с учетом всех изложенных в них рекомендаций, носящих обязательный характер.

Стандартом 2.601-2013 разрешается составление руководства в электронной форме, что подразумевает возможность размещения и на сайте производителя. Дополнительно в отношении электронного РЭ будут действовать требования ГОСТ 2.051-2013, где отражена информация о правилах составления электронной конструкторской документации.

Руководство должно сопровождаться подробными техническими схемами. А из-за схожести инструкции по эксплуатации с паспортом на изделие, нормативами разрешается их объединение. В таком случае документ будет иметь название «Паспорт и руководство по эксплуатации».

Структура и содержание документа

Согласно ГОСТ 2.610-2006, устанавливающего требования к содержанию РЭ, оно должно состоять из введения и следующих разделов:

  • 1 часть – описывает оборудование и его функции;
  • 2 – содержит сведения об использовании по назначению;
  • 3 – обозначает, как должно проводиться техническое обслуживание;
  • 4 – отражает сведения о проведении текущего ремонта;
  • 5 – оговаривает правила хранения;
  • 6 – описывает информацию о правильной транспортировке;
  • 7 – содержит данные об утилизации.

В этом же ГОСТе (номер 2.610-2006) можно увидеть примеры оформления титульного листа, образец внесения данных в разные части РЭ в табличной форме.

Как разработать документ?

Для разработки инструкции следует обращаться к специалистам.

Читайте также:  Qinq настройка на cisco

Эксперты нашего центра помогут сориентироваться во всех требованиях стандартов. Мы оказываем услуги по разработке РЭ и правильно составим его в короткие сроки.

Какие сведения потребуются?

Для разработки РЭ специалистам нужно будет предоставить ряд документов, таких как:

  • Заявление;
  • Описание продукции;
  • Отсканированные копии учредительной документации;
  • Реквизиты заявителя.

Для уточнения информации о составлении РЭ для вашей продукции обращайтесь к специалистам нашего центра удобным для вас способом. Мы оперативно ответим на все возникшие вопросы.

Источник

Удобная памятка и 8 ссылок на документацию по ГОСТ 34 (автоматизированные системы)

Одним пятничным вечером несколько лет назад я получил задание от руководителя подготовить за выходные ТЗ на конкурс. Видимо, я слишком уж излучал радость от предстоящих выходных, и боссу просто было приятно занять их чем-то новым и интересным, как он считал – ведь до этого с техническими документами мне работать не доводилось. Сейчас уже не смогу припомнить, какая там была система, но точно какой-то мониторинг. Субботнее утро принесло разочарование. Миллионы ссылок, сотни статей одна другой информативнее. От одной аббревиатуры ГОСТ веяло скукой и пылью. Примерно так и началось мое знакомство с семейством ГОСТ 34 на автоматизированные системы. Под катом удобная памятка по этому самому ГОСТу, которая совершенно случайно когда-то повстречалась на просторах сети и помогла систематизировать данные в знатном ворохе документов.

Так выглядит памятка и вот ссылка для скачивания, распечатки и вывешивания на почетное место.

Для вашего удобства собрал ссылки на приведенные документы. В принципе этого будет достаточно, чтобы удовлетворить запросы самого требовательного заказчика. Некоторым из этих стандартов скоро исполнится 30 лет, и частично они могут не отвечать современным запросам. Но по полноте охвата (а о некоторых вещах вы могли и не подумать) им нет равных в ИТ. Если вы только начинаете свой карьерный путь, рекомендую хотя бы раз взглянуть на эти документы, чтобы потом уже не ломать голову над последовательностью создания и составом этих документов. А уж эта брошюра просто must have на стене у вашего рабочего места.

Расскажите, насколько часто вам приходится иметь дело с ГОСТами этой серии и насколько удается применять эти рекомендации в процессе составления документации. А ниже — небольшой опрос. Заранее большое спасибо за обратную связь!

Автор статьи: Антон Касимов, архитектор систем управления, компания «Инфосистемы Джет».

Только зарегистрированные пользователи могут участвовать в опросе. Войдите, пожалуйста.

В каких случаях вы оформляете проектную документацию на автоматизированную систему в соответствии с ГОСТ?

Похожие публикации

Месяц удалёнки. Подводим итоги и делимся лайфхаками от руководителей рабочих групп «Инфосистемы Джет»

Аллокация затрат на ИТ – есть ли справедливость?

«Инфосистемы Джет», Росреестр, НЛМК и «Утконос» запускают AI-хакатон

Вакансии компании Инфосистемы Джет

Комментарии 23

>Старый разработчик ушёл, пришёл новый, ему дали папку с доками, он всё прочитал и врубился в продукт.
Категорически не согласен. Если бы разработка реальных продуктов шла по гостам никто бы вообще ни во что не врубался. Гост это сугубо формальный подход т.е. когда пишут не то что нужно, а то что требует Гост.

За примерами ходить далеко не надо — откройте любой большой проект на github который развивается 5-7 лет и посмотрите как там разработка устроена и документирование.

Смысл Гостов в чем? Все проекты с которыми я работал великолепно документированы прямо в коде и по этому коду сгенерирована документация с развернутыми примерами. Это позволяет сделать поменяв к примеру функцию или ее параметры получить в один клик новую актуальную версию документации.

Читайте также:  Настройки управления на джойстике пес

Т.е. все решение у разработчика как на ладони. Он видит какие функции, методы и переменные есть в коде. Может автоматом перейти на нужные участки кода и тд. Тут же предлагается какой-то суррогат делать за актуальностью которого нужно отдельно следить.

Я просто сам с гостами много работал и для себя понял их абсолютную бестолковость. В них даже терминологию нельзя адекватную использовать и приходится слова которые запутают любого адекватного разработчика использовать.

Вопрос к тем, кому приходилось писать такую проектную документацию. Какое ПО вы использовали?

Word, на мой взгляд, не очень хорошо работает с объемными колонтитулами (а рамка обычно в них).
А так, сам пишу в Word’е.
Знаю, что некоторые люди используют (La)TeX для этого. Там есть специальные библиотеки для ЕСКД.
В Компас’е есть опция «Текстовый документ», но в той версии с которой я работал функционал был крайне скуден.

Я оформляю документацию на автоматизированную систему с использованием markup’а в простых случаях. Если документация сложная и требует интеграции с кодом, то я использую Sphinx.

Если речь идёт про API, то swagger — отличное средство для самодокументирования приложения.

Последняя линяя «документной защиты» — это debian/changelog и git log.

А зачем мне ГОСТ? Какая от него польза заказчику? Исполнителю?

Сходу поразило: «Одним пятничным вечером… получил задание от руководителя подготовить за выходные ТЗ«. Да пусть меня побьют работодатели, но с годами (к сожалению, поздно) понял, что это, за редким исключением:
а) профнепригодность руководителя (а это мы видим уже итог — неуважение к сотруднику);
б) неуважение сотрудника к самому себе (что перерастает в профнепригодность сотрудника).
Не, ну если садо встретилось с мазо — флаг в руки.

По сути. То или иное применение ГОСТов зависит от цели документации.
Если это обязаловка, то тут задача ПМ и техписа очень-очень грамотно подойти к формулированию структуры будущей документации до заключения договора/ТЗ и далее жёстко контролировать соответствие требований всех заинтересованных сторон к документации согласно вот тем самым сформулированным договорённостям, которые эти заинтересованные стороны подписали. Иначе полноценная, нормальная работа выльется в кошмар для всех сторон.
Если «для дома, для семьи», то в голове должна быть элементарная цель — документация должна быть такой, чтобы спец вашего уровня (а желательно, ступенькой ниже) понял её, точнее, описываемую систему. Тут ГОСТы должны служит опорой. Причина проста — в них аккумулирована общепринятая логика, которая с вероятностью 99.(9)% будет лучше вашей наколеночной.
Конечно, есть проблемы, тут в комментах уже обозначили. ГОСТ — это не 100% догма. Надо понять суть (логику) стандартов, в т.ч. их рамки. Это, да, требует времени и работу мысли :), а ещё и памяти (если плотно не применять, у меня быстро улетучивается, поэтому всегда работаю с постоянным обращениям к стандартам). Далее, надо сопоставить цель документации со стандартами, выработать оптимальную структуру и согласовать (см. выше). Всё, готово, можно наполнять содержанием и контролировать (через ПМ, инженеров etc) как идёт проект.

Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

Источник

Adblock
detector