Для чего нужно руководство оператора

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

Руководство оператора

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Наименование документа

Наименование стандарта

Стоимость разработки

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

ГОСТ 19.505

от 70 тыс. р.

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- Как писать руководство оператора по ГОСТ 19.505-79?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- Главное окно программы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- Окно Открыть

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

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

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

- Путь к текущему файлу

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

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

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

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

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

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

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

- Отметка стартовой позиции

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

- Смещение курсора вправо

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

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

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

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

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

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

- Выделение цветом фрагмента текста

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

- Удаление фрагмента текста

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

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

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

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

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

  1. нажатием клавиши Delete;
  2. нажатием сочетания клавиш Ctrl+X;
  3. нажатием клавиши BackSpace.
Выполнение функции редактирования текущего файла с применением буфера обмена операционной системы

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

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

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

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

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

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

- Пункт меню Копировать недоступен

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

или

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

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

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

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

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

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

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

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

- Ошибка при сохранении документа

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

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

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

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

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

Системное сообщение
выводится, если вы хотите закрыть
программу (рисунок
36). Пользователь
должен подтвердить выход, нажав кнопку
«ДА», либо отменить его, нажав кнопку
«Нет».

Рисунок 36. Сообщение
«Выход из программы».

Системное сообщение
выдается при незаполненных полях «Логин»
и «Пароль» на форме «Авторизация»
(Рисунок 37).

Рисунок 37. Сообщение
о незаполненных данных.

При запуске
приложения и отсутствии соединения с
сервером БД выдается сообщение, показанное
на рисунке 38.

Рисунок 38. Сообщение
«Соединение с сервером БД отсутствует».

При неправильно
введенных данных в поля «Логин» и
«Пароль» на форме «Авторизация»,
приложение выдаст следующее сообщение
(Рисунок 39).

Рисунок 39. Сообщение
о неверно введенных данных.

На формах «Новый
билетно-учетный лист» и «Новый путевой
лист» сообщение выводится если
пользователь ввел некоторые данные, и
решил закрыть форму. В данном случае
пользователю необходимо подтвердить
выход кнопкой «Да» или отменить кнопкой
«Нет» (рисунок 40). Если поля пустые, то
данное сообщение не выводится.

Рисунок 40. Сообщение
«Закрыть окно?».

Глава 3 Экономическая часть

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

Затраты времени
на создание программного продукта дает
трудоемкость.

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

Структура общего
времени на создание программного
продукта представлена в табл.2

Таблица 2. Общее время на создание
программного продукта.

№ этапа

Обозначение
времени

данного этапа

Содержание этапа

1

Тпо

Подготовка
описания задачи

2

То

Описание задачи

3

Та

Разработка
алгоритма

4

Тбс

Разработка
блок-схемы алгоритма

5

Тн

Написание
программы

6

Тп

Набивка программы

7

Тот

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

8

Тд

Оформление
документации, инструкции пользователю,
пояснительной записки

Время рассчитывается
в человеко-часах, причем Тпо берется по
фактически отработанному времени
(исходные данные), а время остальных
этапов определяется расчетом по условному
числу команд Q.

Условное число
команд определяется по формуле:

Q=q*c

где q
коэффициент,
учитывающий условное число команд.

Выбрать значение
коэффициента q
можно из табл.3

Таблица 3. Коэффициент числа команд.

Тип задачи

Пределы измерений

коэффициента

Задачи учета

от 1400 до 1500

Задачи оперативного
управления

от 1500 до 1700

Задачи планирования

от 3000 до 3500

Многовариантные
задачи

от 4500 до 5000

Комплексные
задачи

от 5000 до 5500

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

Программные
продукты по степени новизны отнесены
к одной из 4-х групп:

— группа А –
разработка принципиально новых задач;

— группа Б –
разработка оригинальных программ;

— группа В –
разработка программ с использованием
типовых решений;

— группа Г – разовая
типовая задача.

По степени сложности
программные продукты могут быть отнесены
к одной из 3-х групп:

-1- алгоритм
оптимизации и моделирования систем;

-2- задачи учета,
отчетности и статистики;

-3-стандартные
алгоритмы.

Коэффициент С
определяется из табл.4 на пересечении
групп сложности новизны.

Таблица 4. Сложность программы.

Язык программирования

Группа сложности

Степень новизны

А

Б

В

Г

Высокого

уровня

1

1,38

1,26

1,15

0,69

2

1,30

1,19

1,08

0,65

3

1,20

1,10

1,00

0,60

Низкого

уровня

1

1,58

1,45

1,32

0,79

2

1,49

1,37

1,24

0,74

3

1,38

1,26

1,15

0,69

Так как разрабатываемая
программа предназначена для решения
задач учета, то коэффициент q,
выбранный из таблицы 3 равен 1400.

Программа написана
на языке высокого уровня и использует
типовые решения, следовательно, относится
к группе «В». По степени сложности ПП
относится к группе стандартные алгоритмы
(группа 3). Из таблицы 4 выбираем
соответствующую позицию, равную 1,00.
Далее подставляем выбранные данные в
формулу:

Q=1400*1,00=1400

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

  1. Тпо берется по
    факту. Оно равно 7 (человеко/часов).

  2. То определяется
    по формуле:

То=Q*B/(50*K)

где В – коэффициент
учета изменений задачи. Он равен 1,3.

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

Стаж программиста

Значение
коэффициента К

до 2-х лет

0,8

от 2 до 3 лет

1,0

от 3 до 5 лет

1,1 – 1,2

от 5 до 10 лет

1,2 – 1,3

свыше 10 лет

1,3 – 1,5

Таблица 5. Коэффициент
квалификации программиста

Так как стаж
программиста до 2-х лет, то подставляем
в формулу коэффициент 0,8.

То=1400*1,3/(50*0,8)=45,5(ч/час)

3)Та рассчитываем
по формуле:

Та=Q/(50*K)

Та=1400/(50*0,8)
=35(ч/час)

4)Тбс определяется
аналогично Та

Тбс= Та = Q/(50*K)

Тбс= Та =
1400/(50*0,8) =35(ч/час)

5)Тн определяется
по формуле:

Тн=Q*1,5/(50*K)

Тн=1400*1,5/(50*0,8)=52,5(ч/час)

6)Тп определяется
по формуле:

Тп=Q/50

Тп=1400/50=28(ч/час)

7)Тот определяется
по формуле:

Тот=Q*4,2/50*K

Тот=1400*4,2/50*0,8=147(ч/час)

  1. Тд определяется
    аналогично Тпо

Тд=Тпо=7 (ч/час)

Теперь зная время,
затраченное на каждом этапе, можно
подсчитать общее время на создание
программного продукта:

Т=Тпо+То+Та+Тбс+Тн+Тп+Тот+Тд

Т=7+45,5+35+35+52,5+28+147+7=357(ч/час)

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

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

Обновлено: 24.04.2023

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

Титульная часть оформляется согласно ГОСТ 19.104-78 ЕСПД. Основные надписи.

Информационная часть должна состоять из аннотации и содержания. В аннотации приводят сведения о назначении документа и краткое изложение основной части.

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

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

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

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

— Условия выполнения программыдолжны содержать минимальный и максимальный состав аппаратурных и программных средств.

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

Задание

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

Требования к отчёту

Отчёт должен содержать титульный лист, аннотацию, содержание и основную часть, оформленную в соответствии с ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

Лабораторная работа №7

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

Титульная часть оформляется согласно ГОСТ 19.104-78 ЕСПД. Основные надписи.

Информационная часть должна состоять из аннотации и содержания. В аннотации приводят сведения о назначении документа и краткое изложение основной части.

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

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

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

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

— Условия выполнения программыдолжны содержать минимальный и максимальный состав аппаратурных и программных средств.

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

Задание

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

Требования к отчёту

Отчёт должен содержать титульный лист, аннотацию, содержание и основную часть, оформленную в соответствии с ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

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

Руководство оператора

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Примечание

Эти и другие требования к структуре и содержанию руководства оператора по ГОСТ 19 подробнее см. ГОСТ 19.505

Оформление документа

Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).

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

Рубрика Программирование, компьютеры и кибернетика
Вид лабораторная работа
Язык русский
Дата добавления 08.11.2012
Размер файла 52,5 K

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

А.В.00001-01 34 01

Министерство образования и науки РФ

Федеральное агентство по образованию

Государственное образовательное учреждение

Высшего профессионального образования

Кафедра прикладной информатики и информационных систем

Лабораторная работа № 4

РУКОВОДСТВО ОПЕРАТОРА

Выполнил ст. гр. ЗПИ-319

АННОТАЦИЯ

оператор справочник программа аппаратный

1. НАЗНАЧЕНИЕ ПРОГРАММЫ

1.2 Эксплуатационное назначение программы

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

1.3.2 Функция удаление человека из базы данных

1.3.3 Функция изменение данных о человеке

1.3.4 Функция очистки данных о человеке

1.3.5 Функция сортировки людей по группам

Осуществляет отображение людей по выбранной группе.

1.3.6 Функция создания новой базы данных

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

1.3.8 Функция сохранения базы данных

2. УСЛОВИЯ ВЫПОЛНЕНИЯ ПРОГРАММЫ

Минимальный состав используемых технических (аппаратных) средств:

IBM PC совместимый с процессором 80386 и выше

ОЗУ более 32 Мбайт

16 МБ видеопамяти и выше

наличие свободного места на жестком диске более 100 Мбайт.

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

Системные программные средства, используемые программой AdressBook.exe, должны быть представлены локализованной версией операционных систем Windows 98, Me, Xp, Vista, 7.

Также для функционирования программы AdressBook.exe на ПК необходимо предустановленное программное обеспечение стороннего разработчика, программа Delphi 7.

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

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

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

3. ВЫПОЛНЕНИЕ ПРОГРАММЫ

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

3.2.2 Выполнение функции удаление человека из базы данных

3.2.3 Выполнение функции изменение данных о человеке

3.2.4 Выполнение функции очистки данных о человеке

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

Выбираем флажок для отображения необходимой нам группы.

3.2.6 Выполнение функции создания новой базы данных

3.2.7 Выполнение функции открытия уже существующей базы данных

3.2.8 Выполнение функции сохранения базы данных

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

Листинг программы

unit Main;

interface

Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,

Читайте также:

  • Кто когда и где завоевал славу российскому спорту сообщение
  • Сообщение про лягушку быка
  • Сообщение на тему когда болит душа
  • Сообщение интересные факты о белках и аминокислотах
  • Жд сообщение мурманск москва


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

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

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

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

- Как писать руководство оператора по ГОСТ 19.505-79?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- Главное окно программы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- Окно Открыть

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

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

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

- Путь к текущему файлу

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

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

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

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

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

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

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

- Отметка стартовой позиции

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

- Смещение курсора вправо

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

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

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

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

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

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

- Выделение цветом фрагмента текста

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

- Удаление фрагмента текста

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

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

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

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

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

  1. нажатием клавиши Delete;
  2. нажатием сочетания клавиш Ctrl+X;
  3. нажатием клавиши BackSpace.
Выполнение функции редактирования текущего файла с применением буфера обмена операционной системы

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

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

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

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

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

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

- Пункт меню Копировать недоступен

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

или

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

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

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

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

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

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

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

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

- Ошибка при сохранении документа

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Программа
будет выполняться при наличии браузера
(например, 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, Имя пользователя и
пароль, Имя хоста для базы данных.

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Просмотр(активная вкладка)
  • Members

[current-user:field-developer-organization]

УТВЕРЖДЕН

[current-user:field-decimal-number] — ЛУ

[current-user:field-full-program-name]

34 — РУКОВОДСТВО ОПЕРАТОРА ГОСТ 19.505-79

[current-user:field-short-program-name]

[current-user:field-decimal-number] XX 01

Листов

2021

Аннотация

Настоящий документ представляет собой Руководство оператора ПК «Интероперабельность» — [current-user:field-short-program-name].

Документ предназначен для персонала ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization], ответственного за эксплуатацию ПК «Интероперабельность» — [current-user:field-short-program-name] в части использования по назначению.

Основная часть документа содержит сведения о назначении, условиях выполнения, выполнении ПК «Интероперабельность» — [current-user:field-short-program-name] и сообщения оператору.

Вставка Содержания (оглавления): СсылкиОглавление

- Вставка оглавления

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

1.1 Сведения о назначении программы

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

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

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

  • производственная среда (офис) ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization];
  • отдел маркетинга;
  • отдел разработки и поисковой оптимизации веб-контента;
  • отдел веб-дизайна и программирования.

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

Функции ПК «Интероперабельность» — [current-user:field-short-program-name]:

  • запрос и получение позиции ссылки на текущую страницу сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization] в результатах поиска Яндекс.Поиск и Google;
  • запрос и получение сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru);
  • запрос и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights);
  • запрос и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (сервисы CSS Validation Service и Nu Html Checker).

Что-нибудь такое.<?php include (‘sites/all/html/54445.htm’) ?>

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

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

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

2.1 Условия, необходимые для выполнения программы

Условия эксплуатации — соответствующие условиям эксплуатации IBM-совместимых ПЭВМ класса не ниже Реntium IV.

По стойкости к воздействию внешних климатических факторов в процессе эксплуатации IBM-совместимые ПЭВМ относят к средствам вычислительной техники (СВТ) 1-3-й групп [п. 1.3.1 ГОСТ 21552-84].

Нормальными климатическими условиями эксплуатации СВТ 1-3-й групп являются: температура окружающего воздуха (20 ± 5) °С, относительная влажность (60 ± 15) %, атмосферное давление от 84 до 107 кПа (от 630 до 800 мм рт. ст.) [п. 1.3.2 ГОСТ 21552-84].

2.2 Минимальный и (или) максимальный состав аппаратурных средств

Э0303 Требуемые периферийные устройства определены.

Э0302 Требуемый объем внешней памяти определен.

Э0301 Требуемый объем внутренней памяти определен.

Рекомендованные технические характеристики ТС клиентской части:

  • процессор Intel Core i7 — 9700K Socket 1151 v2 8-ядерный;
  • кулер DeepCool GAMMA ARCHER BIGPRO;
  • материнская плата Gigabyte Z390 AORUS PRO Socket 1151 v2;
  • оперативная память 64 Gb DDR4 2400 MHz Crucial Ballistix Sport LT White (4×16 Gb KIT);
  • видеокарта nVidia GeForce GTX1050 Ti ASUS PCI-E 4096 Mb (PH-GTX1050TI-4G);
  • твердотельный накопитель 240 Gb SSD Western Digital 2.5″;
  • блок питания 500 W Aerocool VX-500 PLUS;
  • Wi-Fi адаптер ASUS PCE-N10 Wi-Fi адаптер.

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

Клиентская часть ПС:

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

Серверная часть ПС:

  • веб-сервер Apache (рекомендуется), Nginx, Lighttpd или Microsoft IIS;
  • СУБД MySQL 5.0.15 и выше, PostgreSQL 8.3 и выше или SQLite 3.x;
  • PHP версии 5.2.4 и выше;
  • поддержка текстового формата PHP на веб-страницах.

Э0304 Требуемое базовое программное обеспечение определено.

ПС внешних систем (онлайновые сервисы):

  • сервисы Яндекс.Поиск и поиск Google;
  • сервис анализа плотности использования текста (ключевых слов контента) текущей страницы Be1.ru;
  • сервис анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы веб-страниц PageSpeed Insights;
  • сервисы проверки соответствия веб-страниц стандартам гипертекста CSS Validation Service и Nu Html Checker.

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

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

Процедуры загрузки и вызова ПК «Интероперабельность» — [current-user:field-short-program-name] — автоматическое преобразование загрузочного модуля в гипертекст текущей страницы в ходе ее формирования программными средствами серверной части (CMS Drupal).

Э0104 Функции ввода/вывода (ручной ввод данных) исключены.

Гипертекст сформированной и открытой браузером страницы содержит запросы в виде гиперссылок с параметрами — заголовком (title) и адресом (URL) страницы. Запросы готовы к отправке ВСЕМ ЗАЯВЛЕННЫМ сервисам поиска и анализа путем перехода по данным гиперссылкам.

Какие-либо действия оператора в ходе загрузки, вызова и запуска ПК «Интероперабельность» — [current-user:field-short-program-name] не предусмотрены.

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

Запуск ПК «Интероперабельность» — [current-user:field-short-program-name] выполняется автоматически преобразованием загрузочного модуля средствами CMS Drupal в гипертекст, содержащий активные ссылки, переходы по которым обеспечивают оператору возможность выполнения функций программы, таких как:

  • запрос и получение позиции ссылки на текущую страницу сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization] в результатах поиска Яндекс.Поиск и Google;
  • запрос и получение сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru);
  • запрос и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights);
  • запрос и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (сервисы CSS Validation Service и Nu Html Checker).

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

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

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

  • запрос и получение позиции ссылки на текущую страницу сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization] в результатах поиска Яндекс.Поиск и Google;
  • запрос и получение сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru);
  • запрос и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights);
  • запрос и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (сервисы CSS Validation Service и Nu Html Checker).

Э0106 Функции защиты от несанкционированного доступа обеспечиваются ПС серверной части (матрица доступа).

Э0107 Функции контроля доступа обеспечиваются ПС серверной части (контроль доступа).

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

Что-нибудь такое.<?php include (‘sites/all/html/54445.htm’) ?>

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

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

3.5 Ответы программы

3.5 Ответы программы представлены входными сообщениями сервисов.

3.5.1 Входное сообщение сервиса Яндекс.Поиск

3.5.1 Входное сообщение сервиса Яндекс.Поиск изображено на рисунке .

- Входное сообщение сервиса Яндекс.Поиск

3.5.2 Входное сообщение сервиса поиска Google

3.5.2 Входное сообщение сервиса поиска Google изображено на рисунке .

- Входное сообщение сервиса поиска Google

3.5.3 Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для мобильных устройств

3.5.3 Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для мобильных устройств изображено на рисунке .

- Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для мобильных устройств

3.5.4 Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для компьютеров

3.5.4 Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для компьютеров изображено на рисунке .

- Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для компьютеров

3.5.5 Входное сообщение сервиса PageSpeed Insights (с рекомендациями)

3.5.5 Входное сообщение сервиса PageSpeed Insights (с рекомендациями) изображено на рисунке .

- Входное сообщение сервиса PageSpeed Insights (с рекомендациями)

3.5.6 Входное сообщение сервиса валидации Nu Html Checker (без ошибок)

3.5.6 Входное сообщение сервиса валидации Nu Html Checker (без ошибок) изображено на рисунке .

- Входное сообщение сервиса валидации Nu Html Checker (без ошибок)

3.5.7 Входное сообщение сервиса валидации Nu Html Checker (с ошибками и предупреждениями)

3.5.7 Входное сообщение сервиса валидации Nu Html Checker (с ошибками и предупреждениями) изображено на рисунке .

- Входное сообщение сервиса валидации Nu Html Checker (с ошибками и предупреждениями)

3.5.8 Входное сообщение сервиса валидации CSS Validation Service (без ошибок)

3.5.8 Входное сообщение сервиса валидации CSS Validation Service (без ошибок) изображено на рисунке .

- Входное сообщение сервиса валидации CSS Validation Service (без ошибок)

3.5.9 Входное сообщение сервиса валидации CSS Validation Service (с предупреждениями)

3.5.9 Входное сообщение сервиса валидации CSS Validation Service (с предупреждениями) изображено на рисунке .

- Входное сообщение сервиса валидации CSS Validation Service (с предупреждениями)

3.5.10 Входное сообщение сервиса оценки плотности использования текста Be1.ru

3.5.10 Входное сообщение сервиса оценки плотности использования текста Be1.ru изображено на рисунке .

- Входное сообщение сервиса оценки плотности использования текста Be1.ru

3.6 Последовательность действий оператора, обеспечивающих завершение программы

Закрытие текущей страницы в браузере.

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

См. выше.

5 Приложения

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

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

Copyright © «Техническая документация» 2004 — 2021. Заимствуйте наши материалы с блеском!

Страница 5 из 5

4. СООБЩЕНИЯ ОПЕРАТОРУ

4.1. При неполучении квитанции от УКП или КЩ оператору выдается сообщение в черном окне, если на экране в текущий момент не отображается хотя бы одно из красных окон. Если красное окно активно, программа выведет мерцающий символ «H» в левом верхнем углу экрана и выдаст черное окно после квитирования оператором красных окон. В черном окне выводится: для УКП — номер направления, наименование и адрес УКП, адрес неотработавшей функции и время автоматического повторного установления сеанса связи (АПУС) с УКП , или номер для КЩ. Черное окно должно обязательно квитироваться оператором клавишей F1. Эта же информация с временем регистрации события заносится в дисковый диспетчерский журнал. Адреса неответивших УКП хранятся системой в памяти ПЭВМ, а номера УКП и все последние принятые от них значения телеинформации отмечаются при отображении символом «*» в соответствующих окнах.

4.2. При успешной попытке связи с неответившим УКП или КЩ через время АПУС или при контрольном опросе его оператором на экран выдается сообщение в зеленом окне, если на экране в текущий момент не отображается хотя бы одно из красных или черных окон. Если красное или черное окно активно, программа выдаст зеленое окно после квитирования оператором красных и черных окон. В зеленом окне выводится: для УКП — номер направления, наименование и адрес УКП, адрес успешно выполненной функции и время автоматического повторного установления сеанса связи с УКП , или номер для КЩ. Эта же информация с временем регистрации события заносится в дисковый диспетчерский журнал. Зеленое окно удаляется с экрана при нажатии оператором клавиши F1 или при регистрации программой аварийного события.

4.3. В процессе работы комплекса производится диагностирование оборудования УПУ телекомплекса и при обнаружении ошибок в журнал выводится сообщение «Направление N выведено из опроса(ошибка АБПУ-XX)» с указанием кода ошибки.

4.4. При обнаружении программой ошибок конфигурации телекомплекса в журнал выводится сообщение с указанием номера направления, адресов УКП и описанием обнаруженной ошибки:

УПУ принята квитанция от УКП, адрес которого не зарегистрирован в конфигурации телекомплекса;

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

УПУ принята квитанция от УКП, адрес которого не соответствует адресу УКП в инициированной функции (нарушение протокола обмена по каналу ТЧ).

4.5. При обнаружении программой ошибок в работе АМК или ПУ оператору выдается сообщение с описанием ошибки и программа выходит в ДОС.

Возможные вида ошибок:

Ошибка при приеме информации от АМК(XX);

От ПУ нет квитанции или АМК принимает с ошибкой;

У ПУ стабильная ошибка приема;

Адрес ПУ вопроса не равен адресу ПУ ответа;

Неопознанная информация от АМК (XXX);

Логическая ошибка последней команды ПЭВМ (X).

4.6. В процессе работы диагностируется оборудование обслуживаемых УПУ. В случае обнаружения ошибок УКП в журнал выводится сообщение .

Сообщения об ошибках УКПМ-2:

1) «Смещение нуля АЦП не в допуске»;

2) «Смещение эталона АЦП не в допуске»;

3) «Нет предварительного сброса при снятии байтов ТС»;

4) «Некорректная установка номера группы при снятии ТС».

Сообщения об ошибках УП-КП.М:

1) «Непрерывная сигнализация по n-ой группе ТС»;

2) «Обнаружена неисправность УП-КП.М при работе с ТС».

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

    Настоящий стандарт устанавливает требования к
содержанию и оформлению программного документа «Руководство
оператора», определённого ГОСТ 19.101-77. Структуру и оформление документа устанавливают в
соответствии с ГОСТ 19.105-78. 
Составление информационной части (аннотации и
содержания) является обязательным.

==================================

Скачать пример оформления

A.B.00001-01 34 01
(Руководство оператора)      

                   
       (пример — .pdf)

514 137 b Загрузить
A.B.00001-01 34 01
(Руководство оператора)      

                   
       (шаблон — .dot)

17 902 b Загрузить

На верх

==================================

Рекомендуемая структура программного документа (по ГОСТ 19.505-79. ЕСПД)

  • Лист утверждения
  • Титульный лист
  • Аннотация
  • Содержание
  • Основная часть
    • Назначение программы
      • Функциональное назначение программы
      • Эксплуатационное назначение программы
      • Состав функций
        • Функции (такой-то)
      • Функции (этакой)

    • Условия выполнения программы
      • Минимальный состав аппаратных средств
      • Минимальный состав программных средств
      • Требования к персоналу (пользователю)
    • Выполнение программы
      • Загрузка и запуск программы
      • Выполнение программы
        • Выполнение функции (такой-то)
        • Выполнение функции (этакой)
      • Завершение работы программы
    • Сообщения  оператору
      • Сообщение (такое-то)
      • Сообщение (этакое)
  • Приложения (необязательны)
  • Регистрация изменений

На верх

==================================

<Предыдущий>
<Содержание>

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

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

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

- Как писать руководство оператора по ГОСТ 19.505-79?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- Главное окно программы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- Окно Открыть

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

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

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

- Путь к текущему файлу

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

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

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

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

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

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

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

- Отметка стартовой позиции

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

- Смещение курсора вправо

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

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

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

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

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

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

- Выделение цветом фрагмента текста

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

- Удаление фрагмента текста

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

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

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

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

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

  1. нажатием клавиши Delete;
  2. нажатием сочетания клавиш Ctrl+X;
  3. нажатием клавиши BackSpace.
Выполнение функции редактирования текущего файла с применением буфера обмена операционной системы

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

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

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

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

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

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

- Пункт меню Копировать недоступен

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

или

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

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

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

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

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

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

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

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

- Ошибка при сохранении документа

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

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

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

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

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

Разработка руководства оператора ГОСТ

разработка руководства оператораРуководство оператора ГОСТ чаще всего рассматривается как документ, в котором указаны конкретные действия оператора. Основная задача оператора – в режиме «on-line» осуществлять обслуживание системы или программного обеспечения входящего в систему, поэтому руководство оператора частично объединяет в себе информацию, предназначенную для пользователя и администратора системы (программы).

Типовая структура руководства оператора регламентируется ГОСТ 19.505-79 и включает:
Назначение программы
Условия выполнения программы
Выполнение программы
Сообщения оператору

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

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

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

Если Вам нужно разработать и написать руководство оператора удовлетворяющего всем требованиям стандартов, то обратитесь к нам по телефону +7(499)755-74-33, электронной почте Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.

Понравилась статья? Поделить с друзьями:
  • Скипидарная мазь инструкция по применению при кашле у взрослых
  • Скипидарная мазь инструкция по применению при кашле у взрослых
  • Руководство по подводному плаванию
  • Руководство по подводному плаванию
  • Под чьим руководств