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

ГОСТ 19.505-79

Группа Т55

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Единая система программной документации

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

Требования к содержанию и оформлению

Unified system for program documentation. Operation’s guide. Requirements for contents and form of presentation

МКС 35.080     

Дата введения 1980-01-01

Постановлением Государственного комитета CCCР по стандартам от 12 января 1979 г. N 74 дата введения установлена 01.01.80

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство оператора», определенного ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 2096-80*.

(Измененная редакция, Изм. N 1).

 1. ОБЩИЕ ПОЛОЖЕНИЯ

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

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

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

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

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

выполнение программы;

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

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

(Измененная редакция, Изм. N 1).

 2. СОДЕРЖАНИЕ РАЗДЕЛОВ

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

2.2. В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).

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

2.2, 2.3. (Измененная редакция, Изм. N 1).

2.4. (Исключен, Изм. N 1).

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

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

(Измененная редакция, Изм. N 1).

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

(Введен дополнительно, Изм. N 1).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

…

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

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

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

или

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Код вида документа указывается в
его децимальном номере, например:

42333253.00037-01 34 01
(руководство оператора).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-общие сведения о
программе;

-структура
программы;

-настройка;

-проверка;

-дополнительные
возможности;

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

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

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

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

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

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

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

---

ГОСТ 19.505-79 по написанию руководства оператора был принят 12 января 1979 года Государственным комитетом стандартов Совета Министров СССР . В данной документации изложены требования к текстовому наполнению и формам подачи Руководства.

Главные условия

1.      Построение и форма написания документов выполняются согласно ГОСТ 19.105-78. В данном пункте краткое представления содержание обязательно.

2.      Основные разделы Руководства оператора:

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

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

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

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

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

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

• Просмотр(активная вкладка)
• 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 изображено на рисунке .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

См. выше.

5 Приложения

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

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

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