Согласно стандартам ЕСКД, ЕСПД и КСАС каждой программе, системе, документу должно быть присвоено обозначение, которое состоит из группы цифр и букв, разделённых точками, пробелами, дефисами. Обозначение присваивается по правилам для унификации и упрощения идентификации изделий и документации на них, ведения учёта и архива.
Присвоить номер, код или шифр документу, со сторону кажется целой наукой, тайным знанием. Однако, это проще чем кажется! Можно ли не присваивать этот мистический номер созданному техническому документу по ГОСТу? Нет, он необходим, чтобы в документации был порядок. Иначе поиск, хранение и учёт документов будут проблематичны.
Для начала следует запомнить, что документ не имеет номера, кода или шифра, а имеет обозначение, если мы говорим про документы из серии ГОСТов 19 или 34.
Обозначения документов по 19 и 34 ГОСТам отличаются друг от друга.
По ГОСТу 34
В 34 ГОСТе обозначение документа присваивается по ГОСТу 34.201-89, но смотря туда, не каждый сразу способен разобраться откуда берётся какая цифра.
Номер согласно ГОСТу 34 выглядит следующим образом:
A.Б.ВВВ.ГГ.ДД.ЕЕ-Ж.М
Расшифровка обозначений:
А — код организации-разработчика системы, который присваивается по ОКПО (Общероссийский классификатор предприятий и организаций). Его можно узнать в бухгалтерии.
Б — код классификационной характеристики типа системы или её части, который присваивается по ОКП (Общероссийский классификатор продукции). Раздел классификатора по автоматизированным системам, идёт со строчки — 425000 Программно-технические комплексы для автоматизированных систем.
ВВВ — регистрационный номер автоматизированной системы или её части. Данный номер ведётся в журнале учёта на предприятии. Если журнал учёта не ведётся, то можно указать номер 001.
ГГ — код документа. Коды документов определены ГОСТом 34.201-89. Для каждого наименования документа свой номер. Например, Описание автоматизируемых функций – П3, Руководство пользователя – И3, Ведомость эскизного проекта – ЭП.
ДД — порядковый номер документа с одинаковым названием. Допустим, у вас 5 Пояснительных записок для разных компонентов программы, чтобы не запутаться в них им присваиваются номера 01, 02, 03, 04 и 05. Если документ один с таким названием, то значение пропускается.
ЕЕ — порядковый номер редакции документа. Документ может переписываться несколько раз, согласно пожеланиям заказчика. При официальной корректировке документа, по замечаниям заказчика, проставляется номер редакции. При первой передаче документа данное значение не проставляется, при второй передаче документа уже ставится значение 02.
Ж — порядковый номер части документа. Большие документы, для удобства сшивания, делятся на несколько частей. Если документ не разделён на части, то данное значение пропускается.
М — обозначение М, проставляется, если документ представлен не в печатном виде, а на диске или флешке. Если документ в печатном виде, то в данном значение пропускается.
ЛУ — обозначение ЛУ проставляется, только Листу утверждения.
Таким образом, можно получить следующее обозначение:
11119632.4251005.004.ПА.10.02-3 (Описание программного обеспечения для 10 комплекса Системы во 2-й редакции, часть 3);
11119632.4251005.005.ПА.10.02-М (Описание программного обеспечения для 10 комплекса Системы во 2-й редакции, на диске);
11119632.4251005.002.ПА (Описание программного обеспечения).
11119632.4251005.008.И2 (Технологическая инструкция).
11119632.4251005.195.ПС (Паспорт).
ПО ГОСТу 19
В 19 ГОСТе обозначение документа присваивается по ГОСТу 19.103-77.
Номер согласно ГОСТу 19 выглядит следующим образом:
A.Б.ВВВВВ-ГГ ДД ЕЕ-Ж
Расшифровка обозначений:
A — код страны, где разработан документ. Например, RU для России. Остальные обозначения указаны в стандарте ISO 3166-1.
Б — код организации-разработчика, который присваивается по ОКПО (Общероссийский классификатор предприятий и организаций). Его можно узнать в бухгалтерии.
ВВВВВ — регистрационный номер программы, который присваивается по ОКП (Общероссийский классификатор продукции). Допускается присваивать регистрационный номер в порядке возрастания, начиная с 00001 до 99999, для каждой организации (предприятия)-разработчика.
ГГ — порядковый номер редакции документа. Например, 01, 02,03.
ДД — код вида документа, который присваивается в соответствии с ГОСТ 19.101-77. Например, 34 – Руководство оператора, 12 – Текст программы, 33 – Руководство программиста.
ЕЕ — порядковый номер документа данного вида.
Ж — порядковый номер части документа.
Таким образом, можно получить следующее обозначение:
RU.11119632.20006–10 32 (Руководство системного программиста, 10 редакции);
RU.11119632.30706–10 32 02–03 (Руководство системного программиста, 10 редакции, 2-й документ данного вида, 3-я часть данного документа);
RU.11119632.10908–10 32 (Руководство системного программиста, 10 редакции);
RU.11119632.28051–01 32 (Руководство системного программиста, 1 редакции).
RU.11119632.44009–06 33 (Руководство программиста, 6 редакции).
RU.11119632.30101–02 81 (Пояснительная записка, 2 редакции).
Оформить руководство по эксплуатации необходимо, следуя требованиям национального стандарта ГОСТ 2.601-2019. В нём можно найти очень много информации об эксплуатационных документах в целом и руководстве по эксплуатации в частности.
Руководство по эксплуатации какого-либо оборудования должно содержать как общую, так и очень подробную информацию об этой машине. Оформляя руководство по эксплуатации, нужно описать:
- принципы функционирования оборудования;
- параметры и характеристики;
- комплектующие части (если есть);
- сведения по ремонту, плановому обслуживанию и утилизации.
Документ руководства по эксплуатации можно оформить как в бумажном, так и в электронном интерактивном виде для размещения на сайт и лучшего понимания функционирования аппарата.
Основные принципы оформления содержания руководства по эксплуатации
Для правильного понимания и выполнения требований руководства по эксплуатации, глаголы в тексте документа нужно использовать в повелительном наклонении: «взять», «сделать», «включить», «установить» и т.п.
Любые действия, которые нужно выполнить для достижения какого-либо результата, следует описывать в логическом порядке. Последовательность действий можно также приводить в виде таблицы.
Для сложных оборудования оформлять руководство по эксплуатации рекомендуется, разделяя текст на разделы и подразделы с соответствующей нумерацией.
Также очень важно при оформлении руководства по эксплуатации отдельно прописывать требования к безопасности, преднамеренно выделяя данные разделы или абзацы. Выделить меры безопасности можно предостерегающими словами «Внимание!», «Запрещается!» «Предупреждение!» и т.п.
Если оформляется руководство по эксплуатации на изделие, которое требует повышенной осторожности при использовании, то на титульном листе документа следует сделать соответствующую надпись: например, «ВНИМАНИЕ! ОСОБАЯ ОСТОРОЖНОСТЬ!».
Для лучшего понимания и восприятия действия и пояснений в руководстве по эксплуатации следует приводить схемы, рисунки, разные графические иллюстрации, чертежи, диаграммы, графики и т.п. В ГОСТе есть подробное описание, как и куда правильно вставлять данные изображения и иллюстрации.
Основные принципы технического оформления руководства по эксплуатации
В национальном стандарте ГОСТ Р 2.601-2019 в подразделе 8.2 можно найти подробные требования к техническому оформлению руководства по эксплуатации, если оно разрабатывается в бумажном виде.
Обычно при оформлении руководства по эксплуатации изготовитель сам решает, на каком носителе публиковать документ. Но могут быть ситуации, когда есть требования заказчика выполнить оформление руководства по эксплуатации, например, в анимационном виде на цифровом носителе. Поэтому рекомендуется консультироваться с заказчиком (если он есть) по поводу носителя руководства по эксплуатации. Особенно это касается государственных заказов.
При оформлении руководства по эксплуатации на бумажном носителе следует использовать листы А4 согласно ГОСТ 2.301. Страницу документа нужно поделить на следующие зоны:
- информационная зона с технической информацией;
- верхний колонтитул – 1-2 строчки;
- нижний колонтитул – 2-3 строчки.
Если заказчик не выдвинул требования по качеству бумаги, формату, переплёту и других технических особенностей, то их устанавливает изготовитель оборудования.
Если схем, графиков и иллюстраций слишком много, то стандарт предполагает их отдельное брошюрование в качестве приложения к руководству по эксплуатации.
При оформлении руководства по эксплуатации в электронном виде, разрешается передавать мультимедийную версию заказчику и пользователям на электронных носителях, с помощью удалённого доступа или через интернет. В зависимости от оговорённых условий, доступ к передаче электронного руководства по эксплуатации может бить единичным или многократным.
Руководство по эксплуатации (РЭ) описывает характеристики, конструкцию и правила использования объекта, для которого оно составлено.
Без этого сопроводительного документа не обходится бытовая техника, различные приборы, оборудование, машины и многие другие товары народного потребления и промышленного назначения.
Второе название РЭ – инструкция по эксплуатации.
Цель разработки руководства
Группы лиц, которым может понадобиться инструкция – это не только обычные потребители, но и специалисты, осуществляющие ремонт и техническое обслуживание, сотрудники предприятий.
Главная цель документа – описать, как правильно использовать объект, чтобы он выполнял свои прямые функции, а также обеспечить при этом безопасность пользователя. Также в инструкции дается информация об оценке технического состояния и осуществлении ремонта изделия.
РЭ относится к категории конструкторской документации, наряду с паспортом на изделие, сборочной схемой и габаритными чертежами. Все перечисленное может понадобиться:
- Когда изготавливается новое изделие (для передачи заказчику);
- При сертификации продукции (передается в сертификационный центр);
- При импорте и таможенных досмотрах.
Требования к руководству по эксплуатации
Нормативно-технические акты, устанавливающие требования к РЭ:
- ГОСТ 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) можно увидеть примеры оформления титульного листа, образец внесения данных в разные части РЭ в табличной форме.
Как разработать документ?
Для разработки инструкции следует обращаться к специалистам.
Эксперты нашего центра помогут сориентироваться во всех требованиях стандартов. Мы оказываем услуги по разработке РЭ и правильно составим его в короткие сроки.
Какие сведения потребуются?
Для разработки РЭ специалистам нужно будет предоставить ряд документов, таких как:
- Заявление;
- Описание продукции;
- Отсканированные копии учредительной документации;
- Реквизиты заявителя.
Для уточнения информации о составлении РЭ для вашей продукции обращайтесь к специалистам нашего центра удобным для вас способом. Мы оперативно ответим на все возникшие вопросы.
Согласно стандартам ЕСКД, ЕСПД и КСАС каждой программе, системе, документу должно быть присвоено обозначение, которое состоит из группы цифр и букв, разделённых точками, пробелами, дефисами. Обозначение присваивается по правилам для унификации и упрощения идентификации изделий и документации на них, ведения учёта и архива.
Присвоить номер, код или шифр документу, со сторону кажется целой наукой, тайным знанием. Однако, это проще чем кажется! Можно ли не присваивать этот мистический номер созданному техническому документу по ГОСТу? Нет, он необходим, чтобы в документации был порядок. Иначе поиск, хранение и учёт документов будут проблематичны.
Для начала следует запомнить, что документ не имеет номера, кода или шифра, а имеет обозначение, если мы говорим про документы из серии ГОСТов 19 или 34.
Обозначения документов по 19 и 34 ГОСТам отличаются друг от друга.
По ГОСТу 34
В 34 ГОСТе обозначение документа присваивается по ГОСТу 34.201-89, но смотря туда, не каждый сразу способен разобраться откуда берётся какая цифра.
Номер согласно ГОСТу 34 выглядит следующим образом:
A.Б.ВВВ.ГГ.ДД.ЕЕ-Ж.М
Расшифровка обозначений:
А — код организации-разработчика системы, который присваивается по ОКПО (Общероссийский классификатор предприятий и организаций). Его можно узнать в бухгалтерии.
Б — код классификационной характеристики типа системы или её части, который присваивается по ОКП (Общероссийский классификатор продукции). Раздел классификатора по автоматизированным системам, идёт со строчки — 425000 Программно-технические комплексы для автоматизированных систем.
ВВВ — регистрационный номер автоматизированной системы или её части. Данный номер ведётся в журнале учёта на предприятии. Если журнал учёта не ведётся, то можно указать номер 001.
ГГ — код документа. Коды документов определены ГОСТом 34.201-89. Для каждого наименования документа свой номер. Например, Описание автоматизируемых функций – П3, Руководство пользователя – И3, Ведомость эскизного проекта – ЭП.
ДД — порядковый номер документа с одинаковым названием. Допустим, у вас 5 Пояснительных записок для разных компонентов программы, чтобы не запутаться в них им присваиваются номера 01, 02, 03, 04 и 05. Если документ один с таким названием, то значение пропускается.
ЕЕ — порядковый номер редакции документа. Документ может переписываться несколько раз, согласно пожеланиям заказчика. При официальной корректировке документа, по замечаниям заказчика, проставляется номер редакции. При первой передаче документа данное значение не проставляется, при второй передаче документа уже ставится значение 02.
Ж — порядковый номер части документа. Большие документы, для удобства сшивания, делятся на несколько частей. Если документ не разделён на части, то данное значение пропускается.
М — обозначение М, проставляется, если документ представлен не в печатном виде, а на диске или флешке. Если документ в печатном виде, то в данном значение пропускается.
ЛУ — обозначение ЛУ проставляется, только Листу утверждения.
Таким образом, можно получить следующее обозначение:
11119632.4251005.004.ПА.10.02-3 (Описание программного обеспечения для 10 комплекса Системы во 2-й редакции, часть 3);
11119632.4251005.005.ПА.10.02-М (Описание программного обеспечения для 10 комплекса Системы во 2-й редакции, на диске);
11119632.4251005.002.ПА (Описание программного обеспечения).
11119632.4251005.008.И2 (Технологическая инструкция).
11119632.4251005.195.ПС (Паспорт).
ПО ГОСТу 19
В 19 ГОСТе обозначение документа присваивается по ГОСТу 19.103-77.
Номер согласно ГОСТу 19 выглядит следующим образом:
A.Б.ВВВВВ-ГГ ДД ЕЕ-Ж
Расшифровка обозначений:
A — код страны, где разработан документ. Например, RU для России. Остальные обозначения указаны в стандарте ISO 3166-1.
Б — код организации-разработчика, который присваивается по ОКПО (Общероссийский классификатор предприятий и организаций). Его можно узнать в бухгалтерии.
ВВВВВ — регистрационный номер программы, который присваивается по ОКП (Общероссийский классификатор продукции). Допускается присваивать регистрационный номер в порядке возрастания, начиная с 00001 до 99999, для каждой организации (предприятия)-разработчика.
ГГ — порядковый номер редакции документа. Например, 01, 02,03.
ДД — код вида документа, который присваивается в соответствии с ГОСТ 19.101-77. Например, 34 – Руководство оператора, 12 – Текст программы, 33 – Руководство программиста.
ЕЕ — порядковый номер документа данного вида.
Ж — порядковый номер части документа.
Таким образом, можно получить следующее обозначение:
RU.11119632.20006–10 32 (Руководство системного программиста, 10 редакции);
RU.11119632.30706–10 32 02–03 (Руководство системного программиста, 10 редакции, 2-й документ данного вида, 3-я часть данного документа);
RU.11119632.10908–10 32 (Руководство системного программиста, 10 редакции);
RU.11119632.28051–01 32 (Руководство системного программиста, 1 редакции).
RU.11119632.44009–06 33 (Руководство программиста, 6 редакции).
RU.11119632.30101–02 81 (Пояснительная записка, 2 редакции).
Оформить руководство по эксплуатации необходимо, следуя требованиям национального стандарта ГОСТ 2.601-2019. В нём можно найти очень много информации об эксплуатационных документах в целом и руководстве по эксплуатации в частности.
Руководство по эксплуатации какого-либо оборудования должно содержать как общую, так и очень подробную информацию об этой машине. Оформляя руководство по эксплуатации, нужно описать:
- принципы функционирования оборудования;
- параметры и характеристики;
- комплектующие части (если есть);
- сведения по ремонту, плановому обслуживанию и утилизации.
Документ руководства по эксплуатации можно оформить как в бумажном, так и в электронном интерактивном виде для размещения на сайт и лучшего понимания функционирования аппарата.
Основные принципы оформления содержания руководства по эксплуатации
Для правильного понимания и выполнения требований руководства по эксплуатации, глаголы в тексте документа нужно использовать в повелительном наклонении: «взять», «сделать», «включить», «установить» и т.п.
Любые действия, которые нужно выполнить для достижения какого-либо результата, следует описывать в логическом порядке. Последовательность действий можно также приводить в виде таблицы.
Для сложных оборудования оформлять руководство по эксплуатации рекомендуется, разделяя текст на разделы и подразделы с соответствующей нумерацией.
Также очень важно при оформлении руководства по эксплуатации отдельно прописывать требования к безопасности, преднамеренно выделяя данные разделы или абзацы. Выделить меры безопасности можно предостерегающими словами «Внимание!», «Запрещается!» «Предупреждение!» и т.п.
Если оформляется руководство по эксплуатации на изделие, которое требует повышенной осторожности при использовании, то на титульном листе документа следует сделать соответствующую надпись: например, «ВНИМАНИЕ! ОСОБАЯ ОСТОРОЖНОСТЬ!».
Для лучшего понимания и восприятия действия и пояснений в руководстве по эксплуатации следует приводить схемы, рисунки, разные графические иллюстрации, чертежи, диаграммы, графики и т.п. В ГОСТе есть подробное описание, как и куда правильно вставлять данные изображения и иллюстрации.
Основные принципы технического оформления руководства по эксплуатации
В национальном стандарте ГОСТ Р 2.601-2019 в подразделе 8.2 можно найти подробные требования к техническому оформлению руководства по эксплуатации, если оно разрабатывается в бумажном виде.
Обычно при оформлении руководства по эксплуатации изготовитель сам решает, на каком носителе публиковать документ. Но могут быть ситуации, когда есть требования заказчика выполнить оформление руководства по эксплуатации, например, в анимационном виде на цифровом носителе. Поэтому рекомендуется консультироваться с заказчиком (если он есть) по поводу носителя руководства по эксплуатации. Особенно это касается государственных заказов.
При оформлении руководства по эксплуатации на бумажном носителе следует использовать листы А4 согласно ГОСТ 2.301. Страницу документа нужно поделить на следующие зоны:
- информационная зона с технической информацией;
- верхний колонтитул – 1-2 строчки;
- нижний колонтитул – 2-3 строчки.
Если заказчик не выдвинул требования по качеству бумаги, формату, переплёту и других технических особенностей, то их устанавливает изготовитель оборудования.
Если схем, графиков и иллюстраций слишком много, то стандарт предполагает их отдельное брошюрование в качестве приложения к руководству по эксплуатации.
При оформлении руководства по эксплуатации в электронном виде, разрешается передавать мультимедийную версию заказчику и пользователям на электронных носителях, с помощью удалённого доступа или через интернет. В зависимости от оговорённых условий, доступ к передаче электронного руководства по эксплуатации может бить единичным или многократным.