81 - ПОЯСНИТЕЛЬНАЯ ЗАПИСКА по ГОСТ 19.404-79 (пример, образец)

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

Аннотация

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

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

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

1 Введение (81)

1.1 Наименование программы (81)

1.2 Условное обозначение темы разработки (81)

1.3 Документы, на основании которых ведется разработка (81)

1.4 Организация, утвердившая документы, дата утверждения (81)

2 Назначение и область применения (81)

2.1 Назначение программы (81)

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

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

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

2.2 Краткая характеристика области применения программы (81)

Область применения программы или программного изделия:

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

3 Технические характеристики (81)

3.2 Описание применяемых математических методов (81)

3.3 Описание допущений и ограничений, связанных с выбранным математическим материалом (81)

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

3.4 Описание алгоритма и (или) функционирования программы (81)

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

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

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

3.5 Обоснование выбора схемы алгоритма решения задачи (81)

Число операций одного цикла, выполняемых в ходе решения комплекса задач поисковой оптимизации «как должно быть»:

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

Запросы онлайновым сервисам выполняются оператором в 6 щелчков мышью (по числу сервисов) по пиктограммам, расположенным под заголовком текущей страницы.

Число операций одного цикла, выполняемых в ходе решения комплекса задач поисковой оптимизации «как есть»:

  • первоначальное открытие страниц - 7, из них одна текущая (открывается заново по завершении цикла) и 6 страниц сервисов (разовое открытие);
  • переходы на вкладки - 7;
  • копирование заголовка или адреса в буфер обмена - 2;
  • вставка заголовка или адреса из буфера обмена - 2 и 4 соответственно;
  • нажатие кнопок - 6.

Итого 7 + 7 + 2 + 2 + 4 + 6 = 28 операций в одном цикле. С учетом постоянно открытых окон сервисов - 22 операции в одном цикле.

3.6 Возможные взаимодействия программы с другими программами (81)

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

3.7 Описание и обоснование выбора метода организации входных и выходных данных (81)

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

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

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

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

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

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

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

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

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

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

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

3.8 Описание и обоснование выбора состава технических и программных средств (81)

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

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

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

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

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

4 Ожидаемые технико-экономические показатели (81)

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

5 Источники, использованные при разработке (81)

5.1 Перечень научно-технических публикаций, нормативно-технических документов и других научно-технических материалов, на которые есть ссылки в основном тексте (81)

  • ГОСТ 24.202-80 Система технической документации на АСУ. Требования к содержанию документа «Технико-экономическое обоснование создания АСУ».
  • ГОСТ Р 56087.2-2014 Система национальных стандартов в области качества услуг связи. Методика проведения опроса пользователей (в качестве общей методики проведения предпроектного обследования объектов ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация»);

6 Приложения (81)

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

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