1. Обязательно представиться на русском языке кириллицей (заполнить поле "Имя").
  2. Фиктивные имена мы не приветствуем. Ивановых и Пупкиных здесь уже достаточно.
  3. Не писать свой вопрос в первую попавшуюся тему - вместо этого создать новую тему.
  4. За поиск, предложение и обсуждение пиратского ПО и средств взлома - бан без предупреждения.
  5. Рекламу и частные объявления "куплю/продам/есть халтура" мы не размещаем ни на каких условиях.
  6. Перед тем как что-то написать - читать здесь и здесь, а студентам - обязательно здесь.
  7. Не надо писать в ЛС администраторам свои технические вопросы. Администраторы форума отлично знают как работает форум, а не все-все контроллеры, о которых тут пишут.

Руководство пользователя

Модератор: Модераторы Документов

Ответить
Аватара пользователя

Автор темы
petr2off
эксперт
эксперт
Сообщения: 1602
Зарегистрирован: 06 янв 2016, 19:45
Имя: Петров В.Л.
Страна: Россия
город/регион: Красноярск
Благодарил (а): 69 раз
Поблагодарили: 185 раз

Руководство пользователя

Сообщение petr2off »

Добрый день коллеги. Тема тут возникла, документ нужен руководство пользователя. Собственно я 2 госта на эту тему знаю 50 и 19. Не могу сказать что они мне нравятся, но по крайней мере - есть структура документа и как то регламентировано содержание. Но заказчик выразил неудовольствие, но - общегнесеологическое, т.е. без ссылок на регламентирующий документ, который его бы удовлетворил. Начальник тот тоже тяготеет к общечеловеческим термином. По его мнению - "Оператор - это законченный дебил, а поэтому надо вот ,... что бы понятно было.
Вопрос. а какие еще есть варианты регламентирующих документов по руководству пользователя (оператора) ?
Аватара пользователя

Serex
эксперт
эксперт
Сообщения: 2085
Зарегистрирован: 15 авг 2011, 21:36
Имя: Пупков Сергей Викторович
Страна: Россия
город/регион: Москва
Благодарил (а): 101 раз
Поблагодарили: 132 раза

Руководство пользователя

Сообщение Serex »

Всегда писал руководства на ПО, как душа ляжет. И всегда всем нравилось. Бывало так, что "а вот это добавьте, чтобы было" - добавлял и сдавал в работу.
Да и фиг ли, если в России читают бумагу только тогда, когда что-то не получается :ges_up:

Михайло
почётный участник форума
почётный участник форума
Сообщения: 3559
Зарегистрирован: 10 ноя 2009, 04:58
Имя: Толмачев Михаил Алексеевич
город/регион: г. Чехов, МО
Благодарил (а): 6 раз
Поблагодарили: 253 раза

Руководство пользователя

Сообщение Михайло »

ГОСТ 2.610-2006 ЕСКД. Правила выполнения эксплуатационных документов
Раздел 5. Руководство по эксплуатации (РЭ)

Это очень грамотные требования к структуре документа, системный подход, а значит к любой системе, АСУ, например, можно применять.

Ryzhij
почётный участник форума
почётный участник форума
Сообщения: 5620
Зарегистрирован: 07 окт 2011, 09:12
Имя: Гаско Вячеслав Эриевич
Страна: Россия
город/регион: Рязань
Благодарил (а): 544 раза
Поблагодарили: 706 раз

Руководство пользователя

Сообщение Ryzhij »

Руководство по эксплуатации, Руководство пользователя и Руководство оператора - совершенно разные документы.
Одно по харду, другое по софту, третье по технологии.
---------------------------------------------------
«У человека в душе дыра размером с Бога, и каждый заполняет её как может.» (Жан-Поль Сартр)
"Ту пустоту, которая остаётся в душе, когда в ней нет Бога, и весь мир не может заполнить." (святитель Николай Сербский)
Аватара пользователя

Автор темы
petr2off
эксперт
эксперт
Сообщения: 1602
Зарегистрирован: 06 янв 2016, 19:45
Имя: Петров В.Л.
Страна: Россия
город/регион: Красноярск
Благодарил (а): 69 раз
Поблагодарили: 185 раз

Руководство пользователя

Сообщение petr2off »

"Документ, содержащий сведения о конструкции, принципе действия, характеристиках (свойствах) изделия, его составных частях и указания, необходимые для правильной и безопасной эксплуатации изделия (использования по назначению, технического обслуживания, текущего ремонта, хранения и транспортирования) и оценок его технического состояния при определении необходимости отправки его в ремонт, а также сведения по утилизации изделия и его составных частей" - это из 2 Госта, Мне кажется немного не то, что нужно оператору.

Михайло
почётный участник форума
почётный участник форума
Сообщения: 3559
Зарегистрирован: 10 ноя 2009, 04:58
Имя: Толмачев Михаил Алексеевич
город/регион: г. Чехов, МО
Благодарил (а): 6 раз
Поблагодарили: 253 раза

Руководство пользователя

Сообщение Михайло »

РЭ по ЕСКД пишется на изделия или на комплексы во всём жизненном цикле. АСУ - это частный случай комплекса. Адаптируйте универсальные требования под свои частные, под свой укороченный жизненный цикл (только использование по назначению).
Получится, что требуется сконцентрироваться на первых двух частях:
- описание и работа,
- использование по назначению.
У этих частей расписаны разделы и подразделы. Пиши не хочу.

Есть нюансы, которые характерны для АСУ - это так называемые видеокадры (экраны), всякие там базы данных - это всё виртуальное (софт), но они являются важными составными частями. Но начать надо с монитора и жёсткого диска - физической сущности видеокадров и баз данных! :crazy0to:
Аватара пользователя

Автор темы
petr2off
эксперт
эксперт
Сообщения: 1602
Зарегистрирован: 06 янв 2016, 19:45
Имя: Петров В.Л.
Страна: Россия
город/регион: Красноярск
Благодарил (а): 69 раз
Поблагодарили: 185 раз

Руководство пользователя

Сообщение petr2off »

Я сделал документ по ГОСТ 19.505-79. Руководство оператора. И основная претензия была - нафиг оператору знать про диски и базы данные всякие. Описание программы совсем не нужно знать оператору. Ему нужно видеть, что все в порядке, а если не в порядке - то должно быть сообщение куда бежать и кому звонить.
Аватара пользователя

Jackson
администратор
администратор
Сообщения: 17472
Зарегистрирован: 17 июн 2008, 16:01
Имя: Евгений свет Брониславович
Страна: Россия
город/регион: Санкт-Петербург
Благодарил (а): 749 раз
Поблагодарили: 1278 раз

Руководство пользователя

Сообщение Jackson »

petr2off писал(а): 27 июн 2018, 06:39 Я сделал документ по ГОСТ 19.505-79. Руководство оператора. И основная претензия была - нафиг оператору знать про диски и базы данные всякие. Описание программы совсем не нужно знать оператору. Ему нужно видеть, что все в порядке, а если не в порядке - то должно быть сообщение куда бежать и кому звонить.
Всё правильно. В первой же главе этого ГОСТа читаем:
Руководство оператора должно содержать разделы:
  • назначение
  • условия выполнения
  • выполнение
  • сообщения оператору
Где тут устройство аппаратной части, перечень неисправностей и способы их устранения? Претензия обоснована. Это ведь ЕСПД.

А автор к ЕСКД обращается, то есть у него железо, не софт. Как бы совсем разные вещи.
petr2off писал(а): 26 июн 2018, 11:35 Но заказчик выразил неудовольствие, но - общегнесеологическое, т.е. без ссылок на регламентирующий документ, который его бы удовлетворил. Начальник тот тоже тяготеет к общечеловеческим термином. По его мнению - "Оператор - это законченный дебил, а поэтому надо вот ,... что бы понятно было.
Тоже логично.
Ну, нам ведь не видно как там у Вас написано. А в общем, раздел "использование по назначению" должен содержать список операций, штатно выполняемых оператором/персоналом, и каждый пункт должен содержать пошаговую инструкцию типа "нажми сюда - узри это". Горячо любимое ранее советскими разработчиками описание принципов работы схемы сюда включать НЕ НАДО.
[+] пример того, что не надо упоминать в руководстве оператора
....при нажатии на кнопку SB, замыкающий контакт этой кнопки собирает цепь включение контактора К, который включается, после чего становится возможный включение устройства А в работу....
Если очень хочется это описать - опишите в другом отдельном разделе руководства по эксплуатации.

Не знаю деталей, но заказчик в одном абсолютно прав: руководство оператора должно быть написано так, чтобы его инструкции смог выполнить человек любого уровня интеллекта, оказавшийся рядом с этой установкой. Примерно как в кино стюардессы или случайные пассажиры сажают самолёты вручную по голосовым командам диспетчера с земли (причём диспетчер тоже не особо в курсе, как управлять таким самолётом).

Отправлено спустя 5 минут 52 секунды:
Руководство - это руководящий документ, а не обучающий и не описательный. Термины следует понимать буквально.
По вопросам работы Форума можно обратиться по этим контактам.

Михайло
почётный участник форума
почётный участник форума
Сообщения: 3559
Зарегистрирован: 10 ноя 2009, 04:58
Имя: Толмачев Михаил Алексеевич
город/регион: г. Чехов, МО
Благодарил (а): 6 раз
Поблагодарили: 253 раза

Руководство пользователя

Сообщение Михайло »

РЭ по ЕСКД может описать всё, что угодно, с чем взаимодействует человек.
1. Человек не взаимодействует с кнопками на экране, он взаимодействует с сенсорным экраном или клавиатурой-мышью. Да, может быть про железо тут и писать нечего, но начинаться должно с этого.
2. А как, извините, вы напишете, чтобы человек наблюдал за физическим процессом, который виден через окно диспетчерской, и адекватно нажимал кнопки? Как вы избежите таких фраз "срочно жми эту кнопку [на экране], если [изделие] выскочило из гидравлического захвата подающего робота"?

Руководство пользователя - это, мне кажется, что-то для системного администратора - "как накатить программу на операционную систему Linux", "как деинсталлировать программу" и т.д.

Пока не напишешь РЭ по ЕСКД, эксплуатанты долго ещё будут шарахаться от таких эпических произведений. Надо только грамотно очертить границы комплекса и определить его составные части (их требуется описать в РЭ по ЕСКД).
Аватара пользователя

Никита
почётный участник форума
почётный участник форума
Сообщения: 3899
Зарегистрирован: 20 янв 2010, 22:23
Имя: Никита
Страна: РФ
город/регион: Мурманск
Благодарил (а): 18 раз
Поблагодарили: 187 раз

Руководство пользователя

Сообщение Никита »

Михайло писал(а): 27 июн 2018, 20:57 Руководство пользователя - это, мне кажется, что-то для системного администратора - "как накатить программу на операционную систему Linux", "как деинсталлировать программу" и т.д.
Это другой документ - "руководство программиста". Пользователя - это для оператора - где что посмотреть и что нажать.
Опыт - это когда на смену вопросам: "Что? Где? Когда? Как? Почему?" приходит единственный вопрос: "Нахрена? "

Михайло
почётный участник форума
почётный участник форума
Сообщения: 3559
Зарегистрирован: 10 ноя 2009, 04:58
Имя: Толмачев Михаил Алексеевич
город/регион: г. Чехов, МО
Благодарил (а): 6 раз
Поблагодарили: 253 раза

Руководство пользователя

Сообщение Михайло »

Чтобы далеко не бегать, вот весь текст стандарта:
[+] ГОСТ 19.505-79 "ЕСПД. Руководство оператора. Требования к содержанию и оформлению"
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным.

1.2. Руководство оператора должно содержать следующие разделы:
- назначение программы;
- условия выполнения программы;
- выполнение программы;
- сообщения оператору.

В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.

(Измененная редакция, Изм. № 1).

2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе "Назначение программы" должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.

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

2.3. В разделе "Выполнение программы" должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.

2.2, 2.3. (Измененная редакция, Изм. № 1).

2.4. (Исключен, Изм. № 1).

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

2.6. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

(Измененная редакция, Изм. № 1).

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

(Введен дополнительно, Изм. № 1).
Руководство оператора по ГОСТ 19.505-79 именно так и надо понимать: оператор = системный администратор. В те годы оператор ПО и пользователь - это были разные люди. Сейчас, короче, если бы писать руководство оператора по ГОСТ 19, то надо написать минимальные и рекомендуемые системные требования к аппаратуре и т.п. Это явно не "где что посмотреть и что нажать".

Отправлено спустя 14 минут 55 секунд:
[+] РД 50-34.698-90 Автоматизированные системы. Требования к содержанию документов. Глава 3.4
3.4. Р у к о в о д с т в о п о л ь з о в а т е л я
3.4.1. Документ содержит разделы:
1) введение;
2) назначение и условия применения;
3) подготовка к работе;
4) описание операций;
5) аварийные ситуации;
6) рекомендации по освоению.
3.4.2. В разделе “Введение” указывают:
1) область применения;
2) краткое описание возможностей;
3) уровень подготовки пользователя;
4) перечень эксплуатационной документации, с которыми необходимо ознакомиться пользователю.
3.4.3. В разделе “Назначение и условия применения” указывают:
1) виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
2) условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация -технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).
3.4.4. В разделе “Подготовка к работе” указывают:
1) состав и содержание дистрибутивного носителя данных;
2) порядок загрузки данных и программ;
3) порядок проверки работоспособности.
3.4.5. В разделе “Описание операций” указывают:
1) описание всех выполняемых функций, задач, комплексов задач, процедур;
2) описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.
3.4.б. Для каждой операции обработки данных указывают:
1) наименование;
2) условия, при соблюдении которых возможно выполнение операции;
3) подготовительные действия;
4) основные действия в требуемой последовательности;
5) заключительные действия;
6) ресурсы, расходуемые на операцию.
В описании действий допускаются ссылки на файлы подсказок, размещенные на магнитных носителях.
3.4.7. В разделе “Аварийные ситуации” указывают:
1) действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств;
2) действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных;
3) действия в случаях обнаружения несанкционированного вмешательства в данные;
4) действия в других аварийных ситуациях.
3.4.8. В разделе “Рекомендации по освоению” указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

Ryzhij
почётный участник форума
почётный участник форума
Сообщения: 5620
Зарегистрирован: 07 окт 2011, 09:12
Имя: Гаско Вячеслав Эриевич
Страна: Россия
город/регион: Рязань
Благодарил (а): 544 раза
Поблагодарили: 706 раз

Руководство пользователя

Сообщение Ryzhij »

Основополагающие требования к содержанию РЭ изложены в ТР ТС "О безопасности машин и механизмов". Всё остальное - производное от этих требований.
---------------------------------------------------
«У человека в душе дыра размером с Бога, и каждый заполняет её как может.» (Жан-Поль Сартр)
"Ту пустоту, которая остаётся в душе, когда в ней нет Бога, и весь мир не может заполнить." (святитель Николай Сербский)
Аватара пользователя

Jackson
администратор
администратор
Сообщения: 17472
Зарегистрирован: 17 июн 2008, 16:01
Имя: Евгений свет Брониславович
Страна: Россия
город/регион: Санкт-Петербург
Благодарил (а): 749 раз
Поблагодарили: 1278 раз

Руководство пользователя

Сообщение Jackson »

Михайло писал(а): 27 июн 2018, 20:57 РЭ по ЕСКД может описать всё, что угодно, с чем взаимодействует человек.
1. Человек не взаимодействует с кнопками на экране, он взаимодействует с сенсорным экраном или клавиатурой-мышью. Да, может быть про железо тут и писать нечего, но начинаться должно с этого.
Ещё раз. Не путайте ЕСКД и ЕСПД.
Михайло писал(а): 27 июн 2018, 20:57 2. А как, извините, вы напишете, чтобы человек наблюдал за физическим процессом, который виден через окно диспетчерской, и адекватно нажимал кнопки?
Ну пишем же. И нажимают.
Михайло писал(а): 27 июн 2018, 20:57 Пока не напишешь РЭ по ЕСКД, эксплуатанты долго ещё будут шарахаться от таких эпических произведений. Надо только грамотно очертить границы комплекса и определить его составные части (их требуется описать в РЭ по ЕСКД).
Точно требуется? Чем регламентировано?
Ведь ничто не мешает писать РЭ на изделие в целом по ЕСКД, и руководство оператора к устройствам ЧМИ в их составе - отдельно по ЕСПД. Или мешает?
По вопросам работы Форума можно обратиться по этим контактам.

Михайло
почётный участник форума
почётный участник форума
Сообщения: 3559
Зарегистрирован: 10 ноя 2009, 04:58
Имя: Толмачев Михаил Алексеевич
город/регион: г. Чехов, МО
Благодарил (а): 6 раз
Поблагодарили: 253 раза

Руководство пользователя

Сообщение Михайло »

На мой взгляд, ЕСПД - это стандарты для успешной разработки ПО и последующей инсталляции/внедрения, эксплуатации не касается.
Аватара пользователя

Автор темы
petr2off
эксперт
эксперт
Сообщения: 1602
Зарегистрирован: 06 янв 2016, 19:45
Имя: Петров В.Л.
Страна: Россия
город/регион: Красноярск
Благодарил (а): 69 раз
Поблагодарили: 185 раз

Руководство пользователя

Сообщение petr2off »

Продолжение забавное получилось. У них структура иерархическое. Есть голова - в которой такие продвинутые мальчики сидят (Умники) и низ - там парни от сохи(Слесаря). Я не шучу, софтом на низу занимается слесарь 6-го разряда. С Слесарями у меня контакт хороший получился - у людей конкретные проблемы, в общем то понятные. А вот с Умниками плохо. Я предложил - дайте образец руководства - сделаем как Вам нравится. И тут обнаружилось, что у Слесарей - которые реально занимаются эксплуатацией (которые на кнопки жмут и чинят, если сломалось)- этого документа нет. Он типа есть у Умников, пообещали выпросить. Я тут сразу немного в осадок выпал.
И что то вспомнил - как Умники мне снисходительно они мне объясняли - что у них тут регламент, например пароль по генератор пароля, раз в месяц меняются. А Слесаря мне по простому сказали - у нас пароль - '12345678'. Я вот думаю, сколько лет нужно генератор пароля насиловать, что бы он такой пароль выдал.
Пока делаю 2-ю реинкарнацию документа по 50 госту, Слесаря попросили попроще его делать, и обсуждать его с ними, а с Умниками они потом его согласуют.
Аватара пользователя

Jackson
администратор
администратор
Сообщения: 17472
Зарегистрирован: 17 июн 2008, 16:01
Имя: Евгений свет Брониславович
Страна: Россия
город/регион: Санкт-Петербург
Благодарил (а): 749 раз
Поблагодарили: 1278 раз

Руководство пользователя

Сообщение Jackson »

Михайло писал(а): 28 июн 2018, 19:39 На мой взгляд, ЕСПД - это стандарты для успешной разработки ПО и последующей инсталляции/внедрения, эксплуатации не касается.
Почему? В ЕСПД есть такое документ как "руководство оператора" - как раз то что и требуется.

Отправлено спустя 5 минут 13 секунд:
petr2off писал(а): 28 июн 2018, 19:54 Пока делаю 2-ю реинкарнацию документа по 50 госту, Слесаря попросили попроще его делать, и обсуждать его с ними, а с Умниками они потом его согласуют.
Будьте проще.
Сделайте вторую версию и засылайте.
[+] как сдаются документы
Был случай как-то, отправили комплект документации на утверждение в одну очень интересную гос.контору. В ответ получили список замечаний, всё у нас не так и доки мы писать не умеем. Автор документов получил этот список и ушел в отпуск. После отпуска вернулся, не разбираясь взял тот же комплект документов и отправил повторно. Получаем телефонный звонок и нам говорят буквально так: "ну вот теперь всё в порядке, видно что поработали". С той стороны ведь люди тоже должны как-то показывать что они работают. вот они и работают, отклоняют, замечания пишут.
По вопросам работы Форума можно обратиться по этим контактам.
Аватара пользователя

Никита
почётный участник форума
почётный участник форума
Сообщения: 3899
Зарегистрирован: 20 янв 2010, 22:23
Имя: Никита
Страна: РФ
город/регион: Мурманск
Благодарил (а): 18 раз
Поблагодарили: 187 раз

Руководство пользователя

Сообщение Никита »

TEB писал(а): 29 июн 2018, 07:59 как сдаются документы
Тут как раз все просто. Надо было время потянуть. Было еще смешнее: в конце года (ноябрь) сдавали установку, ну вместе с ней и документацию. В ответ неоднократно получали кучу замечаний, вплоть до того, что запятые не там стоят (буквально). После третьей или четвертой попытки (люди-то все не первый день живут) просто спросили начальницу УКСа: "после 25 декабря, наверное уже не глядя подпишете?". Та в ответ только посмеялась (причем, похоже что ее более "зеленые" коллеги по кабинету так ничего и не поняли. И, естественно, в конце года деньги появились и все замечания были забыты.

Так что если замечания не по делу пишут, значит это кому-нибудь нужно.
Опыт - это когда на смену вопросам: "Что? Где? Когда? Как? Почему?" приходит единственный вопрос: "Нахрена? "

Михайло
почётный участник форума
почётный участник форума
Сообщения: 3559
Зарегистрирован: 10 ноя 2009, 04:58
Имя: Толмачев Михаил Алексеевич
город/регион: г. Чехов, МО
Благодарил (а): 6 раз
Поблагодарили: 253 раза

Руководство пользователя

Сообщение Михайло »

TEB писал(а): 29 июн 2018, 07:59 Почему? В ЕСПД есть такое документ как "руководство оператора" - как раз то что и требуется.
Так я выше дал полный текст стандарта, это совершенно не то, что должно быть:
2.3. В разделе "Выполнение программы" должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.

alex_ugrumov
почётный участник форума
почётный участник форума
Сообщения: 626
Зарегистрирован: 29 сен 2008, 17:05
Имя: Алексей Угрюмов
Страна: Россия
город/регион: СПб
Благодарил (а): 6 раз
Поблагодарили: 22 раза

Руководство пользователя

Сообщение alex_ugrumov »

Михайло писал(а): 30 июн 2018, 18:10
TEB писал(а): 29 июн 2018, 07:59 Почему? В ЕСПД есть такое документ как "руководство оператора" - как раз то что и требуется.
Так я выше дал полный текст стандарта, это совершенно не то, что должно быть:
2.3. В разделе "Выполнение программы" должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
И пишите
Загрузка и запуск программы осуществляется автоматически при подачи питания. Дополнительных действий от оператора не требуется.
Следующий раздел.
Мы основное содержание помещаем в третий раздел. Там о описание кадров, и базовые вещи (типа сенсорный экран, чтоб пальцами в него тыкать), и описание основных режимов, и порядок работы, и аварийные сообщения, куда бежать и тд.
К тому же
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
Руководство оператора - это то, чем пользуется оператора в каждодневной работе. Это вообще основной эксплуатационный документ.
К меня критерий полноты этого документа очень простой: на любой вопрос оператора можно дать ответ, указав страницу руководства, где содержится ответ на его вопрос. А качество реализации СУ в целом и руководства в частности д.б. таким, чтобы в случае аварии указать пункт руководства, который был нарушен.
Что касается технологии, то оператор или не имеет доступа к её настойке или, если имеет (в силу организационной структуры), то указываем, что "такие-то технологические параметры настраиваются в порядке определённым соответствующими регламентирующими документами".
Alex.

Михайло
почётный участник форума
почётный участник форума
Сообщения: 3559
Зарегистрирован: 10 ноя 2009, 04:58
Имя: Толмачев Михаил Алексеевич
город/регион: г. Чехов, МО
Благодарил (а): 6 раз
Поблагодарили: 253 раза

Руководство пользователя

Сообщение Михайло »

alex_ugrumov писал(а): 01 июл 2018, 12:42 Мы основное содержание помещаем в третий раздел.
Извините, но у нас по сути нет требований к содержанию третьего раздела. Между тем в ЕСКД есть чёткие требования и не ограничивается программным обеспечением и требует описывать такие вещи как "гидравлический захват робота", если это необходимо для эксплуатации, при этом требования к содержанию описания полные (исчерпывающие).
Аватара пользователя

Jackson
администратор
администратор
Сообщения: 17472
Зарегистрирован: 17 июн 2008, 16:01
Имя: Евгений свет Брониславович
Страна: Россия
город/регион: Санкт-Петербург
Благодарил (а): 749 раз
Поблагодарили: 1278 раз

Руководство пользователя

Сообщение Jackson »

Михайло писал(а): 30 июн 2018, 18:10 Так я выше дал полный текст стандарта, это совершенно не то, что должно быть
Почему это не то что должно быть?
По вопросам работы Форума можно обратиться по этим контактам.

Ryzhij
почётный участник форума
почётный участник форума
Сообщения: 5620
Зарегистрирован: 07 окт 2011, 09:12
Имя: Гаско Вячеслав Эриевич
Страна: Россия
город/регион: Рязань
Благодарил (а): 544 раза
Поблагодарили: 706 раз

Руководство пользователя

Сообщение Ryzhij »

Ryzhij писал(а): 28 июн 2018, 12:34 Основополагающие требования к содержанию РЭ изложены в ТР ТС "О безопасности машин и механизмов". Всё остальное - производное от этих требований.
Позволю себе процитировать документ, имеющий силу ФЗ:
[+] ТР ТС 010/2011"О безопасности машин и оборудования"
Статья 4. Обеспечение безопасности машин и (или) оборудования при разработке (проектировании)
*****
8. Разработка руководства (инструкции) по эксплуатации является
неотъемлемой частью разработки (проектирования) машины и (или) оборудования.
Руководство (инструкция) по эксплуатации включает:
- сведения о конструкции, принципе действия, характеристиках (свойствах) машин и/или оборудования;
- указания по монтажу или сборке, наладке или регулировке, техническому обслуживанию и ремонту машины и (или) оборудования;
- указания по использованию машины и (или) оборудования и меры по обеспечению безопасности, которые необходимо соблюдать при эксплуатации машины и (или) оборудования, включая ввод в эксплуатацию, применению по назначению, техническое обслуживание, все виды ремонта, периодическое диагностирование, испытания, транспортирование, упаковку, консервацию и условия хранения;
- назначенные показатели (назначенный срок хранения, назначенный срок службы и (или) назначенный ресурс) в зависимости от конструктивных особенностей. По истечении назначенных показателей (назначенного ресурса, срока хранения, срока службы) машина и (или) оборудование изымаются из эксплуатации, и принимается решение о направлении их в ремонт, об утилизации, о проверке и об установлении новых назначенных показателей (назначенного ресурса, срока
хранения, срока службы);
- перечень критических отказов, возможные ошибочные действия персонала, которые приводят к инциденту или аварии;
- действия персонала в случае инцидента, критического отказа или аварии;
- критерии предельных состояний;
- указания по выводу из эксплуатации и утилизации.
- сведения о квалификации обслуживающего персонала.
9. В случае если машина и (или) оборудование предназначены для
эксплуатации не профессиональными пользователями, руководство (инструкция)
по эксплуатации должно учитывать знания, умение и опыт таких пользователей.
****
Статья 5. Обеспечение безопасности машин и (или) оборудования при изготовлении, хранении, транспортировании, эксплуатации и утилизации
****
6. Изготовитель машины и (или) оборудования должен обеспечивать машины и (или) оборудование руководством (инструкцией) по эксплуатации.
7. Машина и (или) оборудование должны иметь четкие и нестираемые предупреждающие надписи или знаки о видах опасности.
8. Машина и (или) оборудование должны иметь хорошо различимую четкую и нестираемую идентификационную надпись, содержащую:
- наименование изготовителя и (или) его товарный знак;
- наименование и (или) обозначение машины и (или) оборудования (тип,
марка, модель (при наличии));
- месяц и год изготовления.
9. Если сведения, приведенные в пункте 8 настоящей статьи, невозможно нанести на машину и (или) оборудование, то они могут указываться только в прилагаемом к данной машине и (или) оборудованию руководстве (инструкции) по эксплуатации. При этом наименование изготовителя и (или) его товарный знак, наименование и обозначение машины и (или) оборудования (тип, марка, модель (при наличии)) должны быть нанесены на упаковку.
10. Сведения, указанные в пункте 8 настоящей статьи, должны содержаться в руководстве (инструкции) по эксплуатации. Кроме того, руководство (инструкция) по эксплуатации должно содержать наименование и местонахождение изготовителя (уполномоченного изготовителем лица), импортера, информацию для связи с ними.
11. Руководство (инструкция) по эксплуатации выполняется на русском языке и на государственном(ых) языке(ах) государства-члена Таможенного союза при наличии соответствующих требований в законодательстве(ах) государства(в)-члена(ов) Таможенного союза.
Руководство (инструкция) по эксплуатации выполняется на бумажных носителях. К нему может быть приложен комплект эксплуатационных документов на электронных носителях. Руководство (инструкция) по эксплуатации, входящее в комплект машины и (или) оборудования не бытового назначения, по выбору изготовителя может быть выполнено только на электронных носителях.
*****
18. В руководстве (инструкции) по эксплуатации должны быть установлены рекомендации по безопасной утилизации машины и (или) оборудования.
19. При проектировании машины и (или) оборудования в руководстве (инструкции) по эксплуатации должны быть определены меры для предотвращения использования не по назначению машины и (или) оборудования после достижения назначенного ресурса или назначенного срока службы.
Это к вопросу "ЧТО там должно быть?"
А на вопрос "В КАКОМ ВИДЕ это там должно быть?" отвечают стандарты семейств ЕСКД и ЕСПД, и другие, перечисленные в перечне к упомянутому ТР ТС.
---------------------------------------------------
«У человека в душе дыра размером с Бога, и каждый заполняет её как может.» (Жан-Поль Сартр)
"Ту пустоту, которая остаётся в душе, когда в ней нет Бога, и весь мир не может заполнить." (святитель Николай Сербский)

Михайло
почётный участник форума
почётный участник форума
Сообщения: 3559
Зарегистрирован: 10 ноя 2009, 04:58
Имя: Толмачев Михаил Алексеевич
город/регион: г. Чехов, МО
Благодарил (а): 6 раз
Поблагодарили: 253 раза

Руководство пользователя

Сообщение Михайло »

У семи нянек (ЕСКД, ЕСТД, ЕСПД) дитя было бы без глазу. Руководство по эксплуатации только у одной няньки - ЕСКД, смотрим ГОСТ 2.610.

Не надо выдумывать всякие заменяющие руководства операторов. С ума что ли сошли? Вы ещё будете спорить? А придут ещё из бизнес-консалтинга и скажут, что вместо всей вашей "непонятной технохренотени" надо писать руководство по управлению бизнесом согласно PMBoK/SEBoK/BABoK. Типа это тоже эксплуатационка.

Вы хоть раз писали РЭ по ГОСТ 2.610?

Ryzhij
почётный участник форума
почётный участник форума
Сообщения: 5620
Зарегистрирован: 07 окт 2011, 09:12
Имя: Гаско Вячеслав Эриевич
Страна: Россия
город/регион: Рязань
Благодарил (а): 544 раза
Поблагодарили: 706 раз

Руководство пользователя

Сообщение Ryzhij »

Да я ж не спорю!
Я просто напоминаю "откуда ноги растут" в современном российском законодательстве в области технического регулирования.
Базой являются ТР (технические регламенты).
Они имеют законную силу, являясь Федеральными Законами.
Остальное - подзаконные акты.
Выстройте для лучшего понимания иерархию нормативов, и не запутаетесь.
Ибо "в природе вообще" есть АСУ без "железа", и есть "хард" без "софта", а в АСУ-ТП такого практически не бывает.
Тут любая система одновременно и АСУ, и оборудование, и электроустановка, и, к тому же, чего-нибудь ещё... Классифицирующих признаков много может быть.
И весь этот клин нормативов сходится на ТР.
http://www.test-e.ru/ru/company/useful- ... on-manual/
Отправлено спустя 12 минут 7 секунд:
Михайло писал(а): 03 июл 2018, 05:17 Вы хоть раз писали РЭ по ГОСТ 2.610?
Есть по-над-ним ещё и ГОСТ 2.601-2013, а над обоими ГОСТ-ами уже упомянутый ТР ;)
---------------------------------------------------
«У человека в душе дыра размером с Бога, и каждый заполняет её как может.» (Жан-Поль Сартр)
"Ту пустоту, которая остаётся в душе, когда в ней нет Бога, и весь мир не может заполнить." (святитель Николай Сербский)
Аватара пользователя

Jackson
администратор
администратор
Сообщения: 17472
Зарегистрирован: 17 июн 2008, 16:01
Имя: Евгений свет Брониславович
Страна: Россия
город/регион: Санкт-Петербург
Благодарил (а): 749 раз
Поблагодарили: 1278 раз

Руководство пользователя

Сообщение Jackson »

Михайло писал(а): 03 июл 2018, 05:17 Не надо выдумывать всякие заменяющие руководства операторов. С ума что ли сошли?
Тут ещё никто ничего пока не выдумал.
Ибо сказано же правильно про ЕСКД и ЕСПД. ЕСКД требует наличия руководства по эксплуатации всего изделия в целом, в описанном объёме. Если имеем дело с ПО - это уже ЕСПД, там есть руководство пользователя. Никто же не мешает на шкаф с тачскрином выпустить только РЭ, которое нормально включает в себя требуемую информацию по ЕСПД. Также никто не мешает выпустить то же РЭ без описания программной части, и отдельно РО по ЕСПД. И так и эдак правильно, где как лучше - так и можно делать. Это сумасшествие? Ну значит я сумасшедший, потому что так и делаю. :crazy0to:
Михайло писал(а): 03 июл 2018, 05:17 Вы ещё будете спорить?
Да и не спорит никто, кажется, кроме Вас. :)
По вопросам работы Форума можно обратиться по этим контактам.
Ответить

Вернуться в «Нормативы, ГОСТы, стандарты»