ГОСТ 19.505-79
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
РУКОВОДСТВО ОПЕРАТОРА
Требования к содержанию и оформлению
Unified system for program documentation. Operation’s guide. Requirements for contents and form of presentation
МКС 35.080
Дата введения 1980-01-01
Постановлением Государственного комитета CCCР по стандартам от 12 января 1979 г. N 74 дата введения установлена 01.01.80
ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство оператора», определенного ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2096-80*.
(Измененная редакция, Изм. N 1).
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство оператора должно содержать следующие разделы:
назначение программы;
условия выполнения программы;
выполнение программы;
сообщения оператору.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
(Измененная редакция, Изм. N 1).
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.
2.2. В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).
2.3. В разделе «Выполнение программы» должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
2.2, 2.3. (Измененная редакция, Изм. N 1).
2.4. (Исключен, Изм. N 1).
2.5. В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).
2.6. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.
(Измененная редакция, Изм. N 1).
2.7. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.
(Введен дополнительно, Изм. N 1).
Составление
информационной части (аннотации и
содержания) является обязательным.
Руководство
оператора должно содержать следующие
разделы:
-
назначение
программы; -
условия
выполнения программы; -
выполнение
программы; -
сообщения
оператору.
В
зависимости от особенностей ПС в
документе допускается объединять
отдельные разделы или вводить новые.
В
разделе «Назначение программы» должны
быть указаны сведения о назначении
программы и информация, достаточная
для понимания функций программы и ее
эксплуатации.
В
разделе «Условия выполнения программы»
должны быть указаны условия, необходимые
для выполнения программы (минимальный
и/или максимальный состав аппаратных
и программных средств и т.п.).
В
разделе «Выполнение программы» должна
быть указана последовательность действий
оператора, обеспечивающая загрузку,
запуск, выполнение и завершение программы,
приведено описание функций, формата и
возможных вариантов команд, с помощью
которых оператор осуществляет загрузки
и управляет выполнением программы, а
также ответы программы на эти команды.
В
разделе «Сообщения оператору» должны
быть приведены тексты сообщений,
выдаваемых в ходе выполнения программы,
описание их содержания и соответствующие
действия оператора (действия оператора
в случае сбоя, возможности повторного
запуска программы и т.п.).
Допускается
содержание разделов иллюстрировать
поясняющими примерами, таблицами,
схемами, графиками.
В
приложении к руководству оператора
допускается включать различные материалы,
которые нецелесообразно включать в
разделы руководства.
6.19. Гост 19.508. Руководство по техническому обслуживанию. Требования к содержанию и оформлению
Настоящий
стандарт распространяется на тестовые
и диагностические программы, используемые
при обслуживании технических средств.
Составление
информационной части (аннотация и
содержание) является обязательным.
Руководство
по техническому обслуживанию должно
содержать следующие разделы:
-
введение;
-
общие
указания; -
требования
к техническим средствам; -
описание
функций;
В
зависимости от особенностей ПС в
документе допускается вводить
дополнительные разделы.
В
разделе «Введение» указывают назначение
руководства, перечень эксплуатационных
документов, которыми должны дополнительно
к руководству пользоваться при техническом
обслуживании.
В
разделе «Общие указания» указывают
порядок технического обслуживания,
приводят указание по организации и
особенностям его проведения.
В
разделе «Требования к техническим
средствам» указывают минимальный состав
технических средств, обеспечивающий
работу программы.
В
разделе «Описание функций» указывают:
-
максимальный
состав технических средств, проверяемых
этой программой; -
описание
совместного функционирования технических
средств и программы с указанием метода
обработки ошибок; -
описание
организации входных и выходных данных,
используемых при обслуживании технических
средств; -
описание
взаимодействий устройств с программой,
результатов взаимодействий, с выводом
результатов работы программы.
(по ГОСТ 19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и оформлению)
Настоящий стандарт устанавливает требования к
содержанию и оформлению программного документа «Руководство оператора», определённого ГОСТ 19.101-77. Структуру и оформление документа устанавливают в
соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и
содержания) является обязательным.
==================================
Скачать пример оформления
A.B.00001-01 34 01 (Руководство оператора) (пример — .pdf) |
514 137 b | Загрузить |
A.B.00001-01 34 01 (Руководство оператора) (шаблон — .dot) |
17 902 b | Загрузить |
На верх
==================================
Рекомендуемая структура программного документа (по ГОСТ 19.505-79. ЕСПД)
- Лист утверждения
- Титульный лист
- Аннотация
- Содержание
- Основная часть
- Назначение программы
- Функциональное назначение программы
- Эксплуатационное назначение программы
- Состав функций
- Функции (такой-то)
-
Функции (этакой)
- Условия выполнения программы
- Минимальный состав аппаратных средств
- Минимальный состав программных средств
- Требования к персоналу (пользователю)
- Выполнение программы
- Загрузка и запуск программы
- Выполнение программы
- Выполнение функции (такой-то)
- Выполнение функции (этакой)
- Завершение работы программы
- Сообщения оператору
- Сообщение (такое-то)
- Сообщение (этакое)
- Приложения (необязательны)
- Регистрация изменений
На верх
==================================
<Предыдущий>
<Содержание>
Подборка по базе: Контрольная работа.docx, Практическая работа.docx, Курсовая работа_arzyl-buyana.docx, 1.3.Практическая работа N 1.docx, Лабораторная работа 1.docx, Практическая работа №3 (чек-лист).doc, 1.2.Самостоятельная работа.docx, Курсовая работа для ИС жилишнего фонда.docx, КУРСОВАЯ РАБОТА образец.docx, Контрольная работа.docx
Практическая работа №3,4
«Разработка руководства оператора»
ЦЕЛЬ РАБОТЫ:изучить структуру разделов руководства оператора по ГОСТ 19.505-79, получить навыки разработки руководства оператора согласно ГОСТ 19.505-79.
ОБОРУДОВАНИЕ:ПК, MS Excel, Браузер Opera.
ВРЕМЯ ВЫПОЛНЕНИЯ: 90 минут
КРАТКАЯ ТЕОРИЯ И МЕТОДИЧЕСКИЕ РЕКОМЕНДАЦИИ:
В 2004 — 2005 годах был опубликован минимально необходимый набор «учебно-тренировочных» документов на программы, включающий техническое задание на программу по ГОСТ 19.201-78, программу и методику испытаний по ГОСТ 19.301-79, руководство оператора по ГОСТ 19.505-79. Этого достаточно для разработки программы, проведения испытаний и сдачи ее заказчику.
Структура разделов руководства оператора по ГОСТ 19.505-79 приведена ниже.
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным [из п. 1.1 ГОСТ 19.505-79]
Руководство оператора должно содержать следующие разделы:
- назначение программы;
- условия выполнения программы;
- выполнение программы;
- сообщения оператору.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые [из п. 1.2 ГОСТ 19.505-79]
Назначение программы
В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации [из п. 2.1 ГОСТ 19.505-79]
ПОРЯДОК ВЫПОЛНЕНИЯ РАБОТЫ И ФОРМА ОТЧЕТНОСТИ:
Задание
Разработать руководство оператора для информационной системы согласно ГОСТ 19.505-79. В качестве примера можно выбрать информационную систему, для которой разрабатывалось технического задание в Практической работе № 1, 2.
Требования к руководству следующие:
- Руководство оператора должно содержать следующие разделы:
- назначение программы;
- условия выполнения программы;
- выполнение программы;
- сообщения оператору.
- В разделе «Назначение программы» необходимо указать сведения о назначении программы и предоставить информацию, достаточную для понимания функций программы и ее эксплуатации.
- В разделе «Условия выполнения программы» укажите условия, необходимые для выполнения программы: минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.
- В разделе «Выполнение программы» должны быть:
- указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы,
- приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
- В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).
- Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками, скриншотами.
Контрольные вопросы:
- Перечислить основные разделы руководства оператора согласно ГОСТ 19.505-79.
-
Составление каких частей руководства оператора является обязательным?
-
Можно ли объединять разделы руководства оператора или вводить новые?
-
Какого минимальное количество персонала, требуемого для работы программы?
Бизнес-процессы организации иногда требуют создания руководящих документов, отличных от классических положений, регламентов, инструкций, правил или методических указаний. Директор, доведенный до бешенства хаосом в организации или отделе, может поручить вам составить документ с подробнейшим описанием порядка выполнения всех ключевых действий. В статье объясним, что такое руководство, в каких случаях его нужно создать и как именно это сделать.
Виды руководящих документов
При описании тех или иных процессов, действий и взаимодействий подразделений и работников, которые занимают определенные должности и исполняют ряд трудовых функций и обязанностей, часто используют такие виды руководящих документов, как положения, регламенты, инструкции, правила, методические указания. У каждого из перечисленных документов есть свое назначение (Таблица 1).
Что такое руководство и зачем оно нужно?
Кажется, что для нужд предприятия, документов, перечисленных в Таблице 1, достаточно. Но иногда требуется создать иной руководящий документ – руководство. Рассмотрим на конкретном примере, когда он может понадобиться.
Опишу ситуацию, которая однажды сложилась в нашей организации. Работники складов, имея на вооружении инструкции и правила, в которых описаны различные рабочие процессы (приемка товара по качеству и количеству, выдача товара покупателю, набор товара для отправки в региональные склады, работа с некондиционным товаром, работа с неликвидами, работа с вилочными погрузчиками и т.д.), часто ходили в грязной и рваной спецодежде (сменные комплекты чистой и целой одежды всегда есть) либо вообще не носили спецодежду, заменяя ее чем придется из домашнего гардероба, забывали своевременно освобождать помещение склада от использованной тары и упаковочных материалов, несколько раз забывали запирать склад на ночь.
Да, в организации действовали приказы, предписывающие носить на рабочих местах только выданную спецодежду установленного образца, менять ее еженедельно, а также правила сдачи и снятия помещения «на охрану». Но возникла надобность в едином документе, который объединил бы все уже расписанные действия сотрудников в единое целое буквально по шажочку. Что сделать вначале: отпереть дверь ключом или снять помещение с охранной сигнализации? Переодеть штаны или включить на складе свет? Как часто выбрасывать мятую упаковочную бумагу – после вскрытия каждой упаковки или после вскрытия десяти упаковок? Что делать, если покупатель, получающий товар, упал в обморок?
Думаю, понятно, что многие из заявленных «непоняток» были очень похожи на простой саботаж, которым иногда не брезгуют работники. Дескать, а где написано, что я должен сначала выдать товар покупателю, а уж потом подметать пол на складе? Я хочу сначала подмести, у меня и в инструкции написано: «удалить из помещения склада использованные упаковочные материалы и тару», и пусть весь мир подождет! Или что я должен сделать вначале: выключить освещение в помещении склада или пойти переодеваться?
И так может продолжаться бесконечно. Важно, что вопросы и надуманные нестыковки различных действий доводятся до абсурда и мешают производственному процессу.
После некоторого размышления в нашей организации было принято решение создать руководящий документ, который устранил бы все «непонятки», связал бы различные процессы, расставил бы акценты и приоритеты при выполнении различных действий. Кроме того, была поставлена задача написать этот документ как можно подробнее, что в устах доведенного до бешенства руководства звучало «как для дураков». Содержание и назначение документа не подпадало ни под одно определение руководящих документов, поэтому я назвала его «Руководство», так как формат руководства пользователя, прилагаемого, например, к приобретаемой бытовой технике, наиболее точно подходил к задаче.
Структура руководства для работников подразделения
Руководство для работников подразделения – это документ, описывающий работу подразделения в целом, который устанавливает и регулирует общий порядок работы по всем направлениям деятельности и включает в себя основные алгоритмы действий работников на протяжении рабочей смены, расставляет приоритеты выполнения различных процессов.
Структура руководства не регламентирована, но в целом имеет много общего со структурой других руководящих документов – положения, регламента (Схема 1).
Раздел «Общие положения»
Обычно в разделе «Общие положения» любого документа указываются:
1. Назначение (цель) документа.
2. Область применения.
3. Нормативные ссылки (или нормативные документы).
4. Связанные документы, локальные нормативные акты.
5. Глоссарий (термины и сокращения).
6. Порядок утверждения руководства, внесения в него изменений и его отмены.
Назначение (цель) документа
В написании этой части применяется стандартная фраза для всех руководящих документов подобного вида, например:
1.1. Настоящее руководство устанавливает и регулирует общий порядок работы персонала склада.
Также можно использовать такую формулировку:
1.1. Цель настоящего руководства – установление и регулирование общего порядка работы склада.
Область применения
В этом абзаце следует указать наименования и коды подразделений (если они есть), которых касается это руководство. Поскольку мы пишем документ для работников одного конкретного подразделения, то эту часть можно опустить. Но если руководство затрагивает и другие подразделения, то следует указать, какие именно. Например, так:
1.2. Область применения документа:
– складское хозяйство;
– транспортный отдел.
Нормативные ссылки (или нормативные документы)
Здесь необходимо указать нормативные документы, которые использовались при разработке этого руководства, а именно: действующие государственные, отраслевые стандарты, кодексы Российской Федерации, методические рекомендации по внедрению государственных стандартов, действующие приказы и постановления государственных органов и т.д.
Например, для создания руководства для работников склада эта часть может выглядеть следующим образом:
1.3. Нормативные документы:
1. Инструкция о порядке приемки продукции производственно-технического назначения и товаров народного потребления по количеству (утв. Постановлением Госарбитража СССР от 15.06.1965 № П-6).
2. Инструкция о порядке приемки продукции производственно-технического назначения и товаров народного потребления по качеству (утв. Постановлением Госарбитража СССР от 25.04.1966 № П-7).
Материал публикуется частично. Полностью его можно прочитать в журнале «Секретарь-референт» № 8, 2021.