Описание

Описание (П) [из п. 5 табл. 1 ГОСТ 34.201-89]

Пояснение назначения системы, ее частей, принципов их действия и условий применения [из п. 5 табл. 1 ГОСТ 34.201-89]

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

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

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

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

ГОСТ 19.503-79 Единая система программной документации. Руководство системного программиста. Требования к содержанию и оформлению

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

Применяется метод сравнения. Схема оценки - визуальный контроль.

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

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

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

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

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

С текущей (открытой) страницы отправляют запрос сервису 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 (без ошибок)

ГОСТ 19.503-79 Единая система программной документации. Руководство системного программиста. Требования к содержанию и оформлению

5.1 Описание дополнительных функциональных возможностей программы

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

ГОСТ 19.503-79 Единая система программной документации. Руководство системного программиста. Требования к содержанию и оформлению

5.2 Описание способов выбора дополнительных функциональных возможностей программы

См. выше.

ГОСТ 19.503-79 Единая система программной документации. Руководство системного программиста. Требования к содержанию и оформлению

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

::
3.1 Определения задачи
3.2 Методы решения задачи

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

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

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

ГОСТ 19.502-78 Единая система программной документации. Описание применения. Требования к содержанию и оформлению

31 - Описание применения ГОСТ 19.502-78

31 Аннотация

Аннотация

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

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

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

ГОСТ 19.502-78 Единая система программной документации. Описание применения. Требования к содержанию и оформлению

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

Формирование строки запроса конкатенацией текстовой строки шаблона (запроса) и текстовой строки параметра (запроса).

ГОСТ 19.404-79 Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению

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

шаблон и параметр запроса - только строковые значения.

ГОСТ 19.404-79 Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению

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

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

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

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

ГОСТ 19.404-79 Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению

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

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

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

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

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

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

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

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

ГОСТ 19.404-79 Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению

Страницы

Copyright © «Техническая документация» 2008-2021. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.