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

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

Аннотация

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

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

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

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

1 Назначение и условия применения программы (33)

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

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

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

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

1.2 Функции, выполняемые программой (33)

Функции, выполняемые программой:

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

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

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

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

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

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

Необходимый состав технических средств, его основные характеристики и условия эксплуатации приведены ниже.

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

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

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

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

1.3.3 Требования к программному обеспечению (33)

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

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

  • веб-сервер 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 Характеристика программы (33)

2.1 Описание основных характеристик и особенностей программы (33)

2.1.1 Временные характеристики (33)

Время готовности ПК «Интероперабельность» - сумма времени преобразования загрузочного модуля ПК «Интероперабельность» в гипертекст программными средствами серверной части и времени загрузки страницы агентом пользователя (браузером).

2.1.3 Средства контроля правильности выполнения и самовосстанавливаемости программы (33)

3 Обращение к программе (33)

3.1 Описание процедур вызова программы (33)

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

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

3.2 Способы передачи управления (33)

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

3.3 Способы передачи параметров данных (33)

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

4.1 Описание организации входной информации (33)

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

4.2 Описание организации выходной информации (33)

Выходная информация - информация, выдаваемая в другие системы (запросы).

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

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

5 Сообщения (33)

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

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

5.2 Описание содержания сообщений (33)

5.2.3 Содержание входного сообщения сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для мобильных устройств (33)

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

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

5.2.4 Содержание входного сообщения сервиса комплексной проверки основных Интернет-показателей PageSpeed Insights для компьютеров (33)

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

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

5.2.7 Содержание входного сообщения сервиса валидации Nu Html Checker (с ошибками и предупреждениями) (33)

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

- Входное сообщение сервиса валидации Nu Html Checker (с ошибками и предупреждениями)

5.2.10 Содержание входного сообщения сервиса оценки плотности использования текста Be1.ru (33)

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

- Входное сообщение сервиса оценки плотности использования текста Be1.ru

5.3 Описание действий, которые необходимо предпринять по сообщениям (33)

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

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

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

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

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

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

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