Разработка руководства оператора программы

В 2004 — 2005 годах был опубликован минимально необходимый набор «учебно-тренировочных» документов на программы, включающий техническое задание на программу по ГОСТ 19.201-78, программу и методику испытаний по ГОСТ 19.301-79, руководство оператора по ГОСТ 19.505-79. Этого достаточно для разработки программы, проведения испытаний и сдачи ее заказчику. Редакция от 23.01.2022.

Создан 16.02.2010 19:41:18

Структура разделов руководства оператора по ГОСТ 19.505-79 приведена на рисунке.

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным [из 1.1 ГОСТ 19.505-79]

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

Состав руководства

Руководство оператора должно содержать следующие разделы:

• назначение программы (1);
• условия выполнения программы (2);
• выполнение программы (3);
• сообщения оператору (4).

В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые [из 1.2 ГОСТ 19.505-79]

Последняя фраза предоставляет разработчикам программной документации пространство для маневра.

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

В разделе «Назначение программы» должны быть указаны сведения о назначении программы (1.1) и информация, достаточная для понимания функций программы и ее эксплуатации (1.2) [из 2.1 ГОСТ 19.505-79]

«…должны быть указаны сведения о назначении программы». Сведения о назначении программы изложены в основополагающем документе – в техническом задании.

Функциональное назначение

Функциональным назначением программы является предоставление пользователю возможности работы с текстовыми документами в формате rtf.

Эксплуатационное назначение

Программа должна эксплуатироваться в профильных подразделениях на объектах заказчика.

Пользователями программы должны являться сотрудники профильных подразделений объектов заказчика.

Состав функций

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

1. Функции создания нового (пустого) файла;
2. Функции открытия (загрузки) существующего файла;
3. Функции редактирования открытого (далее — текущего) файла путем ввода, замены, удаления содержимого файла с применением стандартных устройств ввода;
4. Функции редактирования текущего файла с применением буфера обмена операционной системы;
5. Функции сохранения файла с исходным именем;
6. Функции сохранения файла с именем, отличным от исходного;
7. Функции отправки содержимого текущего файла электронной почтой с помощью внешней клиентской почтовой программы;
8. Функции вывода оперативных справок в строковом формате (подсказок);
9. Функции интерактивной справочной системы;
10. Функции отображения названия программы, версии программы, копирайта и комментариев разработчика.

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

В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (2.1) (минимальный и (или) максимальный состав аппаратурных (2.2) и программных средств (2.3) и т.п.) [из 2.2 ГОСТ 19.505-79]

Создаем соответствующие подразделы. Поскольку «аппаратурных» звучит старообразно, меняем его на «технических».

Климатические условия эксплуатации

Климатические условия эксплутатации, при которых должны обеспечиваться заданные характеристики, должны удовлетворять требованиям, предъявляемым к техническим средствам в части условий их эксплуатации.

Минимальный состав технических средств

В состав технических средств должен входить IBM-совместимый персональный компьютер (ПЭВМ), включающий в себя:

1. процессор Pentium-1000 с тактовой частотой, ГГц — 10, не менее;
2. материнскую плату с FSB, ГГц — 5, не менее;
3. оперативную память объемом, Тб — 10, не менее;
4. и так далее…

Минимальный состав программных средств

Системные программные средства, используемые программой, должны быть представлены лицензионной локализованной версией операционной системы. Допускается использование пакета обновления такого-то.

Требования к персоналу (пользователю)

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

Системный администратор должен иметь высшее профильное образование и сертификаты компании-производителя операционной системы. В перечень задач, выполняемых системным администратором, должны входить:

1. задача поддержания работоспособности технических средств;
2. задачи установки (инсталляции) и поддержания работоспособности системных программных средств – операционной системы;
3. задача установки (инсталляции) программы.

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

Персонал должен быть аттестован на II квалификационную группу по электробезопасности (для работы с конторским оборудованием).

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

В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающих загрузку (3.1), запуск (3.2), выполнение (3.3) и завершение программы (3.6), приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы (3.4), а также ответы программы на эти команды (3.5) [из 2.3 ГОСТ 19.505-79]

Автоматически, «пальцами», создаем подразделы:

• Загрузка и запуск программы;
• Выполнение программы;
• Завершение работы программы.

Во время оно загрузка программы осуществлялась отдельно, запуск — отдельно. В нынешних условиях загрузка и запуск объединились в единую операцию. Ключевая фраза подраздела «Требования к количеству и квалификации персонала» технического задания — «пользователь программы (оператор) должен обладать практическими навыками работы с графическим пользовательским интерфейсом операционной системы» снимает с автора обязанность подробно расписывать способы загрузки и запуска программы… Не обязан разработчик разжевывать оператору приемы работы с графическим пользовательским интерфейсом операционной системы. За исключением случаев применения в программе элементов интерфейса, не свойственных операционной системе.

Загрузка и запуск программы

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

В случае успешного запуска программы на рабочем столе будет отображено Главное окно программы.

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

«В подразделе следует привести «описание функций, формата и возможных вариантов команд, с помощью которых оператор … управляет выполнением программы».

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

Выполнение функции создания нового (безымянного) файла

Выполнение указанной функции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Файл-Создать;
2. нажатием кнопки .

В случае успешного выполнения указанной функции на рабочем столе будет отображено окно (см. Загрузка и запуск программы). Программа готова к вводу и редактированию текста.

Примечание — При успешном завершении загрузки и запуска программа автоматически создаст новый (безымянный) файл.

Подход прост. Действие — результат, см. Схема «действие — результат» в совокупности с подходом «делай, как я сказал». Ошибочный результат – сообщение об ошибке.

Сторонники «дружественного» отношения к пользователю вправе озаглавить подраздел, к примеру, так — «Создание нового файла». Ни буква, ни дух ГОСТ 19.505-79 этому не препятствуют. В настоящем документе исключено прямое обращение к пользователю. Отсутствуют «откройте», «нажмите», «укажите» и пр. Применены штампы «следует открыть», «следует нажать» и им подобные (согласно ГОСТ 2.105-95).

Выполнение функции открытия (загрузки) существующего файла

Выполнение указанной функции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Файл-Открыть;
2. нажатием кнопки ;
3. последовательным нажатием клавиш Ctrl и O (сочетанием клавиш Ctrl+O).

В результате на рабочем столе будет отображено окно Открыть.

Примечание — Программа обеспечивает возможность загрузки файлов только с расширением *.rtf.

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

В случае успешного (выполнения программой функции) открытия файла на рабочем столе будет отображено окно с содержимым открытого (текущего) файла. Заголовок Главного окна программы будет отображать полный путь текущего файла.

Неразумно брать на себя ответственность уважаемого г-на Торвальдса и компании, тем более — г-на Гейтса. Не должно настоящее руководство заменять учебную, справочную литературу, руководства от производителей ОС и прочие источники информации, освещающие работу с графическим пользовательским интерфейсом операционной системы. Понадобится пользователю открыть файл средствами операционной системы — пусть изучает матчасть и расширяет, тем самым, свой кругозор.

Выполнение функции редактирования текущего файла путем ввода, замены, удаления содержимого файла с применением устройств ввода

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

Редактирование текущего файла путем ввода текста с устройств ввода

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• пометку в тексте стартовой позиции редактирования;
• ввод (набор) текста.

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

Далее следует вводить (набирать) требуемый текст с клавиатуры. По мере ввода символов изображение курсора будет смещаться вправо.

Редактирование текущего файла путем замены содержимого с применением устройств ввода

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• выделение текста, подлежащего замене;
• ввод (набор) текста.

Для выделения текста, подлежащего замене, следует:

• переместить курсор в стартовую позицию фрагмента;
• нажать левую клавишу мыши и, не отпуская ее, переместить курсор в конечную позицию фрагмента.

Фрагмент текста будет выделен цветом.

Далее следует вводить требуемый текст с клавиатуры. Выделенный фрагмент текста будет удален. По мере ввода символов изображение курсора будет смещаться вправо.

Редактирование текущего файла путем удаления содержимого с применением устройств ввода

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• выделение текста, подлежащего удалению;
• удаление.

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

Удаление может быть выполнено любым из перечисленных ниже способов:

1. нажатием клавиши Delete;
2. нажатием сочетания клавиш Ctrl+X;
3. нажатием клавиши BackSpace.

Выполнение функции редактирования текущего файла с применением буфера обмена операционной системы

Указанная функция включает в себя перечисленные ниже операции:

• операцию копирования (фрагмента) файла;
• операцию вставки содержимого буфера обмена в файл.

Выполнение операции копирования (фрагмента) файла

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• выделение текста, подлежащего копированию;
• копирование.

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

Примечание — При отсутствии выделенного (фрагмента) текста выполнение операции копирования невозможно. Кнопка копирования недоступна и имеет вид , пункт меню Копировать недоступен.

Выполнение указанной операции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Правка-Копировать;
2. нажатием кнопки ;
3. нажатием сочетания клавиш Ctrl+C.

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

Выполнение операции вставки содержимого буфера обмена в файл

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• пометку (указание) в тексте текущего файла стартовой позиции вставки;
• вставку содержимого буфера обмена.

Примечание — При отсутствии содержимого в буфере обмена выполнение операции вставки невозможно. Кнопка вставки недоступна и имеет вид , пункт меню Вставить недоступен.

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

Выполнение указанной операции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Правка-Вставить;
2. нажатием кнопки ;
3. нажатием сочетания клавиш Ctrl+V.

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

Выполнение функции сохранения файла с исходным именем

Выполнение указанной функции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Файл-Сохранить;
2. нажатием кнопки ;
3. последовательным нажатием клавиш Ctrl и S (сочетанием клавиш Ctrl+S).

Выполнение функции сохранения файла с именем, отличным от исходного

…

Наверное, достаточно. Нет смысла дублировать (фактически) описания выполнения типовых функций программы в учебно-тренировочном документе.

Завершение работы программы

Завершение работы программы обеспечиваются стандартными средствами операционной системы.

или

Выполнение указанной функции возможно любым из перечисленных ниже способов:

1. последовательным выбором пунктов меню Файл-Выход (см. рисунок такой-то);
2. нажатием кнопки .

Сообщения оператору

В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы (4.1), описание их содержания и соответствующие действия оператора (4.2) (действия оператора в случае сбоя (4.3), возможности повторного запуска программы (4.4) и т.п.) [из 2.5 ГОСТ 19.505-79]

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

«описание их содержания»

Ошибка сохранения файла

При попытке сохранения файла с именем уже существующего файла на рабочем столе программы будет отображено сообщение об ошибке.

«и соответствующие действия оператора»

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

Для сохранения файла с именем, отличным от имени существующего файла, следует:

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

Об иллюстрациях

Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками [из 2.6 ГОСТ 19.505-79]

В настоящем учебно-тренировочном руководстве оператора в качестве иллюстраций используются экранные формы (окна), отображаемые на рабочем столе.

О приложениях

В приложения (5) к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства [из 2.7 ГОСТ 19.505-79]

Все, что душе угодно.

Выводы

Утверждения отдельных граждан о том, что 19-я система стандартов безнадежно устарела и не может быть применена для разработки современных программ с графическим пользовательским интерфейсом, а также для разработки и выпуска качественной программной документации к программным изделиям — чушь.

Причиной для таких утверждений, судя по всему, стали:

• обычная лень — нежелание открыть ЕСПД и один-единственный раз (!) во всем разобраться;
• тяга к оформительству, подогреваемая отдельными маститыми «техническими писателями»;
• тяга к буржуйским стандартам (ибо нет пророка в своем отечестве);
• и еще много чего.

Отдельно о буржуйских стандартах. Через некоторое время планируется опубликовать сравнительный анализ ГОСТ 19-й системы и IEEE Std 830-1998, а также IEEE Std 1063-2001 с целью показать:

• превосходство советских стандартов 25-летней давности в целом;
• «цельнотянутость» буржуйских с наших.

Примечание от 17.02.2010 г. — Сравнительный анализ указанных документов дан в статье «Как писать руководство пользователя? Часть I».

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

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

Примерный
план написания руководства пользователя
в соответствии с ГОСТ 19.505-79 «Руководство
оператора» /2/:

1.
Действия при запуске программы (какой
файл должен быть запущен, какие действия
должны при этом выполняться).

2.
Структура программы (какие окна есть,
как между ними переключаться, структура
меню и назначение его элементов).

3.
Каким образом осуществляется ввод
данных.

4.
Какая информация выводится на экран.

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

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

5. Оформление пояснительной записки

Оформление
пояснительной записки к курсовой работе
выполняется в соответствии правилами,
принятыми кафедрой «Программное
обеспечение» /3/.

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

При
описании литературного источника
необходимо указать /4,5/:

• фамилии
  и инициалы авторов,

• название
  книги или статьи,

• место
  издания,

• издательство,

• год
  издания.

При
описании ссылки на сайт Интернета
указать:

• адрес
  сайта,

• наименование
  сайта.

В
приложениях
помещают вспомогательные или дополнительные
материалы, которые иллюстрируют текст
основной части работы ( таблицы, графики,
диаграммы, схемы, рисунки). В приложение
выносятся тексты программ и руководство
пользователя. Каждое приложение должно
начинаться с новой страницы с указанием
в правом верхнем углу слова «ПРИЛОЖЕНИЕ»
и иметь тематический заголовок. При
наличии в работе более одного приложения
они нумеруются арабскими цифрами. На
все представленные приложения должны
быть сделаны ссылки из текста.

6. Защита курсовой работы

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

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

В
ходе защиты курсовой работы оцениваются:

• правильность
  и работоспособность программы, полнота
  ее функциональных возможностей,
  интерфейс пользователя;

• знание
  среды программирования и основ
  алгоритмизации, степень владения
  материалом;

• аккуратность
  оформления пояснительной записки;

• соответствие
  материалов работы требованиям ГОСТ и
  правилам, установленным кафедрой;

• понимание
  использованных математических методов;

• изложение
  материалов в устном докладе.

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

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

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

Функциональное назначение

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

Эксплуатационное назначение

Программный комплекс должен эксплуатироваться в профильных подразделениях на объектах Заказчика.

Конечными пользователями программного комплекса должны являться сотрудники профильных подразделений объектов Заказчика.

Состав функций

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

Реализация заданного механизма поддержания работоспособности информационной системы;

Обеспечение ручного и автоматического режимов работы;

Журналирование событий, происходящих в системе.

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

Климатические условия эксплуатации

Климатические условия эксплуатации, при которых должны обеспечиваться заданные характеристики, должны удовлетворять требованиям, предъявляемым к техническим средствам в части условий их эксплуатации.

Минимальный состав технических средств

В состав технических средств должен входить IBM-совместимый персональный компьютер (ПЭВМ), включающий в себя:

процессор Pentium-IV с тактовой частотой — 3,2 ГГц;

оперативную память объемом 1 Гб;

Минимальный состав программных средств

Система функционирует под управлением ОС FreeBSВ версии 7.0.

Требования к пользователю

Для работы программного комплекса в ручном режиме требуется минимум один конечный пользователь (оператор).

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

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

Установка и конфигурация программного комплекса

Для установки программного комплекса необходимо:

1. скопировать исполняемый файл «floatcenter» в каталог на жестком диске, создать файл журнала и конфигурационных параметров;

2. Файл конфигурационных параметров представляет собой текстовый файл со строками «Параметр=Значение» (Пример представлени на рисунке 1.7.4.1).

Список допустимых параметров:

· CLUSTER_NAME — имя кластера (символьное имя);

· NODE_NAME — имя узла (символьное имя);

· CENTER_NAME — доменное имя центра (символьное имя);

· SCRIPT_BECOME_CENTER — путь к файлу сценария, запускаемого при присвоении данному узлу статуса «центра»;

· SCRIPT_BECOME_USUAL — путь к файлу сценария, запускаемого при присвоении данному узлу статуса рядового узла;

· LOG — путь к файлу журнала;

· NODE_WEIGHT — вес узла (числовое значение);

· MODE — режим работы (допустимые значения: SERVER, CLIENT)

3. Установить разрешения на чтение и запись файл журнала, исполнение исполняемого файла программного комплекса и чтения файла конфигурации.

Рисунок 1.7.4.1. — Процесс конфигурации программного комплекса.

Взаимодействие программным комплексом

Запуск:

Для запуска программного комплекса необходимо выполнить следующую команду:

> ./floatcenter -start

Останов:

Для останова программного комплекса необходимо выполнить следующую команду:

> ./floatcenter -stop

Получение информации о конфигурации кластера:

Для получения информации о конфигурации кластера необходимо выполнить следующую команду:

> ./floatcenter -into

Переназначение центра:

Для переназначения центра необходимо выполнить следующую команду:

> ./floatcenter -change <ИМЯ_УЗЛА>

Сообщения оператору

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

Основными же сообщения оператору являются:

1. Сообщение о недостаточных правах на чтениезапись в файл журнала;

2. Сообщение о недостаточных правах на чтение файла параметров;

3. Сообщения, подтверждающие выполнение команды (рисунок 1.7.5.1).

Рисунок 1.7.5.1. — Подтверждение выполнения команды.

При попытке выполнить недопустимую команду, ее исполнение игнорируется.

---

Подборка по базе: Научная работа на тему _Анализ физической активности населения_., Практическая работа_ разработка технологической карты урока (кур, Практическая работа (2).docx, HR контольная работа.docx, Инвестирование. Контрольная работа.pdf, Практическая работа1.docx, Практическая работа № 1. Разработка типовой формы инд…и о…ба, практическая работа 8.docx, Практическая работа 2. Анкудинов.docx, курсовая работа КОМПЛЕКСНЫЙ ЭКОНОМИЧЕСКИЙ АНАЛИЗ.docx

---

Практическая работа № 4. Разработка руководства оператора

Цель работы: изучение нормативно правовой документации, регламентирующей раз- работку документации на программные средства.

Основу отечественной нормативной базы в области документирования ПС составляет комплекс стандартов Единой системы программной документации (ЕСПД). Основная и боль- шая часть комплекса ЕСПД была разработана в 70-е и 80-е годы. Стандарты ЕСПД в основном охватывают ту часть документации, которая создается в процессе разработки ПС, и связаны, по большей части, с документированием функциональных характеристик ПС.

Согласно ЕСПД программный документ – это документ, содержащий сведения, необхо- димые для разработки, изготовления, эксплуатации и сопровождения программного изделия. Номенклатуру программных документов определяет

ГОСТ 19.101-77 «ЕСПД. Виды программ и программных документов». В качестве основных видов программ стандартом определяются:
§ компоненты – программы, рассматриваемые как единое целое, выполняющие закон- ченную функцию и применяемые самостоятельно или в составе комплекса;
§ комплексы– программы, состоящие из двух или более компонентов, выполняющие взаимосвязанные функции и применяемые самостоятельно или в составе другого комплекса.

Виды программных документов и их краткое содержание представлены в стандарте опи- саниями, приведенными в таблице 1.

Таблица 1. Виды программных документов

Вид доку мента	Содержание документа
Спецификация	Состав программы и документация на ее
Ведомость дер- жателей под- линников	Перечень предприятий, на которых хранятся подлинники программных документов
Текст про- граммы	Запись программы с комментариями
Описание	Сведения о логической структуре
программы	и функционировании программы
Программа и методика ис- пытаний	Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля
Техническое задание	Назначение и область применения программы; технические, технико-эко- номические и специальные требования, предъявляемые к программе; не- обходимые стадии и сроки разработки; виды испытаний
Пояснительная записка	Схема алгоритма, общее описание алгоритма и (или) функционирова- ния программы, а также обоснование принятых технических и технико- экономических решений
Эксплуатаци- онные доку- менты	Сведения для обеспечения функционирования и эксплуатации программы

Перечень эксплуатационных документов, рекомендуемых ЕСПД, представлен в табл. 2. Таблица 2. Виды эксплуатационных документов

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

Допускается объединение отдельных видов эксплуатационных документов (за исключе- нием ведомости эксплуатационных документов и формуляра), необходимость объединения указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов. В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.

ГОСТ 19.701-90 (ИСО 5807-85) «Единая система программной документации. Схемы алгоритмов, программ, данных и систем. Обозначения условные и правила вы- полнения». Стандарт распространяется на условные обозначения (символы) в схемах алгорит- мов, программ, данных и систем и устанавливает правила выполнения схем, используемых для отображения различных видов задач обработки данных и средств их решения.

В РФ действует ряд стандартов в части документирования ПС, разработанных на ос- нове прямого применения международных стандартов ИСО.

ГОСТ Р ИСО/МЭК 9294-93 «Информационнаятехнология. Руководство по управлению документированием программного обеспечения». Стандарт устанавливает ре- комендации по эффективному управлению документированием ПС для руководителей, отвеча- ющих за их создание. Целью стандарта является оказание помощи в определении стратегии документирования ПС; выборе стандартов по документированию; выборе процедур докумен- тирования; определении необходимых ресурсов; составлении планов документирования.

ГОСТ Р ИСО 9127-94 «Системы обработки информации. Документация пользова- теля и информация на упаковке для потребительских программных пакетов». В контек- сте настоящего стандарта под потребительским программным пакетом (ПП) понимается «про- граммная продукция, спроектированная и продаваемая для выполнения определенных функ- ций; программа и соответствующая ей документация, упакованные для продажи как единое це- лое». Под документацией пользователя понимается документация, которая обеспечивает ко- нечного пользователя информацией по установке и эксплуатации ПП. Под информацией на упаковке понимают информацию, воспроизводимую на внешней упаковке ПП. Ее целью явля- ется предоставление потенциальным покупателям первичных сведений о ПП.

Содержание документа «Руководство пользователя» Документ «Руководство поль- зователя», разрабатывается на основании методических указаний РД 50-34.698-90. Данный до- кумент формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».

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

1. Введение.
2. Назначение и условия применения.
3. Подготовка к работе.
4. Описание операций.
5. Аварийные ситуации.
6. Рекомендации по освоению.

Введение

В разделе «Введение» указывают:

область применения;

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

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

1. Область применения

Требования настоящего документа применяются при: предварительных комплексных испытаниях; опытной эксплуатации;

приемочных испытаниях; промышленной эксплуатации.

1. Краткое описание возможностей

Например:

Информационно-аналитическаясистемаКорпоративноеХранилищеДанных(ИАСКХД) предназначена для оптимизации технологии принятия тактических и стратегическихуправленческих решений конечными бизнес-пользователями на основе информации о всех ас-пектахфинансово-хозяйственной деятельностиКомпании.

ИАС КХД предоставляет возможность работы с регламентированной и нерегламен-тированнойотчетностью.

1. УровеньподготовкиоператораНапример:

ОператорИАСКХДдолжениметьопытработысОСMSWindows(95/98/NT/2000/XP),навык работы с ПО Internet Explorer, Oracle Discoverer, а также обладать следующими зна-ниями:

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

1. Перечень эксплуатационной документации, с которой необходимо ознако- миться оператору

Например:

информационно-аналитическая система «Корпоративное хранилище данных».ПАСПОРТ;

Информационно-аналитическаясистема«Корпоративноехранилищеданных».ОБ-ЩЕЕОПИСАНИЕСИСТЕМЫ.

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

В разделе «Назначение и условия применения» указывают: — виды деятельности, функ- ции, для автоматизации которых предназначено данное средство автоматизации;

условия, при соблюдении (выполнении, наступлении) которых обеспечивается приме- нение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигу- рация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).

Например:

Oracle Discoverer Plus в составе ИАС КХД предназначен для автоматизации подго-товки, настройки отчетных форм по показателям деятельности, а также для углубленногоисследованияданныхна основекорпоративной информациихранилища данных.

РаботасOracleDiscovererPlusвсоставеИАСКХДвозможнавсегда,когдаестьнеоб-ходимость в получении информации для анализа, контроля, мониторинга и принятия решенийнаееоснове.

Работа с Oracle Discoverer Plus в составе ИАС КХД доступна всем пользователям сустановленнымиправами доступа.

1. Подготовка к работе

В разделе «Подготовка к работе» указывают:

• состависодержаниедистрибутивногоносителяданных;
• порядокзагрузкиданныхипрограмм;
• порядокпроверки работоспособности.

1. Состав и содержание дистрибутивного носителя данных

Например:

Для работы с ИАС КХД необходимо следующее программное обеспечение:InternetExplorer(входитвсоставоперационнойсистемыWindows);

Oracle JInitiator устанавливается автоматически при первом обращении пользователякИАСКХД.

1. ПорядокзагрузкиданныхипрограммНапример:

ПередначаломработысИАСКХДнарабочемместеоператоранеобходимовыпол-нитьследующиедействия:

НеобходимозайтинасайтИАСКХДias-dwh.ru.

Вовремязагрузкивпоявившемсяокне«Предупреждение

о безопасности»,котороебудетсодержатьследующее:‘Хотитеустановитьивы-полнить«Oracle JInitiator»…’Нажимаемна кнопку «Да».
ПослечегозапуститьсяустановкаOracleJInitiatorнаВашкомпьютер.ВыбираемкнопкуNext и затемOK.

1. Порядок проверки работоспособности

Например:

ДляпроверкидоступностиИАСКХДсрабочегоместаоператоранеобходимовыпол-нитьследующиедействия:

ОткрытьInternetExplorer,дляэтогонеобходимокликнутьпоярлыку«InternetExplorer»на рабочемстолеиливызвать из меню«Пуск».
ВвестивадреснуюстрокуInternetExplorerадрес:ias-dwh.ruинажать«Переход».

В формеаутентификацииввестипользовательскийлогинипароль.Нажатькнопку

«Далее».

Убедиться,что вокнеоткрылосьприложениеOracleDiscovererPlus.

В случаееслиприложениеOracleDiscovererPlusнезапускается,тоследуетобра-титьсявслужбуподдержки.

1. Описание операций

В разделе «Описание операций» указывают:

• описаниевсехвыполняемыхфункций,задач,комплексовзадач,процедур;
• описаниеоперацийтехнологическогопроцессаобработкиданных,необходимыхдлявыполненияфункций, комплексов задач (задач), процедур.

Для каждой операции обработки данных указывают:

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

В описании действий допускаются ссылки на файлы подсказок, размещенные на маг- нитных носителях.

1. Выполняемые функции и задачи

Например:

OracleDiscovererPlusвсоставеИАСКХДвыполняетфункцииизадачи

1. Описание операций технологического процесса обработки данных, необходи- мых для выполнения задач

Например:

Задача:«Визуализацияотчетности»Операция1:РегистрациянапорталеИАСКХД

Условия,присоблюдениикоторыхвозможновыполнениеоперации:

• Компьютерпользователяподключенккорпоративнойсети.
• ПорталИАСКХДдоступен.
• ИАСКХДфункционируетвштатномрежиме.

Подготовительные действия:

· Накомпьютереоператоранеобходимовыполнитьдополнительныенастройки,приведенныевп. 3.2 настоящегодокумента.
Основныедействия втребуемойпоследовательности:

Наиконке«ИАСКХД»рабочегостолапроизвести двойнойщелчоклевойкнопкоймышки.

Воткрывшемсяокневполе«Логин»ввестиимяпользователя,вполе«Пароль»ввестипарольпользователя. Нажать кнопку «Далее».

Заключительные действия:

Нетребуются.

Ресурсы, расходуемые на операцию:

15-30секунд.

1. Аварийные ситуации

В разделе «Аварийные ситуации» указывают:

1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств;
2. действия по восстановлению программ и/или данных при отказе магнитных носите- лей или обнаружении ошибок в данных;
3. действия в случаях обнаружении несанкционированного вмешательства в данные;
4. действия в других аварийных ситуациях. Например:

ВслучаевозникновенияошибокприработеИАСКХД,неописанныхнижевданномраз-деле,необходимообращатьсяксотрудникуподразделениятехническойподдержкиДИТ(HelpDesk)либо к ответственномуАдминистраторуИАС КХД.

6. Рекомендации по освоению

В разделе «Рекомендации по освоению» указывают рекомендации по освоению и экс- плуатации, включая описание контрольного примера, правила его запуска и выполнения.

Например:

Рекомендуемаялитература:

Oracle®BusinessIntelligenceDiscovererViewerUser’sGuideOracle®BusinessIntelligenceDiscovererPlus User’sGuide

Рекомендуемыекурсыобучения:

Discoverer10g:Созданиезапросовиотчетов

Ход работы

1. Подготовить документ (*.doc), содержащий структуру основных разделов руковод- ства оператора стандартного форматирования: шрифт TimesNewRoman, 12 пт, поля, межстроч- ный интервал — стандартные, как в техническом задании, имя файла — <ФИО студента. Руковод- ство пользователя>.
2. На основании технического задания на разработку (практическая работа 2-3), заполнить разделы руководства оператора «Введение», «Назначение и условия применения», «Подготовка к работе».

Контрольные вопросы

1. Перечислить состав разделов руководства пользователя.
2. Пояснить состав раздела «Введение».
3. Пояснить состав раздела «Назначение и условия применения2 применения».
4. Пояснить состав раздела «Подготовка к работе»
5. Пояснить состав раздела «Описание операций»
6. Пояснить состав раздела «Аварийные ситуации»
7. Пояснить состав подраздела «Рекомендации по освоению»

---

Руководство оператору для АРМ – ведущий документ в пакете эксплуатационной документации для программ различной специализации. Содержание и оформление данной бумаги регламентируется едиными государственными стандартами ЕСПД, поэтому создание пакета документации осуществляется в соответствии с системой четких требований.

Как оформляется руководство оператору?

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

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

Пример содержания руководства оператора, оформленного по ГОСТ

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

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