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

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

Аннотация

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

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

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

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

1 Общие сведения (13)

1.1 Обозначение и наименование программы (13)

1.2 Программное обеспечение, необходимое для функционирования программы (13)

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

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

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

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

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

1.3 Языки программирования, на которых написана программа (13)

  • язык гипертекстовой разметки HTML, см. HTML 4.01 Specification;
  • каскадные таблицы стилей CSS - формальный язык описания внешнего вида веб-документа, разработанного с применением языка разметки HTML (XHTML), см. CSS Snapshot 2018;
  • встраиваемый язык программного доступа к объектам приложений JavaScript, см. ECMAScript Language Specification;
  • язык разработки веб-приложений PHP, см. Официальный сайт PHP.

2 Функциональное назначение (13)

2.2 Назначение программы (13)

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

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

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

2.3 Сведения о функциональных ограничениях на применение (13)

Ограничения, накладываемые на область применения ПК «Интероперабельность»:

  • несоответствие условиям эксплуатации технических средств клиентской части;

3 Описание логической структуры (13)

3.1 Алгоритм программы (13)

Алгоритм выполнения процедуры загрузки и вызова программы (преобразования загрузочного модуля в гипертекст программными средствами CMS Drupal):

  • автоматическое формирование параметра запроса;
  • автоматическое формирование строки запроса;
  • автоматизированная отправка запроса во внешнюю систему (в сервис поиска или анализа).

- Общий алгоритм (диаграмма последовательности)

3.2 Используемые методы (13)

3.3 Структура программы (13)

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

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

3.4 Описание функций составных частей программы (13)

Обеспечиваются:

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

Автоматическое формирование параметра запроса - текстовой строки заголовка (title) текущей страницы (13)

- Строка формирования параметра заголовка (title) текущей страницы

Функция Drupal menu_get_object() возвращает тип текущего объекта. Если текущий объект является $node, то стандартная конструкция языка PHP print возвращает текстовую строку, содержащую заголовок текущего объекта (содержимое тега title страницы), например Серверная комната (аппаратная) по ГОСТ Р 58242-2018.

Автоматическое формирование параметра запроса - текстовой строки адреса (URL) текущей страницы (13)

- Строка формирования параметра пути (URL) текущей страницы

Функция Drupal drupal_get_path_alias() возвращает путь (алиас) текущего объекта (страницы). Стандартная конструкция языка PHP print возвращает текстовую строку, содержащую путь текущей страницы (URL), например https://tdocs.su/43471.

Автоматическое формирование строки запроса сервисам поиска (13)

Конкатенация шаблона запроса сервиса поиска и текстовой строки заголовка (title) текущей страницы. Пример строки запроса сервису поиска изображен на рисунке .

- Пример запроса сервису поиска

https://yandex.ru/search/?text=Серверная комната (аппаратная) по ГОСТ Р 58242-2018

Автоматическое формирование параметров окна отображения входной информации сервисов (13)

- Строка формирования параметров окна отображения входной информации

Тег или атрибут

Значение

_blank

отображение входной информации в новом всплывающем окне

toolbar=yes

разрешено отображение панели инструментов

status=no

запрещено отображение информации о состоянии

resizable=yes

возможно изменение размеров окна

scrollbars=yes

возможно появление вертикальной полосы прокрутки

width, height

ширина и высота окна

top, left

отступ верхнего и левого края окна от поверхности визуализации

Автоматическое формирование параметров ссылки запроса (13)

- Параметры ссылки запроса

Метод javascript window.open(strUrl, winName [, winParams]) открывает новое окно браузера со сформированными параметрами. strUrl формируется методом конкатенации:

  • для сервисов поиска - шаблона поискового запроса и текстовой строки адреса (URL) текущей страницы;
  • для сервисов анализа - шаблона анализа и текстовой строки адреса (URL) текущей страницы.

3.6 Связи программы с другими программами (13)

Связи программы с другими программами:

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

4 Используемые технические средства (13)

4.1 Типы электронных вычислительных машин и устройств, которые используются при работе программы (13)

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

  • процессор 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 адаптер.

Условия эксплуатации - соответствующие условиям эксплуатации 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].

5 Вызов и загрузка (13)

5.1 Способ вызова программы с соответствующего носителя данных (13)

Способ вызова программы с соответствующего носителя данных:

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

5.2 Входные точки в программу (13)

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

6 Входные данные (13)

Входные данные:

  1. Данные, введенные в систему обработки информации или в какую-то ее часть для сохранения или обработки [из 7.2.3 ГОСТ Р 52292-2004].
  2. Данные, поступающие в систему или в любую ее часть для хранения или обработки [из А.59 ГОСТ Р 56602-2015].

6.1 Характер входных данных (13)

Характер входных данных:

6.5 Описание входных данных (13)

Описание входных данных:

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

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

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

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

7 Выходные данные (13)

Выходные данные - Данные, которые система или какая-то ее часть передают из этой системы или части [из А.15 ГОСТ Р 56602-2015].

7.2 Организация выходных данных (13)

7.4 Описание выходных данных (13)

Описание выходных данных:

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

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

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

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

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

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

8 Приложения (13)

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

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