Описание применения программы пример

разработка техдокументации по ГОСТ без бумаги и расстояний

31 — ОПИСАНИЕ ПРИМЕНЕНИЯ по ГОСТ 19.502-78 (пример, образец)

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

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

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

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

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

🔥 ChatGPT: Подробный Разбор с Примерами || Смотреть Обязательно!

1 Назначение программы (31)

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

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

Э0101 Проблемно-ориентированные функции — автоматизация деятельности и управление, см. эталонная модель интероперабельности — определены.

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

• отдел маркетинга

• отдел веб-дизайна и программирования

• отдел разработки и поисковой оптимизации веб-контента

1.2 Возможности программы (31)

Возможности программы — снижение трудоемкости решения задач поисковой оптимизации (основного комплекса), таких как:

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

Сокращение трудозатрат при решении основного комплекса задач (выполнении функций по назначению) составляет 1 — (6 / 22) = 0,7272 или 72,72 % за один цикл технологической операции.

API для начинающих. Пример VK. [1/5]

1.3 Основные характеристики программы (31)

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

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

Э0104 Функции ввода/вывода (ручной ввод данных) исключены.

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

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

1.4 Ограничения, накладываемые на область применения программы (31)

Ограничения, накладываемые на область применения ПК «Интероперабельность»:

• несоответствие условиям эксплуатации технических средств клиентской части;

• поддержка формата текста PHP ПС серверной части;
• поддержка REST API онлайновыми сервисами поиска и анализа (проверки и валидации).

Э0109 Наличие соответствующих границ функциональных областей — ограничения определены.

2 Условия применения (31)

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

Условия эксплуатации — соответствующие условиям эксплуатации 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].

2.2 Требования к необходимым техническим средствам (31)

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

• IBM-совместимая ПЭВМкласса (семейства) не ниже Реntium IV с доступом в Интернет;
• мышь и (или) иное устройство ввода позиций (планшет, тачпад и т.п.) в составе периферийного оборудования.

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

• см. System requirements;
• оперативная память от 32 Мб (и выше).

Э0303 Требуемые периферийные устройства определены.

Э0302 Требуемый объем внешней памяти определен.

Э0301 Требуемый объем внутренней памяти определен.

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

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

2.3 Требования к другим программам (31)

Требования к другим программам:

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

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

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

Э0304 Требуемое базовое программное обеспечение определено.

2.4 Общие характеристики входной и выходной информации (31)

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

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

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

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

2.5 Требования и условия организационного, технического и технологического характера (31)

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

Последовательность («технологический маршрут») организации сбора и передачи в обработку входной информации сервисов Яндекс.Поиск и Google изображена на рисунке .

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

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

Последовательность организации сбора и передачи в обработку входной информации сервисов CSS Validation Service и Nu Html Checker изображена на рисунке .

3 Описание задачи (31)

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

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

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

3.1 Определения задачи (31)

Определение задач основного комплекса приведены ниже.

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

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

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

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

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

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

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

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

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

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

Позиция ссылки на страницу в результатах поиска зависит от синтаксической корректности страницы, соответствию ее стандартам W3C. Соответствие страницы стандартам гарантирует отсутствие в ее разметке (конструкции) незакрытых или дублированных элементов, неправильных или нерекомендованных (устаревших) атрибутов, наличие кодировки UTF-8 и указания типа документа. Синтаксически неправильно сконструированная страница значительно медленнее интерпретируется браузером, что снижает скорость (повышает время) ее загрузки и косвенно способствует снижению позиции в результатах поиска.

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

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

3.2 Методы решения задачи (31)

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

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

4.1 Сведения о входных и выходных данных (31)

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

Веб-страницы с ответами сервисов:

• на запросы поиска;
• на запросы анализа.

Источник: tdocs.su

Шаблон описания применения по ГОСТ 19

Требования к структуре описания применения по ГОСТ 19 устанавливаются ГОСТ 19.502. В общем случае документ должен состоять из следующих разделов:

1. Назначение программы
2. Условия применения
3. Описание задачи
4. Входные и выходные данные

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.

Примечание

Эти и другие требования к структуре и содержанию описания применения по ГОСТ 19 подробнее см. ГОСТ 19.502

Оформление документа

Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).

Источник: technicaldocs.ru

2.3. Описание применения. Требования к содержанию и оформлению

ГОСТ 19.101-77 определяет программный документ «Описание применения» как совокупность сведений о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях применения и минимальной конфигурации технических средств.

Согласно ГОСТ 19.502-78 документ должен содержать четыре составные части, которые уже упоминались выше. Титульная, информационная и часть регистрации изменений оформляются по общим правилам. Основная часть документа должна состоять из следующих разделов: назначение программы, условия применения, описание задачи (определения, метод и алгоритм решения ), входные и выходные данные, основные характеристики занимаемой памяти, пример использования.

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

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

В разделе «Описание задачи» приводятся постановка задачи и математическая модель, описывается метод решения задачи. При описании метода решения необходимо сформулировать определения используемых понятий. Метод решения описывается словами с использованием математических формул и рисунков, необходимых для объяснения сути задачи.

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

В разделе «Входные и выходные данные» необходимо перечислить каждый тип входных данных и кратко описать назначение каждого типа. Целесообразно привести схему, иллюстрирующую формат каждого типа данных, дать необходимые пояснения и примеры. Далее аналогично следует описать выходные данные, при этом указать все возможные виды и способы выдачи пользователю выходных данных.

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

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

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

В разделе «Пример использования» должно быть несколько конкретных тестовых примеров, на которых велась отладка программы. Если программа работает в диалоговом режиме, то в данном разделе должны быть приведены примеры возможных диалогов с соответствующими комментариями. Особое внимание при описании примеров должно быть уделено реакции программной системы на некорректные данные, на ошибки при ведении диалога, на предельные или экстремальные ситуации.

Источник: studfile.net