Описание программы это что

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

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

1. Общие сведения
1.1. Обозначение и наименование программы
1.2. Программное обеспечение, необходимое для функционирования программы
1.3. Языки программирования, на которых написана программа
2. Функциональное назначение
3. Описание логической структуры
3.1. Алгоритм программы
3.2. Используемые методы
3.3. Структура программы с описанием функций составных частей и связи между ними
3.4. Связи программы с другими программами
4. Используемые технические средства
5. Вызов и загрузка
5.1. Способ вызова программы с соответствующего носителя данных
5.2. Входные точки в программу
6. Входные данные
6.1. Характер, организация и предварительная подготовка входных данных
6.2. Формат, описание и способ кодирования входных данных

F.LUX — ЛУЧШАЯ ПРОГРАММА ДЛЯ СОХРАНЕНИЯ ГЛАЗ!ОБЗОР ПРОГРАММ!

7. Выходные данные
7.1. Характер и организация выходных данных
7.2. Формат, описание и способ кодирования выходных данных

Примечание

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

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

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

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

Описание программы (гост 19.402-78)

Этот стандарт ориентирован на документирование результирующего продукта разработки.

Строго говоря, существуют два разных документа, имеющих, правда, много общего. Это ОБЩЕЕ ОПИСАНИЕ (ГОСТ 19.502-78) и ОПИСАНИЕ ПРОГРАММЫ (ГОСТ 19.402-78). Однако, в силу того, что реально создать качественно и тот, и другой, не прибегая к почти полному дублированию, выдирая куски, весьма сложно, было бы достаточно реализовать один, более общий, «гибридный» документ. Назовем его «Описанием программы».

На самом деле «Описание программы» в своей содержательной части может дополняться разделами и пунктами, взятыми и из стандартов для других описательных документов и руководств: ГОСТ 19.404-79 ЕСПД. Пояснительная записка, ГОСТ 19.503-79 ЕСПД. Руководство системного программиста, ГОСТ 19.504-79 ЕСПД. Руководство программиста, ГОСТ 19.505-79 ЕСПД. Руководство оператора и т.п.

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

Основная часть документа должна состоять из вводной части и следующих разделов: функциональное назначение; описание логики. условия применения; состав и функции.

00 Краткое описание программы НаСтройке

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

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

Например: Программа «Автоматизированное рабочее место разработчика САУ» предназначена для … реализована на …. Программа поддерживает …

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

Например: Программа предназначена для решения задач … Программа представляет собой ядро автоматизированного рабочего места …

Пользователь имеет возможность …, осуществить …, запустить …, проанализировать …, получить результаты анализа и обработки …, построить … и т.п.

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

сведения о языке программирования; Например: Программа написана на языке …с использованием компилятора … описание входных и выходных данных для каждой из составных частей;

Например: ВХОДНЫЕ ДАННЫЕ. Входными данными для программы является текстовый файл, описывающий расширенную матрицу инциденций графа исследуемой системы.

ВЫХОДНЫЕ ДАННЫЕ. Выходными данными являются:

 выводимая на экран графическая и текстовая информация (результаты анализа системы);

 файлы в одном из графических форматов — копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);

 текстовые файлы — отчеты о проведенных исследованиях;

 диагностика состояния системы и сообщения о всех возникших ошибках.

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

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

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

Например: Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа «мышь». Для поддержки графического режима необходим адаптер EGA (VGA). Входные данные хранятся на флоппи- и/или жестком дисках. Программа работает под управлением ОС …

В приложение к описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.)

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

Вызова и загрузки системы

Например: Загрузка программы осуществляется набором в командной строке DOS имени загрузочного модуля – SBM80N.EXE с возможным указанием имени файла данных.

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

ГОСТ 19.402-78 Единая система программной документации. Описание программы

Текст ГОСТ 19.402-78 Единая система программной документации. Описание программы

Единая система программной документации

Unified system for program documentation. Program description.

Дата введения 1980-01-01

Постановлением Государственного комитета CCCР по стандартам от 18 декабря 1978 г. N 3350 дата введения установлена 01.01.80

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа «Описание программы», определенного ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 2092-80*.

* Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей. — .

(Измененная редакция, Изм. N 1).

2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным.

3. Описание программы должно содержать следующие разделы:

описание логической структуры;

используемые технические средства;

вызов и загрузка;

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

4. В разделе «Общие сведения» должны быть указаны:

обозначение и наименование программы;

программное обеспечение, необходимое для функционирования программы;

языки программирования, на которых написана программа.

5. В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.

6. В разделе «Описание логической структуры» должны быть указаны:

структура программы с описанием функций составных частей и связи между ними;

связи программы с другими программами.

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

3-6. (Измененная редакция, Изм. N 1).

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

8. В разделе «Вызов и загрузка» должны быть указаны:

способ вызова программы с соответствующего носителя данных;

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

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

9. В разделе «Входные данные» должны быть указаны:

характер, организация и предварительная подготовка входных данных;

формат, описание и способ кодирования входных данных.

10. В разделе «Выходные данные» должны быть указаны:

характер и организация выходных данных;

формат, описание и способ кодирования выходных данных.

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

7-12. (Введены дополнительно, Изм. N 1).

Электронный текст документа

Единая система программной документации:

Сборник национальных стандартов. —

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

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

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

13 — ОПИСАНИЕ ПРОГРАММЫ по ГОСТ 19.402-78

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

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

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

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

1 Общие сведения (13)

1.1 Обозначение и наименование программы (13)

Обозначение программы — NU.УЖОС.13666-13.

Полное наименование — «Программный комплекс взаимодействия с онлайновыми сервисами поиска и анализа веб-страниц».

Краткое наименование — ПК «Интероперабельность».

1.2 Программное обеспечение, необходимое для функционирования программы (13)

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

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

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

• веб-сервер Apache (рекомендуется), Nginx, Lighttpd или Microsoft IIS;
• СУБД MySQL 5.0.15 и выше, PostgreSQL 8.3 и выше или SQLite 3.x;
• PHP версии 5.2.4 и выше;
• поддержка текстового формата PHP на веб-страницах.

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

ПС внешних систем (онлайновые сервисы):

• сервисы Яндекс.Поиск и поиск Google;
• сервис анализа плотности использования текста (ключевых слов контента) текущей страницы Be1.ru;
• сервис анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы веб-страниц PageSpeed Insights;
• сервисы проверки соответствия веб-страниц стандартам гипертекста CSS Validation Service и Nu Html Checker.

1.3 Языки программирования, на которых написана программа (13)

• язык гипертекстовой разметки HTML, см. HTML 4.01 Specification;
• каскадные таблицы стилей CSS — формальный язык описания внешнего вида веб-документа, разработанного с применением языка разметки HTML (XHTML), см. CSS Snapshot 2018;
• встраиваемый язык программного доступа к объектам приложений JavaScript, см. ECMAScript Language Specification;
• язык разработки веб-приложений PHP, см. Официальный сайт PHP.

Э0102 Машинно-ориентированные функции — используются языки разметки и языки высокого уровня — определены.

2 Функциональное назначение (13)

2.1 Классы решаемых задач (13)

• задачи поиска;
• задачи анализа (проверки и валидации);
• задачи оптимизации трудозатрат при решении задач поиска и анализа.

2.2 Назначение программы (13)

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

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

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

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

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

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

2.3 Сведения о функциональных ограничениях на применение (13)

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

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

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

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

3 Описание логической структуры (13)

3.1 Алгоритм программы (13)

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

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

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

Э0103 Функции ведения и управления — см. управляющая функция — определены.

3.2 Используемые методы (13)

Здесь должен быть предварительный выбор методов решения задач, который станет окончательным на стадии Технический проект, окончательный см. ниже.

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

3.3 Структура программы (13)

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

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

3.4 Описание функций составных частей программы (13)

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

Автоматическая загрузка мнемознака (пиктограммы) для формирования графической гиперссылки запроса (13)

Тег или атрибут

альтернативный текст — пустое

путь к изображению

граница 2px справа

Автоматическое формирование параметра запроса — текстовой строки заголовка (title) текущей страницы (13)

Функция Drupal menu_get_object() возвращает тип текущего объекта. Если текущий объект является $node , то стандартная конструкция языка PHP print возвращает текстовую строку, содержащую заголовок текущего объекта (содержимое тега title страницы), например Серверная комната (аппаратная) по ГОСТ Р 58242-2018 .

Автоматическое формирование параметра запроса — текстовой строки адреса (URL) текущей страницы (13)

Функция Drupal drupal_get_path_alias() возвращает путь (алиас) текущего объекта (страницы). Стандартная конструкция языка PHP print возвращает текстовую строку, содержащую путь текущей страницы ( URL ), например https://tdocs.su/43471 .

Автоматическое формирование строки запроса сервисам поиска (13)

Конкатенация шаблона запроса сервиса поиска и текстовой строки заголовка ( title ) текущей страницы. Пример строки запроса сервису поиска изображен на рисунке .

https://yandex.ru/search/?text=Серверная комната (аппаратная) по ГОСТ Р 58242-2018

Автоматическое формирование строки запроса сервисам анализа (13)

Конкатенация шаблона запроса сервиса анализа и текстовой строки адреса ( URL ) текущей страницы. Пример строки запроса сервису Be1.ru изображен на рисунке .

Автоматическое формирование параметров окна отображения входной информации сервисов (13)

Тег или атрибут

отображение входной информации в новом всплывающем окне

возможно изменение размеров окна

возможно появление вертикальной полосы прокрутки

ширина и высота окна

отступ верхнего и левого края окна от поверхности визуализации

Автоматическое формирование параметров ссылки запроса (13)

Метод javascript window.open(strUrl, winName [, winParams]) открывает новое окно браузера со сформированными параметрами. strUrl формируется методом конкатенации:

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

3.5 Описание связей между составными частями программы (13)

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

3.6 Связи программы с другими программами (13)

Связи программы с другими программами:

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

4 Используемые технические средства (13)

4.1 Типы электронных вычислительных машин и устройств, которые используются при работе программы (13)

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

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

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

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