О руководстве пользователя ПО АПК
- Войдите на сайт для отправки комментариев
Обычно разработка технической документации на программное обеспечение аппаратно-программного комплекса (АПК) выполняется в соответствии с требованиями Единой системы программной документации (ЕСПД, ГОСТ 19.). При этом в документе под названием «Руководство оператора», разрабатываемом согласно ГОСТ 19.505-79, должна быть, в частности, указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение работы ПО, приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программ, а также ответы программ на эти команды. Должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программ, описание их содержания и соответствующие действия оператора в случае сбоя, повторного запуска программы и т.п. Содержание руководства оператора при этом никак не увязывается с содержанием руководства по эксплуатации комплекса, составной частью которого является данное ПО, что, по-видимому, не является правильным. В чем дело, и где же выход?
Дело в том, что Единая система программной документации создавалась в конце 70-х годов прошлого столетия, когда в эксплуатации находились большие вычислительные машины (типа БЭСМ, ЕС и аналогичные), использовавшиеся, в основном, для выполнения расчетных задач и моделирования. На этих машинах работали специально обученные операторы. В их задачи входило обеспечение проведения вычислительного процесса в соответствии с рабочими программами (которые разрабатывали программисты), подготовка технических носителей информации на устройствах подготовки данных и их контроль, запись, считывание и перезапись информации с одного вида носителей на другой, наблюдение за работой ЭВМ и ее обслуживание. Пользователем ЭВМ в те годы считался специалист, ставящий задачу программистам и получающий результаты вычислений от операторов. В связи с отмеченным обстоятельством ЕСПД была (и, к сожалению, остается) ориентированной на создание документации для программистов и операторов ЭВМ.
По мере развития вычислительной техники и создания персональных компьютеров с графическим интерфейсом пользователя изменилось содержание понятий «оператор» и «пользователь». Пользователем стал считаться специалист, непосредственно работающий на ПК, т.е. как бы в прошлом понятии — оператор. В комплексе же стандартов ЕСПД данное смещение понятий отражения не нашло. Поэтому стало возникать определенное несоответствие между содержанием документа «Руководство оператора» и ожидаемым от этого документа описания порядка действия пользователя ПК.
Для устранения данного несоответствия в начале 80-х г.г. была начата разработка комплекса ГОСТ 24. Единая система стандартов автоматизированных систем управления, а в конце 80-х г.г. — ГОСТ 34. Информационная технология. Комплекс стандартов на автоматизированные системы. В ГОСТ 34.201-89 Информационная технология. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначения документов при создании автоматизированных систем для АС был впервые определен новый документ — руководство пользователя. Данный документ применительно к автоматизированной системе в некоторой степени является аналогом руководства по эксплуатации аппаратного изделия, т.е. содержит сведения, необходимые для правильной работы АС и его ПО: состав и содержание дистрибутивного носителя данных; порядок загрузки данных и программ; описание всех выполняемых функций, задач, процедур и т.п.
Вместе с тем, по определению, приведенному в ГОСТ 34.003-90 Информационная технология. Комплекс стандартов на автоматизированные системы. Термины и определения автоматизированной системой называют систему, состоящую из персонала и комплекса средств автоматизации его деятельности, реализующую информационную технологию выполнения установленных функций. И хотя любая автоматизированная система предполагает наличие в своем составе аппаратных средств, в общем случае аппаратно-программный комплекс под определение автоматизированной системы не подходит.
На основании изложенного представляется целесообразным не разрабатывать для ПО АПК ни руководство оператора, ни руководство пользователя, а порядок работы с ПО излагать в руководстве по эксплуатации комплекса, используя рекомендации по построению руководства пользователя АС.
Вы ДЕЙСТВИТЕЛЬНО и полностью согласны С ТЕМ, что написали??? Там так много спорного...
Я не волшебник 
. Конечно, это не догма, а модель (с моей точки зрения). Написал для того, чтобы обсудить, т.к. не всё так очевидно. Основываюсь на личном опыте разработки АПК спецназначения. С АС не работал. Но в наших АПК делать отдельное РП нет смысла, всё прекрасно умещается в РЭ.
Не получилось отредактировать
Вадим.
Вы ДЕЙСТВИТЕЛЬНО и полностью согласны С ТЕМ, что написали??? 
Там так много спорного...
К примеру, из тех же предпосылок можно сделать вывод, что понятие АС включает в себя понятие АПК (если не брать Ваш пункт 2 в "отличиях" как безусловный). И тогда ГОСТ серии 34 - можно применять смело.
К примеру, конечных пользователей продукта (неважно, АС или АПК) может быть много, и один из них - оператор (пользователь) ПО.
Ну и т.д. Может, я что-то упустила, не очень сильно вникла. И через полгода самой будет стыдно за то, что сейчас пишу. Не знаю. Мне кажется, нет.
Если это - просто модель, максимально (с Вашей или еще чьей-то т.з.) приближенная к реальности, то, как любят писать - "+1"!
Но я бы НЕ ПОТОМУ включила главы руководства оператора в руководство по эксплуатации, а просто от безысходности... Вроде, как я только что написало - применять можно СМЕЛО. А ведь... КАТАСТРОФИЧЕСКИ НЕ ХВАТАЕТ.
Но, в общем, мне нравится, что на нынешнем месте работы я не техпис, а "ведущий разработчик технической документации". Как-то... приличнее...
Безусловно, гораздо более приличнее 
Да это просто ужасно!
Когда-нибудь и мы все, простые смертные, дорастем до такого кривляния. Но, в общем, мне нравится, что на нынешнем месте работы я не техпис, а "ведущий разработчик технической документации". Как-то... приличнее...
Техпис - неприлично, технический писатель - ПРИКОЛЬНО, но непонятно, но прикольно. А вот "разработчик" - самое то.
Отвечу словами небезызвестной raccon:
технический писатель — это так страшно
Да это просто ужасно! Когда отдельные личности пытаются назвать меня техписом - у меня непроизвольно начинает кривиться морда - личности осекаются на полуслове
Не увидела, что из него (или из чего-то еще) следует, что аппаратно-программный комплекс под определение автоматизированной системы не подходит. И еще - что должно включаться во что? АПК в АС или АС в АПК?
Автоматизированная система (АС) — по ГОСТ 34.003-90:
система, состоящая из персонала и комплекса средств автоматизации его деятельности, реализующая информационную технологию выполнения установленных функций.
Система — из толковых словарей:
совокупность сборочных единиц, комплектов, деталей, программ, находящихся в отношениях и связях друг с другом, имеющая самостоятельное функциональное назначение.
Комплекс — по ГОСТ 2.101-68:
два и более специфицированных изделия (имеющих составные части), не соединенных на предприятии-изготовителе сборочными операциями, но предназначенных для выполнения взаимосвязанных эксплуатационных функций и составляющих в функциональном отношении единое целое.
Аппаратно-программный комплекс (АПК) — по смыслу:
система, состоящая из двух составных частей — аппаратуры и программно-математического обеспечения, управляющего работой этой аппаратуры.
Отличия:
1) В состав АС входит персонал, АПК может быть полностью автоматизированным.
2) В АС программное обеспечение реализует информационную технологию выполнения установленных функций, в АПК управляет работой аппаратной части.
название документа "Руководство пользователя" уже ну очень сильно вошло в жизнь
Если речь идет об АС — святое дело, для АПК, разрабатываемого по ЕСКД, такого документа не существует.
вряд ли конечному пользователю ПО требуется знать, из чего состоит весь комплекс и как его эксплуатировать
Конечный пользователь АПК — специалист, эксплуатирующий комплекс, а не его ПО.
ГОСТы 34-ой серии это попытка свести воедино 2 и 19. Но "затея не удалась. За попытку спасибо"
Абсолютно верно. Попытка не «не удалась», а преждевременно скончалась из-за развала экономики в 90-х г.г. и капитализации всея России на рубеже веков.
Я очень завидую, Вам, товарищи монстры, что Вы понимаете, где достаточно 34-ой серии, а где нужна и 2, и 50, и 19, да еще как это все клеить
Отвечу словами небезызвестной raccon:
технический писатель — это так страшно ...
И хотя любая автоматизированная система предполагает наличие в своем составе аппаратных средств, в общем случае аппаратно-программный комплекс под определение автоматизированной системы не подходит.
К тому чтобы в РЭ включить РП (или РО), наверное, приходят многие. Хотя бы для того, чтобы не плодить сущности без надобности ))
НО.
1. Перечитала три раза сообщение Вадима. Не увидела, что из него (или из чего-то еще) следует, что аппаратно-программный комплекс под определение автоматизированной системы не подходит. И еще - что должно включаться во что? АПК в АС или АС в АПК?
2. При этом не стоит забывать, что название документа "Руководство пользователя" уже ну очень сильно вошло в жизнь.
3. При этом о пользователях документации, а также об экономии бумаги... вряд ли конечному пользователю ПО требуется знать, из чего состоит весь комплекс и как его эксплуатировать.
4. У меня сложилось впечатление (бейте меня за это, издевайтесь, давайте...), что ГОСТы 34-ой серии это попытка свести воедино 2 и 19. Но "затея не удалась. За попытку спасибо".
Я очень завидую, Вам, товарищи монстры, что Вы понимаете, где достаточно 34-ой серии, а где нужна и 2, и 50, и 19, да еще как это все клеить.
На основании изложенного представляется целесообразным не разрабатывать для ПО АПК ни руководство оператора, ни руководство пользователя, а порядок работы с ПО излагать в руководстве по эксплуатации комплекса, используя рекомендации по построению руководства пользователя АС.
+1
Полностью согласен!
Собсно у себя мы так и делаем - на изделие у нас идет РЭ, разбитое на части. В нескольких частях описывается порядок работы с ПО.
- Войдите на сайт для отправки комментариев
Честно говоря, особых противоречий и причин для спора я не вижу. Унифицированный комплект сложновато таки составить. Комплектность документации определяется для каждого конкретного изделия (АС или АПК): если разработанного по собственной инициативе - своя рука владыка:) и делай как считаешь нужным; если по ТЗ заказчика - тут и не поспоришь особо)))