31 - ОПИСАНИЕ ПРИМЕНЕНИЯ по ГОСТ 19.502-78 (пример, образец)

Пример (образец) документа Описание применения по ГОСТ 19.502-78, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД).  Редакция от 01.02.2023.

Аннотация

Настоящий документ представляет собой Описание применения ПК «Интероперабельность».

Документ предназначен для персонала ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация», ответственного за эксплуатацию ПК «Интероперабельность» в части использования по назначению.

Документ разработан согласно ГОСТ 19.502-78, структура и оформление документа соответствуют ГОСТ 19.105-78, основные надписи титульной части - по ГОСТ 19.104-78, выполнен печатным способом согласно ГОСТ 19.106-78.

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

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

1.1 Назначение программы (31)

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

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

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

1.2 Возможности программы (31)

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

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

1.3 Основные характеристики программы (31)

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

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

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

1.4 Ограничения, накладываемые на область применения программы (31)

2 Условия применения (31)

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

Условия эксплуатации - соответствующие условиям эксплуатации 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 Требования к необходимым техническим средствам (31)

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

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

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

  • процессор 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 Требования к другим программам (31)

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

  • в результате модификации ПК «Интероперабельность» имеется возможность расширения номенклатуры внешних систем (добавления онлайновых сервисов);
  • ограничение - необходимость поддержки сервисами запросов в виде гиперссылок с параметрами заголовка (title) или адреса (URL) веб-страницы (REST API).

Цель дополнительного (обеспечивающего) комплекса задач - снижение трудоемкости применения методов поисковой оптимизации страниц сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» (решения задач основного комплекса).

2.4 Общие характеристики входной и выходной информации (31)

Шаблон (запроса):

Знак вопроса ? указывает на начало запроса, знак равенства = отделяет формальный параметр от фактического (строки запроса).

2.5 Требования и условия организационного, технического и технологического характера (31)

Запуск ПК «Интероперабельность» выполняется автоматически преобразованием загрузочного модуля средствами CMS Drupal в гипертекст, содержащий активные ссылки, переходы по которым обеспечивают оператору возможность выполнения функций программы, таких как:

3 Описание задачи (31)

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

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

3.1 Определения задачи (31)

Определение задач основного комплекса приведены ниже.

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

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

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

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

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

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

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

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

Получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (XHTML, SMIL, MathMLL и т.д.) с применением сервисов CSS Validation Service и Nu Html Checker (Markup Validation Service) необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения конструктивных характеристик страницы.

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

Устранение выявленых сервисами CSS Validation Service и Nu Html Checker ошибок и предупреждений обеспечит улучшение конструктивных и потребительских свойств страницы, таких как:

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

4 Входные и выходные данные (31)

4.1 Сведения о входных и выходных данных (31)

Структурные единицы входной информации:

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

5 Приложения (31)

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

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