Техническое описание и инструкция по эксплуатации должны содержать, как правило, следующие данные и разделы:
- титульный лист;
- содержание;
- перечень вложенной документации, рисунков, чертежей, схем и т. п.;
- фотографию или чертеж внешнего вида системы;
- вводную часть;
- назначение;
- состав комплекта ИИС;
- технические данные;
- принцип действия;
- принцип программирования;
- указания по вводу в эксплуатацию;
- меры безопасности;
- порядок работы;
- поверку ИИС;
- конструкцию;
- техническое обслуживание;
- указания по устранению неисправностей;
- правила хранения;
- транспортирование;
- приложения.
В зависимости от особенностей системы отдельные разделы допускается объединять или исключать, а также вводить новые [из 2 Техническое описание и инструкция по эксплуатации ГОСТ 27300—87]
2.1 На титульном листе указывают:
- наименование системы;
- обозначение системы;
- заводские номера системы и приборов, входящих в систему, к которым относятся данное описание и инструкция по эксплуатации (при необходимости);
- наиболее важные сведения о применении системы и пределах измерения (при необходимости).
[из 2.1 ГОСТ 27300—87]
2.2 В вводной части описывают назначение документа; состав, если документ оформлен в виде нескольких книг или альбомов; перечень документов, которыми следует дополнительно руководствоваться при изучении системы; принятые обозначения составных частей системы [из 2.2 ГОСТ 27300—87]
2.3 В разделе «Назначение» приводят полное наименование и обозначение системы, ее назначение для решения определенной измерительной задачи с использованием возможностей программирования [из 2.3 ГОСТ 27300—87]
2.4 В разделе «Состав комплекта ИИС» перечисляют входящие в ИИС ФЕ(П) составные части, комплекты принадлежностей и запасных частей, сменные блоки, документацию, поставляемую с ФЕ(П).
При наличии нескольких модификаций (вариантов поставок, конфигураций ИИС) указывают особенности их комплектации.
Если ФЕ(П), сменные блоки, составные части, вспомогательные устройства могут быть заказаны отдельно, то об этом дают соответствующую информацию [из 2.4 ГОСТ 27300—87]
2.5 В разделе «Технические данные» приводят параметры системы, диапазон и погрешности измерения, последовательность и скорость измерения, способ записи результатов, данные по напряжению сети питания, потребляемой мощности, стойкости к помехам, класс защиты, массу, размеры [из 2.5 ГОСТ 27300—87]
2.6 В разделе «Принцип действия» приводят тип интерфейса, принцип действия ИИС в целом, описывают взаимодействие ФЕ(П), вычислительных и других вспомогательных устройств на основании схем (структурной, функциональной, соединений и др.) для получения результатов измерения, их преобразования и обработки [из 2.6 ГОСТ 27300—87]
2.7 В разделе «Принцип программирования» приводят данные, касающиеся программного обеспечения работы системы, общую характеристику, структуру и функциональные взаимодействия составных частей системы, ответственных за программное обеспечение, порядок операций обработки и записи результатов.
Этот раздел предусматривают, если для данной ИИС не выпускают отдельный документ по программированию [из 2.7 ГОСТ 27300—87]
2.8 В разделе «Указания по вводу в эксплуатацию» приводят:
- порядок установки;
- подготовку к работе;
- проверку работы;
- программирование;
- загрузку программы;
- подключение измеряемого объекта;
- запуск;
- проверку работы и отладку программы;
- опытную эксплуатацию (при необходимости);
- сдачу в эксплуатацию.
[из 2.8 ГОСТ 27300—87]
2.8.1 В разделе «Порядок установки» приводят:
- порядок доставки ИИС к месту эксплуатации;
- выбор и подготовку места для установки ИИС;
- указания по распаковыванию ИИС и отдельных ее частей;
- указания по удалению упаковочного материала и правила расконсервации ИИС;
- указания о размещении ИИС (с приведением необходимых чертежей);
- указания по сборке и монтажу ИИС в технологической последовательности проведения работ (при необходимости);
- описание электрических соединений;
- указания по обеспечению вентиляции при работе с ИИС и доступ к устройствам, подводящим питание;
- информацию о последствиях, которые могут быть вызваны неправильным соединением, неквалифицированным обслуживанием и т. п. с целью предотвращения повреждения отдельных приборов или всей системы;
- иллюстрацию внешнего вида системы, подготовленной к эксплуатации;
- описание элементов управления, касающихся всей системы.
Примечание — Если элементы управления и соединительные элементы размещены с задней или другой стороны системы, то приводят вид сзади или сбоку;
- методику проверки правильности монтажа (при необходимости).
[из 2.8.1 ГОСТ 27300—87]
2.8.2 В разделе «Подготовка к работе» указывают меры предосторожности, которые должны быть соблюдены при подготовке ИИС к работе, указывают необходимые наладочные работы и виды частичных испытаний до включения ИИС.
Дают указания о включении отдельных составных частей системы и описание реакции каждой из ФЕ(П).
Приводят методы настройки и регулирования ИИС на заданный режим работы [из 2.8.2 ГОСТ 27300—87]
2.8.6 В разделе «Подключение измеряемого объекта» приводят сведения об измерительных зажимах, особенно если измеряемый объект подключается к нескольким зажимам или если это касается автоматизированного (полуавтоматизированного) подключения [из 2.8.6 ГОСТ 27300—87]
2.8.7 В разделе «Запуск» приводят описание ручных и (или) автоматизированных операций, с которых начинают процесс измерения.
Приводят способы прекращения процесса измерения, обеспечивающие сохранение результатов измерения [из 2.8.7 ГОСТ 27300—87]
2.8.8 В разделе «Проверка работы и отладка программы» приводят способы проверки работы и достоверности результатов, а также принципы отладки программы [из 2.8.8 ГОСТ 27300—87]
2.8.9 В разделе «Опытная эксплуатация» приводят продолжительность обкатки, правила окончательного регулирования и настройки всех составных частей; правила по обнаружению на практике возможных недостатков.
Кроме того, приводят порядок и сроки наблюдения за работой ИИС.
Опытную эксплуатацию проводят в присутствии специалистов, программировавших систему [из 2.8.9 ГОСТ 27300—87]
2.8.10 В разделе «Сдача в эксплуатацию» приводят порядок сдачи ИИС в эксплуатацию, при необходимости, указания о фиксации и опломбировании ИИС после окончания всех работ, а также порядок оформления приемосдаточной документации [из 2.8.10 ГОСТ 27300—87]
2.9 В разделе «Меры безопасности» приводят правила, которые необходимо соблюдать во избежание поражения электрическим током.
Должны быть описаны имеющиеся источники опасности и предупредительные знаки.
Приводят назначение, принцип действия защитных устройств и правила пользования ими [из 2.9 ГОСТ 27300—87]
2.12 В разделе «Конструкция» приводят описание конструкции системы и ее составных частей, необходимое при эксплуатации, уходе и ремонте. При необходимости помещают иллюстрации [из 2.12 ГОСТ 27300—87]
2.13 В разделе «Техническое обслуживание» излагают перечень выполняемых потребителем работ по уходу за системой для обеспечения ее постоянной исправности и готовности к использованию.
Раздел составляют, если не предусматривают отдельной инструкции по техническому обслуживанию [из 2.13 ГОСТ 27300—87]
2.14 В разделе «Указания по устранению неисправностей» приводят указания по ремонту ИИС, который может быть проведен потребителем, содержащие следующие данные:
- меры безопасности до, во время и после окончания проведения ремонта;
- руководство по отысканию неисправностей;
- указания по доступу к составным частям;
- правила настройки ИИС после устранения неисправностей.
[из 2.14 ГОСТ 27300—87]
2.15 В разделе «Правила хранения» приводят указания по хранению, условия содержания при определенных сроках хранения [из 2.15 ГОСТ 27300—87]
2.16 В разделе «Транспортирование» излагают порядок подготовки ИИС к транспортированию и условия, при которых его следует осуществлять, порядок погрузки и выгрузки системы и меры предосторожности [из 2.16 ГОСТ 27300—87]
2.17 В приложениях к техническому описанию и инструкции по эксплуатации помещают следующий иллюстративный материал:
- схемы электрические структурные, соединения между ФЕ(П);
- указания по механическому соединению ФЕ(П), составных частей и блоков (при необходимости);
- таблицы напряжений и форм сигналов в точках присоединения, в случае возможности и необходимости;
- другие дополнительные материалы, необходимые при проведении работ при эксплуатации системы.
[из 2.17 ГОСТ 27300—87]
