Пример (образец) документа Руководство оператора по ГОСТ 19.505-79, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД). Редакция от 01.02.2023.
Аннотация
Настоящий документ представляет собой Руководство оператора ПК «Интероперабельность».
Документ предназначен для персонала ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация», ответственного за эксплуатацию ПК «Интероперабельность» в части использования по назначению.
Документ разработан согласно ГОСТ 19.505-79, структура и оформление документа соответствуют ГОСТ 19.105-78, основные надписи титульной части - по ГОСТ 19.104-78, выполнен печатным способом согласно ГОСТ 19.106-78.
Основная часть документа содержит сведения о назначении, условиях выполнения, выполнении ПК «Интероперабельность» и сообщения оператору.
1 Назначение программы (34)
1.1 Сведения о назначении программы (34)
- автоматическое формирование запроса (ссылки), содержащего заголовок (title) текущей страницы в качестве фактического параметра;
- автоматизированная отправка запроса в онлайновые сервисы поиска;
- автоматическое формирование запроса (ссылки), содержащего адрес (URL) текущей страницы в качестве фактического параметра;
- автоматизированная отправка запроса в онлайновые сервисы анализа.
Э0101 Проблемно-ориентированные функции - автоматизация деятельности и управление, см. эталонная модель интероперабельности - определены.
Эксплуатационное назначение:
- производственная среда (офис) ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация»;
- отдел маркетинга;
- отдел разработки и поисковой оптимизации веб-контента;
- отдел веб-дизайна и программирования.
- отдел маркетинга
- отдел веб-дизайна и программирования
- отдел разработки и поисковой оптимизации веб-контента
Э0103 Функции ведения и управления - см. управляющая функция - определены.
1.2 Информация, достаточная для понимания функций программы и ее эксплуатации (34)
Функции ПК «Интероперабельность»:
- запрос и получение позиции ссылки на текущую страницу сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» в результатах поиска Яндекс.Поиск и Google;
- запрос и получение сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru);
- запрос и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights);
- запрос и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (сервисы CSS Validation Service и Nu Html Checker).
Получение позиции ссылки на текущую страницу в результатах поиска информационно-поисковых систем (поисковых машин, сервисов) Яндекс.Поиск и Google требуется для выяснения причин снижения посещаемости страницы конечными пользователями.
Получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы с применением сервиса PageSpeed Insights необходимо для для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения потребительских свойств страницы.
Получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (XHTML, SMIL, MathMLL и т.д.) с применением сервисов CSS Validation Service и Nu Html Checker (Markup Validation Service) необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения конструктивных характеристик страницы.
2 Условия выполнения программы (34)
2.1 Условия, необходимые для выполнения программы (34)
Условия эксплуатации - соответствующие условиям эксплуатации 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 Минимальный и (или) максимальный состав аппаратурных средств (34)
Клиентская часть ТС:
- IBM-совместимая ПЭВМ класса (семейства) не ниже Реntium IV с доступом в Интернет;
- мышь и (или) иное устройство ввода позиций (планшет, тачпад и т.п.) в составе периферийного оборудования.
Серверная часть ТС:
- см. System requirements;
- оперативная память от 32 Мб (и выше).
Э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 (4x16 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 Минимальный и (или) максимальный состав программных средств (34)
Клиентская часть ПС:
- операционная система с поддержкой программного обеспечения доступа в Интернет;
- браузер (за исключением консольных и Интернет Ехплорер версии ниже 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 Выполнение программы (34)
3.1 Последовательность действий оператора, обеспечивающих загрузку программы (34)
Гипертекст сформированной и открытой браузером страницы содержит запросы в виде гиперссылок с параметрами - заголовком (title
) и адресом (URL
) страницы. Запросы готовы к отправке ВСЕМ ЗАЯВЛЕННЫМ сервисам поиска и анализа путем перехода по данным гиперссылкам.
Э0104 Функции ввода/вывода (ручной ввод данных) исключены.
Гипертекст сформированной и открытой браузером страницы содержит запросы в виде гиперссылок с параметрами - заголовком (title
) и адресом (URL
) страницы. Запросы готовы к отправке ВСЕМ ЗАЯВЛЕННЫМ сервисам поиска и анализа путем перехода по данным гиперссылкам.
Какие-либо действия оператора в ходе загрузки, вызова и запуска ПК «Интероперабельность» не предусмотрены.
3.2 Последовательность действий оператора, обеспечивающих запуск программы (34)
Запуск ПК «Интероперабельность» выполняется автоматически преобразованием загрузочного модуля средствами CMS Drupal в гипертекст, содержащий активные ссылки, переходы по которым обеспечивают оператору возможность выполнения функций программы, таких как:
3.3 Выполнение программы (34)
Каждый из мнемознаков (пиктограмм), изображенных на рисунке , является зоной щелчка активной гиперссылки, с помощью которого обеспечивается возможность выполнения функций, таких как:
Э0106 Функции защиты от несанкционированного доступа обеспечиваются ПС серверной части (матрица доступа).
Э0107 Функции контроля доступа обеспечиваются ПС серверной части (контроль доступа).
3.4 Описание функций, формата и возможных вариантов команд управления выполнением программы (34)
Получение позиции ссылки на текущую страницу в результатах поиска информационно-поисковых систем (поисковых машин, сервисов) Яндекс.Поиск и Google требуется для выяснения причин снижения посещаемости страницы конечными пользователями.
Получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы с применением сервиса PageSpeed Insights необходимо для для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения потребительских свойств страницы.
Получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (XHTML, SMIL, MathMLL и т.д.) с применением сервисов CSS Validation Service и Nu Html Checker (Markup Validation Service) необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения конструктивных характеристик страницы.
3.5 Ответы программы (34)
3.5 Ответы программы (34) представлены входными сообщениями сервисов.
3.5.1 Входное сообщение сервиса Яндекс.Поиск (34)
3.5.1 Входное сообщение сервиса Яндекс.Поиск (34) изображено на рисунке .
3.5.2 Входное сообщение сервиса поиска Google (34)
3.5.2 Входное сообщение сервиса поиска Google (34) изображено на рисунке .
3.5.3 Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для мобильных устройств (34)
3.5.3 Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для мобильных устройств (34) изображено на рисунке .
3.5.4 Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для компьютеров (34)
3.5.4 Входное сообщение сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для компьютеров (34) изображено на рисунке .
3.5.5 Входное сообщение сервиса PageSpeed Insights (с рекомендациями) (34)
3.5.5 Входное сообщение сервиса PageSpeed Insights (с рекомендациями) (34) изображено на рисунке .
3.5.6 Входное сообщение сервиса валидации Nu Html Checker (без ошибок) (34)
3.5.6 Входное сообщение сервиса валидации Nu Html Checker (без ошибок) (34) изображено на рисунке .
3.5.7 Входное сообщение сервиса валидации Nu Html Checker (с ошибками и предупреждениями) (34)
3.5.7 Входное сообщение сервиса валидации Nu Html Checker (с ошибками и предупреждениями) (34) изображено на рисунке .
3.5.8 Входное сообщение сервиса валидации CSS Validation Service (без ошибок) (34)
3.5.8 Входное сообщение сервиса валидации CSS Validation Service (без ошибок) (34) изображено на рисунке .
3.5.9 Входное сообщение сервиса валидации CSS Validation Service (с предупреждениями) (34)
3.5.9 Входное сообщение сервиса валидации CSS Validation Service (с предупреждениями) (34) изображено на рисунке .
3.5.10 Входное сообщение сервиса оценки плотности использования текста Be1.ru (34)
3.5.10 Входное сообщение сервиса оценки плотности использования текста Be1.ru (34) изображено на рисунке .
3.6 Последовательность действий оператора, обеспечивающих завершение программы (34)
Закрытие текущей страницы в браузере.
4 Сообщения оператору (34)
5 Приложения (34)
Определения терминов, используемых в настоящем документе, приводятся в виде сносок, содержащих ссылки на первоисточник.
В гипертекстовом варианте настоящего документа вместо сносок отображаются гиперссылки, при этом определения терминов открываются во всплывающих окнах.
- Руководство ☠ Оператор ☠ Пример ☠ Образец