Руководство оператора это руководство пользователя - Insto.top - инструкции по эксплуатации и многое другое

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Наименование документа	Наименование стандарта	Стоимость разработки
Руководство оператора на программное обеспечение	ГОСТ 19.505	70 тыс. р.

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

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

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

Источник

petr2off писал(а): ↑27 июн 2018, 06:39
Я сделал документ по ГОСТ 19.505-79. Руководство оператора. И основная претензия была — нафиг оператору знать про диски и базы данные всякие. Описание программы совсем не нужно знать оператору. Ему нужно видеть, что все в порядке, а если не в порядке — то должно быть сообщение куда бежать и кому звонить.

Всё правильно. В первой же главе этого ГОСТа читаем:

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

назначение

условия выполнения

выполнение

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

Где тут устройство аппаратной части, перечень неисправностей и способы их устранения? Претензия обоснована. Это ведь ЕСПД.

А автор к ЕСКД обращается, то есть у него железо, не софт. Как бы совсем разные вещи.

petr2off писал(а): ↑26 июн 2018, 11:35
Но заказчик выразил неудовольствие, но — общегнесеологическое, т.е. без ссылок на регламентирующий документ, который его бы удовлетворил. Начальник тот тоже тяготеет к общечеловеческим термином. По его мнению — «Оператор — это законченный дебил, а поэтому надо вот ,… что бы понятно было.

Тоже логично.
Ну, нам ведь не видно как там у Вас написано. А в общем, раздел «использование по назначению» должен содержать список операций, штатно выполняемых оператором/персоналом, и каждый пункт должен содержать пошаговую инструкцию типа «нажми сюда — узри это». Горячо любимое ранее советскими разработчиками описание принципов работы схемы сюда включать НЕ НАДО.

[+] пример того, что не надо упоминать в руководстве оператора

Если очень хочется это описать — опишите в другом отдельном разделе руководства по эксплуатации.

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

Отправлено спустя 5 минут 52 секунды:
Руководство — это руководящий документ, а не обучающий и не описательный. Термины следует понимать буквально.

Источник

В 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

…

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

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

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

или

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

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

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

В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы (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.

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

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

Содержание

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

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

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

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

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

Источник

Согласно
ГОСТ 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, Имя пользователя и
пароль, Имя хоста для базы данных.

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

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

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

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

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

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

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

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

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

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

Источник

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

получение
прибыли от сайта;
рассказ
о продукции компании будущему партнеру
в Интернете;
сбор
базы данных клиентов;
продажа
товаров через Интернет.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

…

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

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

или

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

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

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

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

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

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

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

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

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

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

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

Наименование документа	Наименование стандарта	Стоимость разработки
Руководство оператора на программное обеспечение	ГОСТ 19.505	70 тыс. р.

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

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

Источник

Практическая работа №13

Тема: Руководство пользователя.

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

Теоретические
сведения.

Руководство
пользователя (user guide или user
manual), руководство по эксплуатации, руководство
оператора — документ, назначение которого — предоставить людям помощь
в использовании некоторой системы. Документ входит в состав технической
документации на систему и, как правило,
подготавливается техническим писателем.

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

Содержание

Типичное
руководство пользователя содержит:

·
Аннотацию, в
которой приводится краткое изложение содержимого документа и его назначение

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

·
Страницу
содержания

·
Главы,
описывающие, как использовать, по крайней мере, наиболее важные функции
системы

·
Главу, описывающую
возможные проблемы и пути их решения

·
Часто
задаваемые вопросы и ответы
на них

·
Где
ещё найти информацию по предмету, контактная информация

·
Глоссарий и, в
больших документах, предметный указатель

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

Стандарты

Структура и
содержание документа Руководство пользователя автоматизированной
системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и
содержание документов Руководство оператора, Руководство
программиста, Руководство системного программиста регламентированы
ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

·
Комплекс
стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)

· РД
50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ

·
Единая система конструкторской документации (ЕСКД)
определяет документ «Руководство по эксплуатации» и другие документы:

· ГОСТ
2.601-2013 Эксплуатационные документы

· ГОСТ
2.610-2006 Правила выполнения эксплуатационных документов

·
Единая
система программной документации (ЕСПД)
определяет документы «Руководство оператора», «Руководство по техническому обслуживанию»
и их структуру:

· ГОСТ
19.101-77 Виды программ и программных документов

· ГОСТ
19.105-78 Общие требования к программным документам

· ГОСТ
19.505-79 Руководство оператора. Требования к содержанию и оформлению

· ГОСТ
19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и
оформлению.

Руководство
пользователя согласно требованиям ГОСТ

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

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

Руководящими
стандартами для создания документа Руководство пользователя могут
являться как РД
50-34.698-90 в п.п. 3.4. «Руководство пользователя», так
и ГОСТ
19.505-79 «Руководство оператора. Требования к содержанию и оформлению». Ниже для
сравнения приведены структуры документа согласно двум перечисленным стандартам.

РД 50-34.698-90 (п.п. 3.4 Руководство пользователя)	ГОСТ 19.505-79 Руководство оператора
Введение
Область применения
Описание возможностей
Уровень подготовки пользователя
Перечень эксплуатационной документации, с которыми необходимо ознакомиться пользователю
Назначение и условия применения
Виды деятельности и функции, для автоматизации которых предназначена программа	Назначение программы
Условия, при которых обеспечивается применение программы	Условия выполнения программы
Подготовка к работе	Выполнение программы
Состав и содержание дистрибутивного носителя данных
Порядок загрузки данных и программ	Порядок загрузки, запуска и завершения программы
Проверка работоспособности
Описание операций	Описание функций
Описание всех выполняемых функций, задач, комплексов задач, процедур
Описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур
Аварийные ситуации (действия в случае длительных отказов технических средств, обнаружении несанкционированного вмешательства в данные, действия по восстановлению программ или данных, и т.п. )	Сообщения оператору
Рекомендации по освоению

Таким образом, мы можем выделить следующие основные разделы руководства
пользователя:

ü Назначение
системы;

ü Условия применения
системы;

ü Подготовка системы
к работе;

ü Описание операций;

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

Назначение системы

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

Пример:

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

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

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

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

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

Квалификация
пользователя – данный подраздел должен содержать требования к навыкам и знаниям
пользователя (пример: «Пользователи должны обладать навыками работы с
операционной системой Windows XP»);

Подготовка
системы к работе

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

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

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

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

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

Пример:

«4.1
Согласование проекта. Данный процесс предназначен для организации работы
сотрудников, участвующих в разработке и согласовании проекта.
Автор проекта создает запись в Системе и прикрепляет пакет необходимой
документации, далее проект передается на согласование руководящими лицами.
Руководители после ознакомления с проектом могут подтвердить его или отправить
на доработку Автору.

4.1.1
Создание проекта. Для того чтобы создать Проект необходимо на панели «…»
нажать на кнопку «…» и в появившейся форме заполнить следующие поля:

Наименование
проекта;

Описание
проекта;

Следующие
поля заполняются автоматически:

Дата
создания проекта – текущая дата;

Автор –
ИФО и должность автора проекта.»

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

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

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

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

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

Ниже представлен пример (образец)
документа «Руководство пользователя«, разработанного на
основании методических указаний РД
50-34.698-90.

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

Для формирования руководства пользователя
в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической
системы «Корпоративное хранилище данных».

Ниже приведен состав руководства
пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к
содержанию и текст примера заполнения (выделен вертикальной
чертой).

Разделы руководства пользователя:

1.
Введение.

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

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

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

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

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

1. Введение

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

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

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

3.
уровень
подготовки пользователя;

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

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

Требования настоящего документа
применяются при:

· предварительных комплексных
испытаниях;

· опытной эксплуатации;

· приемочных испытаниях;

· промышленной эксплуатации.

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

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

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

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

· формирование табличных и
кросс-табличных отчетов;

· построение различных диаграмм;

· экспорт и импорт результатов
анализа;

· печать результатов анализа;

· распространение результатов
анализа.

1.3. Уровень подготовки
пользователя

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

· знать соответствующую предметную
область;

· знать основы многомерного анализа;

· понимать многомерную модель
соответствующей предметной области;

· знать и иметь навыки работы с
аналитическими приложениями.

Квалификация пользователя должна
позволять:

· формировать отчеты в Oracle
Discoverer Plus;

· осуществлять анализ данных.

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

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

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

2. Назначение и условия применения
Oracle Discoverer Plus

В разделе «Назначение и
условия применения» указывают:

1.
виды
деятельности, функции, для автоматизации которых предназначено данное средство
автоматизации;

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

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

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

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

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

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

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

2.
порядок
загрузки данных и программ;

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

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

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

1.
Internet
Explorer (входит в состав операционной системы Windows);

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

3.2. Порядок загрузки данных и
программ

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

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

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

3.
После чего
запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next
и затем OK.

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

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

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

2.
Ввести в
адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».

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

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

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

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

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

1.
описание всех
выполняемых функций, задач, комплексов задач, процедур;

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

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

1.
наименование;

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

3.
подготовительные
действия;

4.
основные
действия в требуемой последовательности;

5.
заключительные
действия;

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

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

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

Oracle Discoverer Plus в составе
ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:

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

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

Ниже приведено описание
пользовательских операций для выполнения каждой из задач.

Задача:
«Визуализация отчетности»

Операция 1: Регистрация на портале
ИАС КХД

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

1.
Компьютер
пользователя подключен к корпоративной сети.

2.
Портал ИАС КХД
доступен.

3.
ИАС КХД
функционирует в штатном режиме.

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

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

Основные
действия в требуемой последовательности:

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

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

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

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

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

15-30 секунд.

Операция 2: Выбор отчета

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

Успешная регистрация на Портале
ИАС КХД.

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

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

Основные
действия в требуемой последовательности:

1. В появившемся окне «Мастер
создания рабочих книг» поставить точку напротив пункта «Открыть существующую
рабочую книгу».

2. Выбрать нужную рабочую книгу и
нажать кнопку «Откр.»:

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

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

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

15 секунд.

Задача:
«Формирование табличных и графических форм отчетности»

Заполняется по аналогии.

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

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

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

Класс ошибки	Ошибка	Описание ошибки	Требуемые действия пользователя при возникновении ошибки
Портал ИАС КХД	Сервер не найден. Невозможно отобразить страницу	Возможны проблемы с сетью или с доступом к порталу ИАС КХД.	Для устранения проблем с сетью обратиться к сотруднику подразделения технической поддержки (HelpDesk). В других случаях к администратору ИАС КХД.
Ошибка: Требуется ввести действительное имя пользователя	При регистрации на портале ИАС КХД не введено имя пользователя.	Ввести имя пользователя.
Ошибка: Требуется ввести пароль для регистрации	При регистрации на портале ИАС КХД не введен пароль.	Ввести пароль.
Ошибка: Сбой аутентификации. Повторите попытку	Неверно введено имя пользователя или пароль, либо такая учетная запись не зарегистрирована.	Нужно повторить ввод имени пользователя и пароля, однако после третей неудачной попытки регистрации учетная запись блокируется. Если учетная запись заблокирована, нужно обратиться к администратору ИАС КХД.
Сбой в электропитании рабочей станции	Нет электропитания рабочей станции или произошел сбой в электропитании.	Рабочая станция выключилась или перезагрузилась.	Перезагрузить рабочую станцию. Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды: — нажать кнопку «Пуск» — выбрать пункт «Выполнить» — в строке ввода набрать команду telnet ias_dwh.ru 80 — если открылось окно Telnet, значит соединение возможно. Повторить попытку подключения (входа) в ИАС КХД
Сбой локальной сети	Нет сетевого взаимодействия между рабочей станцией и сервером приложений ИАС КХД	Отсутствует возможность начала (продолжения) работы с ИАС КХД. Нет сетевого подключения к серверу ИАС КХД	Перезагрузить рабочую станцию. Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды: — нажать кнопку «Пуск» — выбрать пункт «Выполнить» — в строке ввода набрать команду telnet ias_dwh.ru 80 — если открылось окно Telnet, значит соединение возможно. После восстановления работы локальной сети повторить попытку подключения (входа) в ИАС КХД.

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

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

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

· Oracle® Business Intelligence Discoverer
Viewer User’s Guide

· Oracle® Business Intelligence Discoverer
Plus User’s Guide

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

· Discoverer 10g: Создание запросов
и отчетов

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

Ход
работы:

Задание 1.
Изучите
свой вариант руководства пользователя. Опишите его по следующему плану:

1) для
какого продукта, предназначено руководство пользователя (наименование, модель);

2)
основные технические характеристики продукта;

3)
основные разделы руководства пользователя (название раздела и краткое его
описание)

Задание 2.
Откройте
документ «Образец руководства пользователя», заполните в нем первые разделы для
своего вымышленного программного продукта.

Сделайте
вывод
о проделанной работе.

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

1) Дайте
определения понятиям «руководство пользователя», «инструкция по эксплуатации»

2) Какие
основные разделы должно содержать руководство пользователя?

3) Какие
стандарты описывают Руководство пользователя Руководство оператора, Руководство
программиста, Руководство системного программиста?

4) Что
описывает раздел «назначение системы»?

5) Что
указывается в разделе «условия применения системы»?

6) Какая
информация содержится в разделе «Описание операций»?

Источник

Урок 28.

Предмет: Технология
разработки программных продуктов.

Тема:
Документирование программных средств.

Цели:

Образовательная

Ознакомление с видами
документов при разработки ПО.

Развивающая:

Развивать умение слушать других, делать выводы и обобщать полученные
знания

Воспитательная:

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

Межпредметные связи:

—
Английский язык

—
Операционные системы

—
Информационные технологии

—
Основы алгоритмизации и программирования

Оборудование: доска, мел, письменные принадлежности,
проектор, ПК

Тип урока: комбинированный

Метод обучения: Объяснительно иллюстративный

Ход урока:

1.Организационный момент

— Проверка
готовности кабинета

— Объявление
темы

2. Постановка цели урока

3.Повторение пройденного материала

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

Инструментальные
системы технологии программирования

Инструментальные
средства разработки программ

4.Сообщение новых знаний

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

2.
Пояснительная записка

3.
Руководство пользователя

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

5.
Основные правила оформления программной документации

5. Восприятие и осознание учащимися нового материала

6. Осмысление обобщение и систематизация знаний

7. Подведение итогов урока и
постановка домашнего задания

Выучить содержимое
темы

Гагарина Л.Г. стр. С.233-238.

Ответить на
вопросы:

Лекция №11:Составление
программной документации

Учебные вопросы:

6.
Виды программных документов

7.
Пояснительная записка

8.
Руководство пользователя

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

10. Основные
правила оформления программной документации

11. Правила
оформления расчетно-пояснительных записок при курсовом проектировании

ВВЕДЕНИЕ

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

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

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

К программным относят
документы, содержащие сведения, необходимые для разработки, сопровождения и
эксплуатации программного обеспечения. Документирование программного обеспечения
осуществляется в соответствии с Единой системой программной документации (ГОСТ
19.ХХХ). Так ГОСТ 19.101-77 устанавливает виды программных документов для программного
обеспечения различных типов. Ниже перечислены основные программные документы
по этому стандарту и указано, какую информацию они должны содержать.

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

Ведомость держателей подлинников (код вида документа — 05) должна
содержать список предприятий, на которых хранятся подлинники программных
документов. Необходимость этого документа определяется на этапе разработки и
утверждения технического задания только для программного обеспечения со
сложной архитектурой.

Текст программы (код вида документа — 12) должен содержать текст
программы с необходимыми комментариями. Необходимость этого документа
определяется на этапе разработки и утверждения технического задания.

Описание программы (код вида документа — 13) должно содержать сведения
о логической структуре и функционировании программы. Необходимость данного
документа также определяется на этапе разработки и утверждения технического
задания.

Ведомость эксплуатационных документов (код вида документа — 20)
должна содержать перечень эксплуатационных документов на программу, к которым
относятся документы с кодами: 30, 31, 32, 33, 34, 35, 46. Необходимость этого
документа также определяется на этапе разработки и утверждения технического
задания.

Формуляр (код вида документа — 30) должен содержать основные характеристики
программного обеспечения, комплектность и сведения об эксплуатации программы.

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

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

Руководство программиста (код вида документа — 33) должно содержать
сведения для эксплуатации программного обеспечения.

Руководство оператора (код вида документа — 34) должно содержать
сведения для обеспечения процедуры общения оператора с вычислительной системой
в процессе выполнения программного обеспечения.

Описание языка (код вида документа — 35) должно содержать описание
синтаксиса и семантики языка.

Руководство по техническому обслуживанию (код вида документа — 46)
должно содержать сведения для применения тестовых и диагностических программ
при обслуживании технических средств.

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

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

Прочие документы (коды вида документа — 90-99) могут составляться
на любых стадиях разработки, т. е. на стадиях эскизного, технического и рабочего
проектов.

Допускается объединять
отдельные виды эксплуатационных документов, кроме формуляра и ведомости.
Необходимость объединения указывается в техническом задании, а имя берут у
одного из объединяемых документов. Например, в настоящее время часто
используется эксплуатационный документ, в который отчасти входит руководство
системного программиста, программиста и оператора. Он называется «Руководство
пользователя» (см §3).

Рассмотрим наиболее важные
программные документы более подробно.

2. Пояснительная записка

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

Содержание пояснительной
записки по стандарту (ГОСТ 19.404-79) должно выглядеть следующим образом:

• введение;

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

• технические
характеристики;

• ожидаемые
технико-экономические показатели;

• источники, используемые
при разработке.

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

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

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

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

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

• описание и обоснование выбора способа
организации входных и выходных данных;

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

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

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

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

3. Руководство пользователя

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

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

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

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

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

• будьте точны и рациональны — длинные и
запутанные руководства обычно никто не читает, например, лучше привести рисунок
формы, чем долго ее описывать.

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

• общие сведения о
программном продукте;

• описание установки;

• описание запуска;

• инструкции по работе
(или описание пользовательского интерфейса);

• сообщения пользователю.

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

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

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

Раздел Инструкции по
работе обычно содержит описание режимов работы, форматов ввода-вывода
информации и возможных настроек.

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

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

По ГОСТ 19.503-79
руководство системного программиста должно содержать всю информацию,
необходимую для установки программного обеспечения, его настройки и проверки
работоспособности. Кроме того, как указывалось выше, в него часто включают и
описание необходимого обслуживания, которое раньше приводилось в руководстве
оператора (ГОСТ 19.505-79) и/или руководстве по техническому обслуживанию (ГОСТ
19.508-79). В настоящее время данную схему используют для составления
руководства системному администратору.

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

• общие сведения о
программном продукте,

• структура,

• настройка,

• проверка,

• дополнительные
возможности,

• сообщения системному
программисту.

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

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

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

В разделе Проверка
программы должно быть приведено описание способов проверки работоспособности
программы, например контрольные примеры.

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

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

5. Основные правила оформления программной документации

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

Оформление текстового и
графического материала. Текстовые документы оформляют на листах формата А4,
причем графический материал допускается представлять на листах формата A3.
Поля на листе определяют в соответствии с общими требованиями: левое — не менее
30, правое — не менее 10, верхнее — не менее 15, а нижнее — не менее 20 мм. В текстовых редакторах
для оформления записки параметры страницы заказывают в зависимости от
устройства печати. При ручном оформлении документов параметры страницы выбирают
из соображений удобства.

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

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

• при выполнении документа
машинописным способом — двум интервалам;

• при выполнении
рукописным способом — 10 мм;

• при использовании текстовых редакторов —
определяется возможностями редактора.

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

• при выполнении документа
машинописным способом — трем интервалам;

• при выполнении
рукописным способом — не менее 15
мм;

• при использовании текстовых редакторов —
определяется возможностями редактора.

Разделы и подразделы
нумеруются арабскими цифрами с точкой. Разделы должны иметь порядковые номера
1, 2, и т. д. Номер подраздела включает номер раздела и порядковый номер подраздела,
входящего в данный раздел, разделенные точкой. Например: 2.1, 3.5. Ссылки на
пункты, разделы и подразделы указывают, используя порядковый номер раздела или
пункта, например, «в разд. 4», «в п. 3.3.4».

Текст разделов печатают
через 1,5-2 интервала. При использовании текстовых редакторов высота букв и
цифр должна быть не менее 1,8
мм (шрифты № 11-12).

Перечисления следует
нумеровать арабскими цифрами со скобкой, например: 2), 3) и т. д. — с
абзацного отступа. Допускается выделять перечисление простановкой дефиса перед
пунктом текста или символом, его заменяющим, в текстовых редакторах.

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

Каждый рисунок должен
иметь подрисуночную подпись — название, помещаемую под рисунком, например:

Рис.12. Форма окна
основного меню

На все рисунки, таблицы и
формулы в записке должны быть ссылки в виде: «(рис. 12)» или «форма окна
основного меню приведена на рис. 12».

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

Если рисунок занимает
более одной страницы, на всех страницах, кроме первой, проставляется номер
рисунка и слово «Продолжение». Например:

Рис. 12. Продолжение

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

Схемы алгоритмов должны
быть выполнены в соответствии со стандартом ЕСПД. Толщина сплошной линии при
вычерчивании схем алгоритмов должна составлять от 0,6… 1,5 мм. Надписи на схемах
должны быть выполнены чертежным шрифтом, высота букв и цифр должна быть не менее
3,5 мм.

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

Ссылки на таблицы в тексте
пояснительной записки указывают в виде слова «табл.» и номера таблицы.
Например:

Результаты тестов
приведены в табл. 4.

Номер формулы ставится с
правой стороны страницы в круглых скобках на уровне формулы. Например:

z:=sin(x)+ln(y); (12)

Ссылка на номер формулы
дается в скобках. Например: «расчет значений проводится по формуле (12)».

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

ПРИЛОЖЕНИЕ 2 Титульный
лист расчетно-пояснительной записки

Рисунки и таблицы,
помещаемые в приложении, нумеруют арабскими цифрами в пределах каждого
приложения с добавлением буквы «П», Например:

Рис. П. 12 — 12-й рисунок
приложения; Рис. П1.2 — 2-й рисунок 1-го приложения.

Если в приложении
приводится текст программы, то каждый файл оформляют как рисунок с наименованием
файла и его назначением, например:

Рис. П2.4. Файл menuran.pas — программа движения курсора
основного меню.

Оформление списка литературы.

Список литературы должен
включать все использованные источники. Сведения о книгах (монографиях, учебниках,
пособиях, справочниках и т. д.) должны содержать: фамилию и инициалы автора,
заглавие книги, место издания, издательство, год издания. При наличии трех и
более авторов допускается указывать фамилию и инициалы только первого из них со
словами «и др.». Издательство надо приводить полностью в именительном падеже:
допускается сокращение названия только двух городов: Москва (М.) и
Санкт-Петербург (СПб.).

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

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

При ссылке на источник из
списка литературы (особенно при обзоре аналогов) надо указывать порядковый
номер по списку литературы, заключенный в квадратные скобки; например: [5].

Лекция 13. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СРЕДСТВ

13.1. Документация, создаваемая в процессе разработки программных
средств.

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

Эту документацию можно разбить на две
группы [13.1]:

Документы управления разработкой ПС.

Документы, входящие в состав ПС.

Документы
управления разработкой ПС (process documentation), протоколируют
процессы разработки и сопровождения ПС, обеспечивая связи внутри коллектива
разработчиков и между коллективом разработчиков и менеджерами (managers) — лицами, управляющими разработкой. Эти
документы могут быть следующих типов [13.1]:

Планы,
оценки, расписания. Эти документы создаются менеджерами для
прогнозирования и управления процессами разработки и сопровождения.

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

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

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

Заметки
и переписка. Эти документы фиксируют различные детали взаимодействия
между менеджерами и разработчиками.

Документы,
входящие в состав ПС (product documentation), описывают программы ПС как
с точки зрения их применения пользователями, так и с точки зрения их
разработчиков и сопроводителей (в соответствии с назначением ПС). Здесь следует
отметить, что эти документы будут использоваться не только на стадии
эксплуатации ПС (в ее фазах применения и сопровождения), но и на стадии
разработки для управления процессом разработки (вместе с рабочими документами)
— во всяком случае они должны быть проверены (протестированы) на соответствие
программам ПС. Эти документы образуют два комплекта с разным назначением:

Пользовательская документация ПС
(П-документация).

Документация по сопровождению ПС
(С-документация).

13.2. Пользовательская документация программных средств.

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

В связи с этим следует различать две
категории пользователей ПС: ординарных пользователей ПС и администраторов ПС. Ординарный пользователь ПС (end-user) использует
ПС для решения своих задач (в своей предметной области). Это может быть инженер,
проектирующий техническое устройство, или кассир, продающий железнодорожные
билеты с помощью ПС. Он может и не знать многих деталей работы компьютера или
принципов программирования. Администратор
ПС (system administrator) управляет использованием ПС ординарными
пользователями и осуществляет сопровождение ПС, не связанное с модификацией
программ. Например, он может регулировать права доступа к ПС между ординарными
пользователями, поддерживать связь с поставщиками ПС или выполнять определенные
действия, чтобы поддерживать ПС в рабочем состоянии, если оно включено как
часть в другую систему.

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

В соответствии с работами [13.1, 13.2]
можно считать типичным следующий состав пользовательской документации для
достаточно больших ПС:

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

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

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

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

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

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

13.3.
Документация по сопровождению программных средств.

Документация
по сопровождению ПС (system documentation) описывает ПС с точки зрения
ее разработки. Эта документация необходима, если ПС предполагает изучение того,
как оно устроена (сконструирована), и модернизацию его программ. Как уже
отмечалось, сопровождение — это продолжающаяся разработка. Поэтому в случае
необходимости модернизации ПС к этой работе привлекается специальная команда
разработчиков-сопроводителей. Этой команде придется иметь дело с такой же
документацией, которая определяла деятельность команды первоначальных
(основных) разработчиков ПС, — с той лишь разницей, что эта документация для
команды разработчиков-сопроводителей будет, как правило, чужой (она создавалась
другой командой). Команда разработчиков-сопроводителей должна будет изучать эту
документацию, чтобы понять строение и процесс разработки модернизируемого ПС, и
внести в эту документацию необходимые изменения, повторяя в значительной
степени технологические процессы, с помощью которых создавалось первоначальное
ПС.

Документация по сопровождению ПС можно
разбить на две группы:

(1) документация, определяющая строение
программ и структур данных ПС и технологию их разработки;

(2) документацию, помогающую вносить
изменения в ПС.

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

Внешнее описание ПС (Requirements document).

Описание архитектуры ПС (description of the system architecture), включая внешнюю
спецификацию каждой ее программы.

Для каждой программы ПС — описание ее
модульной структуры, включая внешнюю спецификацию каждого включенного в нее
модуля.

Для каждого модуля — его спецификация и
описание его строения (design description).

Тексты модулей на выбранном языке
программирования (program source code listings).

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

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

Документация второй группы содержит

Руководство по сопровождению ПС (system
maintenance guide), которое описывает известные проблемы вместе с ПС,
описывает, какие части системы являются аппаратно- и программно-зависимыми, и
как развитие ПС принято в расчет в его строении (конструкции).

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

Литература к лекции 13.

13.1. Ian Sommerville. Software Engineering. —
Addison-Wesley Publishing Company, 1992. P.

13.2. ANSI/IEEE Std 1063-1988, IEEE Standard for Software User
Documentation.

13.3. ANSI/IEEE Std 830-1984, IEEE Guide for Software Requirements
Specification.

13.4. ANSI/IEEE Std 1016-1987, IEEE Recommended Practice for Software
Design Description.

13.5. ANSI/IEEE Std 1008-1987, IEEE Standard for Software Unit Testing.

13.6. ANSI/IEEE Std 1012-1986, IEEE Standard for Software Verification
and Validation Plans.

13.7. ANSI/IEEE Std 983-1986, IEEE Guide for Software Quality Assurance
Planning.

13.8. ANSI/IEEE Std 829-1983, IEEE Standard for Software Test
Documentation.

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

3. Руководство пользователя

• сообщения пользователю.

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

Источник

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

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

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

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

Практическая работа №13

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

Инструментальные системы технологии программирования

Инструментальные средства разработки программ

А вот и еще наши интересные статьи:

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

Инструментальные
системы технологии программирования

Инструментальные
средства разработки программ