Кто обязан писать руководство по эксплуатации на систему?
Обсуждение вопросов, не относящихся ни к одному из других подразделов
12 сообщений • Страница 1 из 1
Автор темы
Кто обязан писать руководство по эксплуатации на систему?
Сообщение stas kruglov » 15 ноя 2012, 11:01
Очень заинтересовала эта тема на соседнем форуме , но на АВОК похоже переругались.
Что предписывает российский ГОСТ ?
VIS:
Ну вот ситуация:
Один человек спроектировал шкаф автоматики. Исходя из задуманного алгоритма поставил контроллер, автоматы, релюшки и всю остальную трехомудию. Выдал документацию со схемами и чертежами. НЕ выдал РЭ.
Второй (назову его «Изготовитель») — по бумагам первого изготовил шкаф. Напихал в него всю трехомудию соединил проводками, покрасил в красивый малиновый цвет с серебряными прожилками. Не выдал РЭ (да и не мог, не правда ли? )
Третий на объекте прикрутил шкаф к стенке, по бумагам первого протянул провода, поставил периферию, подключил, дал питание — все засветилось заморгало. НЕ выдал РЭ (а мог ли, хотя бы теоретически? )
Должностная инструкция // Для чего нужна должностная инструкция и как составить этот документ
Внимание вопрос — так кто из этих троих должен разработать для заказчика Руководство по эксплуатации сего замечательного, красивого шкафа?
Мое мнение — таки проектировщик, ибо кроме него НИКТО не знает как это должно работать. Где я ошибаюсь?
stas kruglov
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение Serex » 15 ноя 2012, 12:09
Все зависит от того, что вложить в термин РЭ.
Может быть проектировщик считает, что только электрических схем достаточно для понимания работы установки.
Кстати, в компании Renault (Автофрамос) обычно вся документация как раз и ограничивается электрическими схемами. По- крайней мере в распоряжение эксплуатации только такая документация попадает.
Serex
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение Ryzhij » 15 ноя 2012, 13:01
—————————————————
«У человека в душе дыра размером с Бога, и каждый заполняет её как может.» (Жан-Поль Сартр)
«Ту пустоту, которая остаётся в душе, когда в ней нет Бога, и весь мир не может заполнить.» (святитель Николай Сербский)
Ryzhij
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение Jackson » 15 ноя 2012, 14:29
Serex писал(а): Все зависит от того, что вложить в термин РЭ.
Не зависит. РЭ пишет разработчик. Ни сборщик ни наладчик на месте РЭ не пишут — они по этому РЭ уже должны работать.
По вопросам работы Форума можно обратиться по этим контактам.
Jackson
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение Ryzhij » 15 ноя 2012, 16:25
TEB писал(а): Не зависит. РЭ пишет разработчик.
Вполне себе нормальная ситуация, когда раздел «Руководство оператора» пишется конторой, которая программировала АРМ, а остальные — проектантом всей системы.
ПОДРОБНЕЙШАЯ ИНСТРУКЦИЯ ПО ПРОГРАММЕ
Прикол в том, что у нас пошла мода разбивать финансирование по этапам проектирования и на каждый этап объявлять тендер.
Вот уж где концов потом не найти!
—————————————————
«У человека в душе дыра размером с Бога, и каждый заполняет её как может.» (Жан-Поль Сартр)
«Ту пустоту, которая остаётся в душе, когда в ней нет Бога, и весь мир не может заполнить.» (святитель Николай Сербский)
Ryzhij
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение Jackson » 15 ноя 2012, 16:37
Я и говорю — разработчик. Если всё делают разные конторы, то каждая на свое изделие пишет РЭ.
Но никак не Изготовитель и никак не Монтажник/Наладчик это делает.
По вопросам работы Форума можно обратиться по этим контактам.
Jackson
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение DelSnos » 15 ноя 2012, 16:37
А в договоре разве нет перечня передаваемой документации?
DelSnos
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение Ryzhij » 15 ноя 2012, 21:10
DelSnos писал(а): А в договоре разве нет перечня передаваемой документации?
В договоре много чего есть.
Реально потребовать соблюдения всех пунктов договора можно лишь тогда, когда в руководстве заказчика нет афилированных генподрядчику лиц.
В противном случае неизбежно возникает ситуация:
«Составьте перечень недостатков и претензий!
Составили?
Молодцы. А теперь идите и думайте, как вы будете это устранять. Сроку вам — до вчерашнего утра. «
—————————————————
«У человека в душе дыра размером с Бога, и каждый заполняет её как может.» (Жан-Поль Сартр)
«Ту пустоту, которая остаётся в душе, когда в ней нет Бога, и весь мир не может заполнить.» (святитель Николай Сербский)
Ryzhij
Автор темы
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение stas kruglov » 16 ноя 2012, 09:09
Михайло писал(а): Единая система конструкторской документации.
ЭКСПЛУАТАЦИОННЫЕ ДОКУМЕНТЫ. Межгосударственный стандарт.
stas kruglov
Re: Кто обязан писать руководство по эксплуатации на систему
Сообщение atamkosta » 16 ноя 2012, 10:36
Ryzhij писал(а):
DelSnos писал(а):
Реально потребовать соблюдения всех пунктов договора можно лишь тогда, когда в руководстве заказчика нет афилированных генподрядчику лиц.
В противном случае неизбежно возникает ситуация:
«Составьте перечень недостатков и претензий!
Составили?
Молодцы. А теперь идите и думайте, как вы будете это устранять. Сроку вам — до вчерашнего утра. «
Так бывает очень часто когда заказчик и подрядчик родом из СНГовии.
Если речь идет за АБОК (первоначально вопрос пришел оттуда), где для управления вентиляторами и регистрами действительно все просто и шкаф рождает проектант, а изготовитель радостно его набирает, а монтажник прибивает к стенке (что фактически постоянно вижу у холодильщиков/вентиляционщиков) то разуемеется проектант и выдает весь комплект эксплуатационки, правда эту доку разве что обнять и плакать можно.
Но если вести речь о оборудовании более сложном или более, скажем так, эксклюзивном, что имет место быть в промышленности то зачастую проектант рисует общие мысли — конструкторы теоретики создают нечто, которое после наладки на объекте не похоже совсем на первичное решение (зачастую это нормализованные входа-выхода к физике с защитами и прочим, а все что не имеет видимого ответа стыдливо прячется под личину контроллера, мол там программер на наладке как то это оживит), в таком случае РЭ и КД выдает организация наладчик, разумеется после длительных препираний с разработчиком, по поводу распила. Или не выдает если сторговаться с разработчиком не удалось.
Очень популярный вариант на просторах, где властвует бог откатус — РЭ попадает в список разногласий и штрафных, и после качелей на высшем уровне, генподрядчик немного уступает, и сдача проходит в верхах, а последний акт разногласий который был аргументом в последнем бою, в котором и были строки о РЭ, стыдливо прячется. Руководители, даже владельцы, в порыве денежого гешефта, забывают напрочь что завтра наступит утро и им как то это придется эксплуатировать. И сдаются вещи которые физически и жить то не могут — да как нибудь эксплуатация долижет, в этом деле хорошо преуспели итальянцы.
Источник: asutpforum.ru
Тестировщики которые пишут руководство пользователя
Всем добрый день! Я думаю во многих компаниях, а не только в моей, написанием руководства пользователя занимаются тестировщики, и это дело я ненавижу больше всего в своей работе, одно руководство я уже осилил еле-еле, с кучей правок от руководителя, сейчас же передо мной стоит задача написать руководство для интернет магазина, я и хотел бы попросить дорогих коллег о помощи, гуглится эта тема очень плохо это либо статьи состоящие сплошь из воды, либо какие то неоформленные руководства на самих сайтах, а мне нужно что бы всё было чин по чину. В общем если кто то сам пишет буду очень благодарен за примеры(особенно к интернет магазинам), ну и от здравого совета не откажусь.
#2 
baxatob
- ФИО: Юрий
- Город: Riga
Отправлено 13 апреля 2017 — 09:41
При чем тут тестировщики? Есть такая профессия — технический писатель, они и пишут. И обчно это штатная единица в отделе бизнес-анализа или еще где, но уж точно не в QA.
Здравый совет — отдать это на аутсорс, если не хотите нанимать отдельного спеца.
#3 astenix
Отправлено 13 апреля 2017 — 10:34
Нет, написанием руководства пользователя тестировщики занимаются только под давлением обстоятельств.
Для написания руководства пользователя надо понимать, что руководства читают не «от и до» и «перед тем, как за дело браться», а в момент ненависти и отчаяния «Мну ничего не трогало, а оно все поломалося!» или же «Какие дураки это все делали, всё неочевидно, я не понимаю, как тут сделать простейший. «
Соответственно, описание функциональности превращается из последовательного изложения шагов, которые надо выполнить, в описание проблем, которые можно решить, выполнив ту или иную внятную, однозначную, понятную инструкцию.
Посмотрите, как это реализовано в справке к Excel — описание той же функции SUMM.
Погрузитесь в мир юзабилити заодно, хотя бы через http://www.exmachina.ru/
Но если вы это дело ненавидите «больше всего в своей работе», то здравый смысл предлагает отказаться от этой задачи, не?
Software Testing Glossary — простыми словами о непростых словах.
#4 aksi
Отправлено 13 апреля 2017 — 13:44
ну как любое руководство (для интернет-магазинов не писала, но обучалок для пользователей написала бешеную сотню). Я бы начинала с самого крупного отчаяния и боли пользователей. Для интернет-магазина это доставка и оплата. Смотря какой магазин, конечно, но для шмоток, скажем, мне важно знать, могу я оплатить по факту получения и попытки впихнуть невпихуемое в оную шмотку, или нет.
Куда доставляют. Можно ли поменять время доставки, можно ли передумать насчет оплаты, как оформляется возврат, сколько дней идут назад на карту деньги, какие товары возврату не подлежат. Если магазин уже действующий, пригласите саппорта ударить по пивку, и он вам все расскажет. Я бы вообще искала не тех, кто писал такие руководства, а тех, кто в аналогичных магазинах в службе поддержки работает — они очень хорошо знают, где у пользователя бомбит и непонятно.
Когда самое сложное расписано, дальше проще, регистрация — не бином ньютона, жонглирование товарами — тоже, а если это так дико сложно, что нужно по буквам объяснять — то это магазин в юзабилити не смог, а не тестировщик в руководство.
Сугубо имхо, на техписа не претендую, но пользователи на мои гайды вроде не жаловались никогда.
#5 PopkovSergei
PopkovSergei
Отправлено 14 апреля 2017 — 11:13
«Когда самое сложное расписано, дальше проще, регистрация — не бином ньютона, жонглирование товарами — тоже, а если это так дико сложно, что нужно по буквам объяснять — то это магазин в юзабилити не смог, а не тестировщик в руководство.»
Нет спасибо конечно за советы, но я не жалуюсь на юзабилити, магазин мы делаем вполне себе приличный, отвечающий стандартам. Просто у меня мало опыта в этой технической графомании, и сложно организовать, в голове, в каком порядке все будет идти, как описывать действия с ответвлениями, этж не чек лист. И у нас принято писать не просто записку для пользователя типо FAQ, а приличный развёрнутый документ, оформленный как подобает, что бы и заказчику показать не стыдно было.
#6 aksi
Отправлено 14 апреля 2017 — 11:30
Так вам для галочки, а не чтобы пользователю удобно было? Ну так бы сразу и сказали. Я-то наивно думала, что оно для людей делается.
#7 PopkovSergei
PopkovSergei
Отправлено 14 апреля 2017 — 11:36
Так вам для галочки, а не чтобы пользователю удобно было? Ну так бы сразу и сказали. Я-то наивно думала, что оно для людей делается.
Да кто сейчас то читает руководства к интернет магазинам))
#8 Little_CJIOH
Little_CJIOH
Отправлено 14 апреля 2017 — 11:36
ГОСТ 34
ГОСТ 19
РД 50
#9 aksi
Отправлено 14 апреля 2017 — 14:27
Так вам для галочки, а не чтобы пользователю удобно было? Ну так бы сразу и сказали. Я-то наивно думала, что оно для людей делается.
Да кто сейчас то читает руководства к интернет магазинам))
Ну как высказались коллеги выше, читают, когда проблема возникает) а когда она возникает, хочется быстро найти решение, а не продираться через Войну и Мир)
Источник: software-testing.ru
Кто пишет инструкции к программам
Один из самых серьёзных внутрикорпоративных споров – кто же должен писать должностные инструкции? Отдел кадров? Юристы? Руководство компании?
Отвечаем: Должностная инструкция составляется непосредственным руководителем сотрудника или его заместителем, после чего согласовывается с юридическим отделом (если таковой имеется) или другими подразделениями компании. Неправильно привлекать для работы над составлением инструкции отдел кадров, как часто бывает на практике. Кадровики не могут знать специфики работы каждого сотрудника компании и вынуждены подходить к составлению инструкции формально, из-за чего этот инструмент управления не работает.
Для чего нужны должностные инструкции?
Основная функция должностной инструкции – подробное описание обязанностей, полномочий, а главное, сферы ответственности сотрудника организации, занимающего конкретную должность. Но помимо этого должностные инструкции помогают лучше организовать связи между сотрудниками, определить критерии оценки полноты и качества работы сотрудника, служат основой при трудовых спорах или при проверках контролирующими органами. К сожалению, зачастую работодатель не придает значения должностным инструкциям, из-за этого часто возникают разногласия между сотрудниками и руководством: сотрудники отказываются выполнять какую-либо работу, ссылаясь на то, что это не их обязанности. Поэтому мы рекомендуем разработать должностную инструкцию перед приемом нового сотрудника на работу, чтобы избежать неприятных ситуаций в дальнейшем.
Все мы помним известную сказку Дж. Р. Толкиена «Властелин Колец». Мы решили показать вам важность наличия у сотрудника должностной инструкции на примере хранителя кольца Фродо Беггинса. Эта должностная инструкция шуточная, образцы настоящих должностных инструкций, которые вы можете скачать и отредактировать, представлены внизу статьи.
Правила оформления должностных инструкций
Должностная инструкция печатается на фирменном бланке предприятия, который содержит информацию о наименовании и местонахождении компании. В правом верхнем углу обязательно поставить гриф утверждения. В тексте самой инструкции указываются общие положения (о чем настоящая инструкция, о какой должности идет речь, какие требования выдвигаются к сотруднику, кому подчиняется и т.д.), должностные обязанности, права и ответственность.
Подписывается инструкция руководителем структурного подразделения, для которого написана должностная инструкция. В обязательном порядке указывается его ФИО, должность, ставится его подпись и дата. Ниже располагаются визы лиц, согласовавших должностную инструкцию (также с указанием ФИО, должности, проставлением подписи и даты).
В самом конце должностную инструкцию подписывает сам сотрудник, занимающий эту должность (он пишет: с инструкцией ознакомлен. Должность, подпись, расшифровка подписи и дата ознакомления). Документ должен быть составлен в трех экземплярах, один экземпляр хранится у сотрудника, второй – у руководителя, третий – в отделе кадров.
Как и обещали, вот примеры должностных инструкций:
- Должностная инструкция Бухгалтера (скачать в word)
- Должностная инструкция Директора (скачать в word)
- Должностная инструкция Заведующего складом (скачать в word)
- Должностная инструкция Инженера по строительству (скачать в word)
- Должностная инструкция Маркетолога (скачать в word)
- Должностная инструкция Менеджера (скачать в word)
- Должностная инструкция Мастера участка (скачать в word)
- Должностная инструкция Начальника отдела кадров (скачать в word)
Источник: osnovap.ru