Руководство оператора на программное обеспечение

Руководство оператора – это основной документ в составе эксплуатационной документации на программное обеспечение (ГОСТ 19). Очевидно ли это?

Назначение руководства оператора

В соответствии с государственными стандартами, Руководство оператора входит в состав комплекта эксплуатационной документации на программное обеспечение. Для чего нужен такой документ? Чтобы ответить на этот вопрос, необходимо понять, какую роль в использовании системы играет оператор.

Мы знаем, что администратор отвечает за настройку системы и поддержку работы пользователей. Пользователь же, в свою очередь, выполняет с помощью системы определенные прикладные функции, решает прикладные задачи. Роль оператора по своим функциям ближе всего к роли пользователя, однако, отличается от нее тем, что перед оператором не ставятся прикладные задачи, которые он может решить с помощью программы тем или иным способом, в том или ином порядке. Его работа заключается в выполнении отдельных операций (согласно инструкции), то есть конкретных последовательностей действий, приводящих к конкретному результату (например, ежедневный запуск вспомогательных программ).

Состав типового руководства оператора

Так, например, требования к содержанию и оформлению Руководства оператора представлены в ГОСТ 19.505. В соответствии с требованиями стандарта, документ должен содержать следующие разделы:

– Назначение программы, где указывают область применения ПО и общие сведения о ней.

– Условия выполнения программы, где должны быть указаны условия, необходимые для работы ПО.

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

– Сообщения оператору, где приводят тексты сообщений, выдаваемых в ходе выполнения программы, а также действия оператора в случае, если реакция программы не соответствует ожидаемой.

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

– не стоит включать в документ теоретические описания и отступления, лучше собрать всю теорию в отдельный раздел, а лучше, по возможности, обойтись без нее совсем;

– лучше не ссылаться в документе на какие-либо внешние или внутренние источники, информацию предпочтительнее продублировать в том месте, где она необходима;

– описывать нужно не только действия оператора, но и те результаты, которые он должен получить.

Стандарты для руководства оператора

Наличие Руководства оператора регламентируется ГОСТ 19.101, а структура и содержание – ГОСТ 19.505. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства оператора могут отличаться друг от друга по способу, методике и стилю изложения.

Стоимость разработки руководства оператора

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

Возможно, вас также заинтересует:

– разработка руководства администратора;
– создание руководства программиста;
– разработка руководства пользователя.

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

Руководство
оператора предназначено для более
эффективной эксплуатации программы с
оператором. Описывается, для чего
необходима программа и ее применение,
необходимые условия для выполнения и
работы программы, и порядок работы с
программой, чтобы у пользователей не
возникало вопросов по обращению с
программой.

Назначение
программы.

Программа
предназначена для наглядности получения
данных через всемирную паутину. Основными
функциями интернет-магазина по продаже
компьютерной техники являются:

• получение
  прибыли от сайта;

• рассказ
  о продукции компании будущему партнеру
  в Интернете;

• сбор
  базы данных клиентов;

• продажа
  товаров через Интернет.

Условия
выполнения программы.

Программа
будет выполняться при наличии браузера
(например, Internet
Explorer,
Opera,
Google
Chrome).
Также необходим модем для выхода в
Интернет. Для обеспечения нормальной
работы программы должна быть использована
следующая конфигурация компьютера:
центральный процессор класса Pentium
III
433 МГц; объём оперативной памяти не менее
128 Mb
(потому как при меньшем объеме скорость
загрузки страниц будет меньше); стандартный
манипулятор «мышь»; стандартный SVGA
монитор; операционная система типа
Windows 2000, XP, 7.

Выполнение
программы.

Доступ
к Сайту осуществляется интерактивно
через сеть Интернет посредством обычного
web–браузера.

При открытии
появляется главная страница сайта. На
странице имеются функциональные кнопки,
позволяющие перейти на другую страницу.

3.3 Руководство программиста

Согласно
ГОСТ 19.105-78 Руководство программиста
должно содержать следующие разделы:
назначение и условия применения
программы; характеристика программы;
обращение к программе; входные и выходные
данные; сообщения.

Назначение
и условия применения программы.

Программа
предназначена для продажи товаров
компьютерной техники данных через
Интернет. Основными функциями сайта
являются:

Для
обеспечения нормальной работы программы
должна быть использована следующая
конфигурация компьютера: стандартный
манипулятор «мышь»; стандартный SVGA
монитор; операционная система типа
Windows 2000, XP, 7; модем.

Системные
требования.

Для работы сайта
на сервере должен быть установлен
интерпретатор языка PHP, а так же MySQL для
управления базой данных.

Большинство
современных хостинговых компаний в
качестве web-сервера представляют
платформу Linux. Так же возможна работа
системы под управлением других
веб-серверов, таких, как Windows IIS (Internet
Information Server), при наличии в них поддержки
PHP и MySQL.

Для
настройки сайта на сервере понадобится:
Имя базы данных MySQL, Имя пользователя и
пароль, Имя хоста для базы данных.

Характеристика
программы

Сайт
представляет собой совокупность
электронных документов, размещенных в
сети Интернет, обладающих электронным
адресом.

Информативность
– одна из основных характеристик любого
Интернет-ресурса.

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

Обновляемость.
Только постоянно обновляемые сайты
привлекают внимание пользователей
сети.

Обращение
к программе:

• доступ
  к Сайту осуществляется интерактивно
  через сеть Интернет посредством обычного
  браузера;

• адрес
  сайта в сети Интернет;

• для
  просмотра содержимого сайта необязательно
  авторизовываться, то есть вводить имя
  пользователя и пароль.

Входные и выходные
данные

Сайт
предназначен для продажи компьютерной
техники, потому как это техническим
заданием определено.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

• #
• #
• #
• #
• #
• #
• #
• #
• #
• #
• #

ГОСТ 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).

Общая информация

Документация принадлежит к типу программной, эксплуатационной документации пользователя. Объединяет в себе пакеты документов программы, программного компонента системы или комплекса. Создается для операторов. Целью документации является обеспечение оператору комфортной работы с программным продуктом. Все документы соответствуют стандартам: ГОСТ 19.505-79.

Предмет и применение

Работа оператора сходна с действиями пользователя. Оператор не настраивает систему, а производит необходимые действия в заданную единицу времени: запускает программу, принимает сведения, формирует отчеты и т.д. В руководстве описаны все действия, чтобы работа оператора была четкой и регламентируемой.

Содержание

Руководство оператора схоже с инструкцией пользователя. В нем указаны все алгоритмы решения возможных задач и проблем.

Методология и язык написания

Язык текста должен быть максимально простым и понятным, инструкции – ясными и понятными.
1. Вся теоретическая информация сведена к минимуму и содержится в одном разделе.
2. Отсутствие ссылок.
3. Конкретные указания.
4. Описание производимых действий и их последствий.

Стандартная структура — согласно ГОСТ 19.505-79.

1. Назначение программы.
2. Условия выполнения программы.
3. Выполнение программы.
4. Сообщения оператору.