СТАДИИ РАЗРАБОТКИ по ГОСТ 19.102-77 (пример, образец)

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

АННОТАЦИЯ

Настоящий документ - не просто трактовка общеизвестных требований ГОСТ 19.102-77, а разработанное на его основе руководство к действию. В руководстве представлены структурная декомпозиция и авторские образцы (примеры) содержания работ, выполняемых на этапах и стадиях разработки ПК «Интероперабельность» или любого иного программного комплекса (компонента).

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

  • либо импортирована отдельными задачами в Jira, Bitrix24 (стал платным, более не интересует), Redmine или иную систему управления проектной деятельностью с доступной REST API;
  • либо импортирована целиком (пакетно - 1, 2, 5, 10, 100, 1000, 10000 и более задач единовременно) при наличии в системе управления проектной деятельностью механизмов импорта (хотя бы из файла формата CSV).

4 Организация управления проектом ГОСТ Р 54869-2011

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

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

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

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

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

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

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

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

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

Область применения программы или программного изделия:

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

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

Цикл технологической операции «как есть» безотносительно к рабочему месту оператора:

  • оператор открывает вкладки - текущую страницу и 6 вкладок сервисов;
  • переходит на вкладку текущей страницы;
  • копирует заголовок текущей страницы в буфер обмена;

- Вкладка с текущей страницей

  • переходит на вкладку сервиса Яндекс.Поиск;
  • вставляет заголовок текущей страницы из буфера обмена в поле поиска Яндекс;

- Вкладка Yandex

  • нажимает кнопку Найти;
  • дожидается ответа сервиса...
  • переходит на вкладку Google;
  • вставляет заголовок текущей страницы из буфера обмена в поле поиска Google;

- Вкладка Google

  • нажимает кнопку Поиск в Google;
  • дожидается ответа сервиса...
  • переходит на вкладку текущей страницы;
  • копирует адрес текущей страницы в буфер обмена;
  • переходит на вкладку сервиса Be1.ru;

- Вкладка Be1.ru

  • нажимает кнопку Получить текст по URL;
  • вставляет адрес текущей страницы из буфера обмена в поле адреса;

- Окно загрузки текста сайта Be1.ru

  • нажимает кнопку Загрузить;
  • дожидается ответа сервиса...
  • переходит на вкладку сервиса PageSpeed Insinghts;

- Вкладка PageSpeed Insights

  • вставляет адрес текущей страницы из буфера обмена в поле адреса;
  • нажимает кнопку Анализировать;
  • дожидается ответа сервиса...
  • переходит на вкладку сервиса CSS Validation Service;

- Вкладка CSS Validation Service

  • вставляет адрес текущей страницы из буфера обмена в поле адреса;
  • нажимает кнопку Проверить;
  • дожидается ответа сервиса...
  • переходит на вкладку сервиса Nu HTML Checker;

- Вкладка Nu HTML Checker

  • вставляет адрес текущей страницы из буфера обмена в поле адреса;
  • нажимает кнопку Check;
  • дожидается ответа сервиса...

Число операций одного цикла, выполняемых в ходе решения комплекса задач поисковой оптимизации «как есть»:

  • первоначальное открытие страниц - 7, из них одна текущая (открывается заново по завершении цикла) и 6 страниц сервисов (разовое открытие);
  • переходы на вкладки - 7;
  • копирование заголовка или адреса в буфер обмена - 2;
  • вставка заголовка или адреса из буфера обмена - 2 и 4 соответственно;
  • нажатие кнопок - 6.

Итого 7 + 7 + 2 + 2 + 4 + 6 = 28 операций в одном цикле. С учетом постоянно открытых окон сервисов - 22 операции в одном цикле.

Количественные критерии эффективности (чем ниже их значения, тем выше эффективность):

  • число действий оператора внутри одного цикла технологической операции, выполняемых в ходе решения комплекса задач поисковой оптимизации;
  • время одного цикла технологической операции.

Оценочные элементы фактора «эффективность» согласно табл. 8 приложения 2 ГОСТ 28195-89 (экспертный или расчетный метод оценки):

  • Э0101 Проблемно-ориентированные функции - обеспечение соответствия эталонной модели интероперабельности;
  • Э0102 Машинно-ориентированные функции - обеспечение переносимости (исключение привязки к конкретным техническим средствам) применением языков высокого уровня;
  • Э0103 Функции ведения и управления - применение управляющих функций;
  • Э0104 Функции ввода/вывода - исключение ошибок оператора неиспользованием ввода/вывода данных с клавиатуры или из буфера обмена;
  • Э0105 Функции защиты и проверки данных - проверка путем визуального контроля (сопоставления);
  • Э0106 Функции защиты от несанкционированного доступа - применение матрицы доступа ПС серверной части;
  • Э0107 Функции контроля доступа - применение контроля доступа ПС серверной части;
  • Э0108 Функции защиты от внесения изменений - см. Э0104 и Э0107;
  • Э0109 Наличие соответствующих границ функциональных областей - ограничения;
  • Э0110 Число знаков после запятой в результатах вычислений - вычисления не предусмотрены;
  • Э0201 Время выполнения программ - Э0202 плюс Э0203;
  • Э0202 Время реакции и ответов - время реакции оператора плюс время ответа сервиса;
  • Э0203 Время подготовки - время генерации страницы ПС серверной части;
  • Э0205 Затраты времени на защиту данных - отсутствуют;
  • Э0206 Время компиляции - см. Э0203;
  • Э0301 Требуемый объем внутренней памяти - соответствие требованиям к ТС клиентской части;
  • Э0302 Требуемый объем внешней памяти - соответствие требованиям к ТС серверной части;
  • Э0303 Требуемые периферийные устройства - см. Э0301;
  • Э0304 Требуемое базовое программное обеспечение - соответствие требованиям к ПС серверной и клиентской частей.

Обоснование выбора критериев эффективности:

Отдельные (неочевидные и не вытекающие из постановки задач) критерии качества:

  • У0412 Отсутствие ненужных повторений - повторения регламентируются У0505;
  • У0505 Соблюдение стандартов и правил изложения в документации;
  • У0506 Оценка по числу ссылок вперед в тексте документов - применяются перекрестные ссылки на детализированные сведения;
  • У0602 Наличие предметного указателя - может быть организован при необходимости;
  • У0805 Возможность приостанова и повторного запуска работы без потерь информации - основной режим - режим ожидания действий оператора;
  • У1101 Обеспечение удобства ввода данных - ввод данных оператором исключен, см. Г1401;
  • Г1401 Передача информации для управления по параметрам.

Обоснование выбора критериев качества:

  • У0412, У0505, У0506 и У0602 - обеспечение максимального удобства (снижение трудозатрат) в ходе освоения ПК «Интероперабельность»;
  • У0805, У1101 и Г1401 - обеспечение снижения роли человеческого фактора при решении комплекса задач поисковой оптимизации.

Проведение научно-исследовательских работ обосновано, если в ходе дальнейших работ предполагается:

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

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

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

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

Структурные единицы входной информации:

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

Применение принципа открытости, ОСНОВНЫХ БЕСПЛАТНЫХ сервисов поиска и анализа, отсутствие необходимости проведения технического обслуживания значительно снижает:

Снижение стоимостных показателей обеспечивает экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.

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

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

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

Варианты определения стадий разработки программы:

  • скрыть нижележащий топик и оставить стадии по п. 2 ГОСТ 19.102-77;
  • на основании п. 2 ГОСТ 19.102-77 определить в нижележащем топике собственные стадии и скрыть стандартные по п. 2 ГОСТ 19.102-77.

Стадии разработки, этапы и содержание работ из ГОСТ 19.102-77

Стадии разработки, этапы и содержание работ должны соответствовать указанным в таблице.

Стадии разработки

Этапы работ

Содержание работ

1 Техническое задание

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

1.1.1 Постановка задачи
1.1.2 Сбор исходных материалов
1.1.3 Выбор и обоснование критериев эффективности и качества разрабатываемой программы
1.1.4 Обоснование необходимости проведения научно-исследовательских работ

1.2 Научно-исследовательские работы

1.2.1 Определение структуры входных и выходных данных
1.2.2 Предварительный выбор методов решения задач
1.2.3 Обоснование целесообразности применения ранее разработанных программ
1.2.4 Определение требований к техническим средствам
1.2.5 Обоснование принципиальной возможности решения поставленной задачи

1.3 Разработка и утверждение технического задания

1.3.1 Определение требований к программе
1.3.2 Разработка технико-экономического обоснования разработки программы
1.3.3 Определение стадий, этапов и сроков разработки программы и документации на нее
1.3.4 Выбор языков программирования
1.3.5 Определение необходимости проведения научно-исследовательских работ на последующих стадиях
1.3.6 Согласование и утверждение технического задания

2 Эскизный проект

2.1 Разработка эскизного проекта

2.1.1 Предварительная разработка структуры входных и выходных данных
2.1.2 Уточнение методов решения задачи
2.1.3 Разработка общего описания алгоритма решения задачи
2.1.4 Разработка технико-экономического обоснования

2.2 Утверждение эскизного проекта

2.2.1 Разработка пояснительной записки
2.2.2 Согласование и утверждение эскизного проекта

3 Технический проект

3.1 Разработка технического проекта

3.1.1 Уточнение структуры входных и выходных данных
3.1.2 Разработка алгоритма решения задачи
3.1.3 Определение формы представления входных и выходных данных
3.1.4 Определение семантики и синтаксиса языка
3.1.5 Разработка структуры программы
3.1.6 Окончательное определение конфигурации технических средств

3.2 Утверждение технического проекта

3.2.1 Разработка плана мероприятий по разработке и внедрению программ
3.2.2 Разработка пояснительной записки
3.2.3 Согласование и утверждение технического проекта

4 Рабочий проект

4.1 Разработка программы

4.1.1 Программирование и отладка программы

4.2 Разработка программной документации

4.2.1 Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77

4.3 Испытания программы

4.3.1 Разработка, согласование и утверждение программы и методики испытаний
4.3.2 Проведение предварительных государственных, межведомственных, приемо-сдаточных и других видов испытаний
4.3.3 Корректировка программы и программной документации по результатам испытаний

5 Внедрение

5.1 Подготовка и передача программы

5.1.1 Подготовка и передача программы и программной документации для сопровождения и (или) изготовления
5.1.2 Оформление и утверждение акта о передаче программы на сопровождение и (или) изготовление
5.1.3 Передача программы в фонд алгоритмов и программ

Примечания

  1. Допускается исключать вторую стадию разработки, а в технически обоснованных случаях — вторую и третью стадии. Необходимость проведения этих стадий указывается в техническом задании;
  2. Допускается объединять, исключать этапы работ и (или) их содержание, а также вводить другие этапы работ по согласованию с заказчиком.

[из 2 ГОСТ 19.102—77]

Варианты определения этапов разработки программы:

  • скрыть нижележащий топик, оставить этапы и разрабатываемые документы по п. 2.5 ГОСТ 19.101-77;
  • на основании п. 2.5 ГОСТ 19.102-77 определить в нижележащем топике собственные этапы и разрабатываемые документы и скрыть стандартные по п. 2.5 ГОСТ 19.102-77.

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

Код вида документа

Вид документа

Стадии разработки

Эскизный проект

Технический проект

Рабочий проект

компонент

комплекс

Спецификация

- Кружок полузалитый

- Кружок залитый

05

Ведомость держателей подлинников

- Кружок

12

Текст программы

- Кружок залитый

- Кружок

13

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

- Кружок

- Кружок

20

Ведомость эксплуатационных документов

- Кружок

- Кружок

30

Формуляр

- Кружок

- Кружок

31

Описание применения

- Кружок

- Кружок

32

Руководство системного программиста

- Кружок

- Кружок

33

Руководство программиста

- Кружок

- Кружок

34

Руководство оператора

- Кружок

- Кружок

35

Описание языка

- Кружок

- Кружок

46

Руководство по техническому обслуживанию

- Кружок

- Кружок

51

Программа и методика испытаний

- Кружок

- Кружок

81

Пояснительная записка

- Кружок

- Кружок

90—99

Прочие документы

- Кружок

- Кружок

- Кружок

- Кружок

Условные обозначения:

- Кружок залитыйдокумент обязательный;

- Кружок полузалитый — документ обязательный для компонентов, имеющих самостоятельное применение;

- Кружок — необходимость составления документа определяется на этапе разработки и утверждения технического задания;

— документ не составляют.

[из 2.5 ГОСТ 19.101—77]

Варианты определения перечня документов:

  • при использовании перечня документов по п. 2.5 ГОСТ 19.101-77 заполнить нижележащий топик по образцу;
  • при использовании собственного перечня документов скрыть нижележащий топик.

Примечания:

  1. Документ NU.УЖОС.13666-13 35 01 Описание языка не разрабатывается;
  2. Документ NU.УЖОС.13666-13 46 01 Руководство по техническому обслуживанию не разрабатывается.
  3. Должен быть разработан документ NU.УЖОС.13666-13 90(П4) 01 Описание постановки задачи.
  4. Должен быть разработан документ NU.УЖОС.13666-13 91(ТЭО) 01 Технико-экономическое обоснование.
  • язык гипертекстовой разметки HTML, см. HTML 4.01 Specification;
  • каскадные таблицы стилей CSS - формальный язык описания внешнего вида веб-документа, разработанного с применением языка разметки HTML (XHTML), см. CSS Snapshot 2018;
  • встраиваемый язык программного доступа к объектам приложений JavaScript, см. ECMAScript Language Specification;
  • язык разработки веб-приложений PHP, см. Официальный сайт PHP.
  • Запрос на Получение сведений о плотности использования текста (ключевых слов контента) текущей страницы с применением сервиса Be1.ru необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения присущего или присвоенного странице качества.
  • Запрос на Получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы с применением сервиса PageSpeed Insights необходимо для для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения потребительских свойств страницы.

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

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

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

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

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

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

Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77 выполняется в автоматизированном режиме всеми участниками проекта.