32 - РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА по ГОСТ 19.503-79 (пример, образец)

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

Аннотация

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

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

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

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

1 Общие сведения о программе (32)

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

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

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

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

1.2 Функции программы (32)

Функции программы:

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

1.3 Сведения о технических и программных средствах, обеспечивающих выполнение данной программы (32)

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

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

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

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

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

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

  • веб-сервер 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.

2 Структура программы (32)

2.1 Сведения о структуре программы (32)

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

2.2 Сведения о составных частях программы (32)

Составные части программы обеспечивают:

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

2.4 Сведения о связях с другими программами (32)

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

3 Настройка программы (32)

3.1 Описание действий по настройке программы на условия конкретного применения (32)

Описание действий по настройке программы на условия конкретного применения:

  • в режиме администрирования открывают страницу свойств функционального блока https://domain.com/admin/structure/block/manage/block/<номер>/configure
  • в текстовом поле Содержимое блока размещают исходный код программы;
  • в выпадающем списке Формат текста выбирают значение PHP code - ОБЯЗАТЕЛЬНОЕ ЗНАЧЕНИЕ!;

- Настройки функционального блока

  • в выпадающем списке настраивают (выбирают) регион Основное содержимое для размещения функционального блока - ОБЯЗАТЕЛЬНОЕ ЗНАЧЕНИЕ!;
  • прочие настройки выбирают на свое усмотрение;
  • на время отладки программы целесообразно настроить видимость (отображение) функционального блока только пользователю-администратору.

3.3 Выбор функций программы (32)

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

3.4 Поясняющие примеры (32)

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

- Символическая запись программы на исходном языке

Строки 34 - 38 содержат код вновь добавленной (не предусмотренной техническим заданием) функции проверки расширенных результатов schema.org.

- Проверка расширенных результатов schema.org

4 Проверка программы (32)

4.1 Описание способов проверки, позволяющих дать общее заключение о работоспособности программы (32)

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

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

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

- Входное сообщение сервиса Яндекс.Поиск

Проверку считают успешно завершенной, если строка поиска Яндекс идентична заголовку текущей страницы.

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

- Входное сообщение сервиса поиска Google

Проверку считают успешно завершенной, если строка поиска Google идентична заголовку текущей страницы.

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

- Ответ сервиса оценки плотности использования текста Be1.ru

Проверку считают успешно завершенной, если строка запроса содержит параметр, идентичный адресу текущей страницы.

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

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

Проверку считают успешно завершенной, если строка запроса содержит параметр, идентичный адресу текущей страницы.

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

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

Проверку считают успешно завершенной, если строка запроса содержит параметр, идентичный адресу текущей страницы.

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

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

Проверку считают успешно завершенной, если строка запроса содержит параметр, идентичный адресу текущей страницы.

6.2.4 Проверка запроса и получения позиции ссылки на текущую страницу сайта в результатах поиска Яндекс.Поиск (51)

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

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

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

- Входное сообщение сервиса Яндекс.Поиск

Проверку считают успешно завершенной, если строка поиска Яндекс идентична заголовку текущей страницы.

6.2.5 Проверка запроса и получения позиции ссылки на текущую страницу сайта в результатах поиска Google (51)

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

- Входное сообщение сервиса поиска Google

Проверку считают успешно завершенной, если строка поиска Google идентична заголовку текущей страницы.

6.2.6 Проверка запроса и получения сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru) (51)

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

- Ответ сервиса оценки плотности использования текста Be1.ru

Проверку считают успешно завершенной, если строка запроса содержит параметр, идентичный адресу текущей страницы.

6.2.7 Проверка запроса и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights) (51)

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

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

Проверку считают успешно завершенной, если строка запроса содержит параметр, идентичный адресу текущей страницы.

6.2.8 Проверка запроса и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG (сервис CSS Validation Service) (51)

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

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

Проверку считают успешно завершенной, если строка запроса содержит параметр, идентичный адресу текущей страницы.

6.2.9 Проверка запроса и получение результатов проверки соответствия текущей страницы стандартам HTML (сервис Nu Html Checker) (51)

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

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

Проверку считают успешно завершенной, если строка запроса содержит параметр, идентичный адресу текущей страницы.

5 Дополнительные возможности

Дополнительные возможности:

6 Сообщения системному программисту (32)

6.1 Тексты сообщений, выдаваемых в ходе настройки программы (32)

6.2 Тексты сообщений, выдаваемых в ходе проверки программы (32)

6.3 Тексты сообщений, выдаваемых в ходе выполнения программы (32)

7 Приложения (32)

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

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