Техническая документация

13 Аннотация [из п. 2 ГОСТ 19.402-78]

Аннотация

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

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

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

2.2 Описание выходных сообщений

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

• протокол и доменное имя сервиса, например https://yandex.ru;
• формальный параметр, например search/?text=.

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

Фактические параметры (запроса):

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

Шаблон запрос сервиса Яндекс.Поиск

Шаблон запрос сервиса Google

Шаблон запрос сервиса Be1.ru

Шаблон запроса сервиса PageSpeed Insights

Шаблон запроса сервиса CSS Validation Service

Шаблон запроса сервиса Nu Html Checker

3 Описание задачи

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

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

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

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

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

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