Пример (образец) документа Стадии разработки программы по ГОСТ 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
Ролевая (организационная) структура управления проектами может в значительной степени различаться в зависимости от их специфики, но в каждом проекте должны быть определены следующие роли:
Заказчик проекта по ГОСТ Р 54869-2011
Заказчик проекта — физическое или юридическое лицо, которое является владельцем результата проекта [из 4(1) ГОСТ Р 54869–2011]
Руководитель проекта по ГОСТ Р 54869-2011
Руководитель проекта — лицо, осуществляющее управление проектом и ответственное за результаты проекта [из 4(2) ГОСТ Р 54869–2011]
Куратор проекта по ГОСТ Р 54869-2011
Куратор проекта — лицо, ответственное за обеспечение проекта ресурсами и осуществляющее административную, финансовую и иную поддержку проекта [из 4(3) ГОСТ Р 54869–2011]
Команда проекта по ГОСТ Р 54869-2011
Команда проекта — совокупность лиц, групп и организаций, объединенных во временную организационную структуру для выполнения работ проекта [из 4(4) ГОСТ Р 54869–2011]
Схема, иллюстрирующая основные понятия проектного менеджмента и их взаимосвязь, приведена в приложении А [из 4(5) ГОСТ Р 54869–2011]
Документ разработан согласно ГОСТ 19.201-78, структура и оформление документа соответствуют ГОСТ 19.105-78, основные надписи титульной части - по ГОСТ 19.104-78, выполнен печатным способом согласно ГОСТ 19.106-78.
Основная часть документа содержит общие сведения о ПК «Интероперабельность», основание для проведения и назначение разработки, требования к ПК «Интероперабельность», программной документации на ПК «Интероперабельность», к технико-экономическим показателям, стадиям и этапам разработки, к порядку контроля и приемки ПК «Интероперабельность».
Разработка ПК «Интероперабельность» необходима для достижения целей проекта, таких как:
- повышение эффективности решения комплекса задач поисковой оптимизации сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» за счет снижения трудозатрат путем автоматизации деятельности вовлеченного персонала с применением механизмов формирования параметрических ссылок методом конкатенации;
- расширение информационной сферы комплекса задач путем подготовки предложений по дальнейшему его применению в информационных системах ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация».
Получение позиции ссылки на текущую страницу в результатах поиска информационно-поисковых систем (поисковых машин, сервисов) Яндекс.Поиск и Google требуется для выяснения причин снижения посещаемости страницы конечными пользователями.
Получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы с применением сервиса PageSpeed Insights необходимо для для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения потребительских свойств страницы.
Получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (XHTML, SMIL, MathMLL и т.д.) с применением сервисов CSS Validation Service и Nu Html Checker (Markup Validation Service) необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения конструктивных характеристик страницы.
Цель дополнительного (обеспечивающего) комплекса задач - снижение трудоемкости применения методов поисковой оптимизации страниц сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» (решения задач основного комплекса).
Оптимизация трудозатрат при решении задач дополнительного комплекса - снижение трудоемкости решения основного комплекса задач (задач поисковой оптимизации).
Область применения программы или программного изделия:
- пользователи (операторы) ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация»;
- производственные задания - комплекс задач поисковой оптимизации страниц сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация»;
- технические средства (ТС) заказчика;
- программные средства (ПС) заказчика;
- программные средства внешних систем (онлайновых сервисов).
Отличительным свойством (характеристикой) объекта, в котором используют программу или программное изделие, является многократное выполнение ряда операций технологического цикла решения комплекса задач поисковой оптимизации.
Цикл технологической операции «как есть» безотносительно к рабочему месту оператора:
- оператор открывает вкладки - текущую страницу и 6 вкладок сервисов;
- переходит на вкладку текущей страницы;
- копирует заголовок текущей страницы в буфер обмена;
- переходит на вкладку сервиса Яндекс.Поиск;
- вставляет заголовок текущей страницы из буфера обмена в поле поиска Яндекс;
- нажимает кнопку Найти;
- дожидается ответа сервиса...
- переходит на вкладку Google;
- вставляет заголовок текущей страницы из буфера обмена в поле поиска Google;
- нажимает кнопку Поиск в Google;
- дожидается ответа сервиса...
- переходит на вкладку текущей страницы;
- копирует адрес текущей страницы в буфер обмена;
- переходит на вкладку сервиса Be1.ru;
- нажимает кнопку Получить текст по URL;
- вставляет адрес текущей страницы из буфера обмена в поле адреса;
- нажимает кнопку Загрузить;
- дожидается ответа сервиса...
- переходит на вкладку сервиса PageSpeed Insinghts;
- вставляет адрес текущей страницы из буфера обмена в поле адреса;
- нажимает кнопку Анализировать;
- дожидается ответа сервиса...
- переходит на вкладку сервиса CSS Validation Service;
- вставляет адрес текущей страницы из буфера обмена в поле адреса;
- нажимает кнопку Проверить;
- дожидается ответа сервиса...
- переходит на вкладку сервиса 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 Требуемое базовое программное обеспечение - соответствие требованиям к ПС серверной и клиентской частей.
Обоснование выбора критериев эффективности:
- снижение числа действий оператора внутри одного цикла технологической операции, выполняемых в ходе решения комплекса задач поисковой оптимизации, приведет к снижению времени цикла технологической операции (трудозатрат), повышению временной эффективности и эффективности ПК «Интероперабельность» в целом;
- оценочные элементы фактора «эффективность» характеризуют эффективность обеспечения информационной безопасности, эффективность применения и эффективность программного средства в целом.
Ориентировочная экономическая эффективность программы, выраженная в сокращении трудозатрат при решении основного комплекса задач, должна составлять не менее 30 % на один цикл технологической операции.
Отдельные (неочевидные и не вытекающие из постановки задач) критерии качества:
- У0412 Отсутствие ненужных повторений - повторения регламентируются У0505;
- У0505 Соблюдение стандартов и правил изложения в документации;
- У0506 Оценка по числу ссылок вперед в тексте документов - применяются перекрестные ссылки на детализированные сведения;
- У0602 Наличие предметного указателя - может быть организован при необходимости;
- У0805 Возможность приостанова и повторного запуска работы без потерь информации - основной режим - режим ожидания действий оператора;
- У1101 Обеспечение удобства ввода данных - ввод данных оператором исключен, см. Г1401;
- Г1401 Передача информации для управления по параметрам.
Обоснование выбора критериев качества:
- У0412, У0505, У0506 и У0602 - обеспечение максимального удобства (снижение трудозатрат) в ходе освоения ПК «Интероперабельность»;
- У0805, У1101 и Г1401 - обеспечение снижения роли человеческого фактора при решении комплекса задач поисковой оптимизации.
Проведение научно-исследовательских работ обосновано, если в ходе дальнейших работ предполагается:
- расширение информационной сферы комплекса задач путем подготовки предложений по дальнейшему его применению в информационных системах ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация»;
- расширение номенклатуры функций.
Расширение номенклатуры функций добавлением сервисов, предоставляемых поисковыми системами, требует детальной проработки. Поисковые системы «антагонистичны» по отношению друг к другу и часто снижают присвоенное ими странице качество только из-за присутствия в ней «чужеродного» скриптового кода.
Научно-исследовательские работы в рамках данного проекта не проводятся, вместе с тем обязательно выполнение представленных ниже работ.
Входные данные, за исключением ответов сервисов, должны быть организованы в виде шаблонов запросов. Выходные данные должны быть организованы в виде фактических параметров запросов.
Шаблон (запроса):
- протокол и доменное имя сервиса, например
https://yandex.ru
; - формальный параметр, например
search/?text=
.
Знак вопроса ? указывает на начало запроса, знак равенства = отделяет формальный параметр от фактического (строки запроса).
Веб-страницы с ответами сервисов:
- на запросы поиска;
- на запросы анализа.
Структурные единицы входной информации:
- позиция ссылки на текущую страницу в результатах поиска (от сервисов Яндекс.Поиск и Google);
- академическая и классическая «тошнота» и «свет» от сервиса оценки плотности использования текста (ключевых слов контента) текущей страницы Be1.ru;
- данные о фактической скорости загрузки для компьютеров и мобильных устройств, рекомендации по оптимизации увеличения фактической скорости загрузки страницы для компьютеров и мобильных устройств от сервиса анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы PageSpeed Insights;
- сообщения об ошибках и предупреждениях (или их отсутствии) от сервиса проверки соответствия веб-страниц стандартам гипертекста Nu Html Checker;
- сообщения об ошибках и предупреждениях (или их отсутствии) от сервиса проверки соответствия веб-страниц стандартам гипертекста CSS Validation Service.
Определение структуры выходных данных:
Фактические параметры (запроса):
- текстовая строка заголовка (
title
) текущей страницы (для сервисов поиска); - текстовая строка адреса (
URL
) текущей страницы (для сервисов анализа).
Здесь должен быть предварительный выбор методов решения задач, который станет окончательным на стадии Технический проект, окончательный см. ниже.
Формирование строки запроса конкатенацией текстовой строки шаблона (запроса) и текстовой строки параметра (запроса).
К применению целесообразны:
Применение принципа открытости, ОСНОВНЫХ БЕСПЛАТНЫХ сервисов поиска и анализа, отсутствие необходимости проведения технического обслуживания значительно снижает:
- стоимость разработки ПК «Интероперабельность»;
- стоимость владения;
- издержки (стоимость) ЖЦ ПК «Интероперабельность» в целом.
Снижение стоимостных показателей обеспечивает экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.
Клиентская часть ТС:
- IBM-совместимая ПЭВМ класса (семейства) не ниже Реntium IV с доступом в Интернет;
- мышь и (или) иное устройство ввода позиций (планшет, тачпад и т.п.) в составе периферийного оборудования.
Серверная часть ТС:
- см. System requirements;
- оперативная память от 32 Мб (и выше).
Рекомендованные технические характеристики ТС клиентской части:
- процессор 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 адаптер.
Рекомендации по техническим характеристикам ТС клиентской части направлены на:
- исключение из разработки устаревшей продукции;
- применение в разработке средств вычислительной техники, отвечающих современному уровню развития;
- повышение научно-технического уровня разработки в целом.
«Wir schaffen das» © Ангела Меркель
Принципиальная возможность решения поставленной задачи имеет место, если обеспечивается:
- поддержка формата текста PHP ПС серверной части;
- поддержка REST API онлайновыми сервисами поиска и анализа (проверки и валидации).
Переход к документу ТЕХНИЧЕСКОЕ ЗАДАНИЕ по ГОСТ 19.201-78.
Непосредственно к разделу - по ссылке в нижележащем топике.
Разработка технико-экономического обоснования разработки программы, если предусмотрено, см. NU.УЖОС.13666-13 91 (ТЭО) 01. В большинстве случаев разработка ТЭО целесообразна.
Варианты определения стадий разработки программы:
- скрыть нижележащий топик и оставить стадии по п. 2 ГОСТ 19.102-77;
- на основании п. 2 ГОСТ 19.102-77 определить в нижележащем топике собственные стадии и скрыть стандартные по п. 2 ГОСТ 19.102-77.
Собственные стадии разработки на основании п. 2 ГОСТ 19.102-77.
Стадии разработки, этапы и содержание работ из ГОСТ 19.102-77
Стадии разработки, этапы и содержание работ должны соответствовать указанным в таблице.
- Допускается исключать вторую стадию разработки, а в технически обоснованных случаях — вторую и третью стадии. Необходимость проведения этих стадий указывается в техническом задании;
- Допускается объединять, исключать этапы работ и (или) их содержание, а также вводить другие этапы работ по согласованию с заказчиком.
[из 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 заполнить нижележащий топик по образцу;
- при использовании собственного перечня документов скрыть нижележащий топик.
Примечания:
- Документ NU.УЖОС.13666-13 35 01 Описание языка не разрабатывается;
- Документ NU.УЖОС.13666-13 46 01 Руководство по техническому обслуживанию не разрабатывается.
- Должен быть разработан документ NU.УЖОС.13666-13 90(П4) 01 Описание постановки задачи.
- Должен быть разработан документ NU.УЖОС.13666-13 91(ТЭО) 01 Технико-экономическое обоснование.
- язык гипертекстовой разметки HTML, см. HTML 4.01 Specification;
- каскадные таблицы стилей CSS - формальный язык описания внешнего вида веб-документа, разработанного с применением языка разметки HTML (XHTML), см. CSS Snapshot 2018;
- встраиваемый язык программного доступа к объектам приложений JavaScript, см. ECMAScript Language Specification;
- язык разработки веб-приложений PHP, см. Официальный сайт PHP.
Согласование документа по Р 50-605-80-93
Официальное подтверждение заинтересованными сторонами согласия с разработанным документом и возможности его утверждения [из 1.4.73 Р 50–605–80–93]
Дата утверждения документов - такая-то.
Организация-заказчик - ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация».
- текстовая строка заголовка (title) текущей страницы;
- текстовая строка адреса (URL) текущей страницы.
- Запрос на Получение позиции ссылки на текущую страницу в результатах поиска информационно-поисковых систем (поисковых машин, сервисов) Яндекс.Поиск и Google требуется для выяснения причин снижения посещаемости страницы конечными пользователями.
- Запрос на Получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы с применением сервиса PageSpeed Insights необходимо для для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения потребительских свойств страницы.
- Запрос на Получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (XHTML, SMIL, MathMLL и т.д.) с применением сервисов CSS Validation Service и Nu Html Checker (Markup Validation Service) необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения конструктивных характеристик страницы.
Алгоритм выполнения процедуры загрузки и вызова программы (преобразования загрузочного модуля в гипертекст программными средствами CMS Drupal):
- автоматическое формирование параметра запроса;
- автоматическое формирование строки запроса;
- автоматизированная отправка запроса во внешнюю систему (в сервис поиска или анализа).
Разработка технико-экономического обоснования разработки программы, если предусмотрено, см. NU.УЖОС.13666-13 91 (ТЭО) 01. В большинстве случаев разработка ТЭО целесообразна.
Стандартные действия, заключающиеся в получении положительного заключения заказчика и иных заинтересованных сторон.
3.1.4 Определение семантики и синтаксиса языка (ГОСТ 19.102-77)
Не разрабатывается.
Структура программы иерархичная, упорядоченная по степени приоритетности решения задач основного комплекса в рамках цикла технологической операции, с возможностью регламентированного или произвольного доступа к функциям, таким как:
- запрос и получение позиции ссылки на текущую страницу сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» в результатах поиска Яндекс.Поиск и Google;
- запрос и получение сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru);
- запрос и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights);
- запрос и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (сервисы CSS Validation Service и Nu Html Checker).
В ходе программирования и отладки разработчики комментируют текст программы в среде разработки. Комментарии разработчиков могут быть внедрены в тексты программных документов под описаниями соответствующих функций программы и редактироваться совместно всеми заинтересованными участниками проекта.
Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77 выполняется в автоматизированном режиме всеми участниками проекта.
Согласно документу 51 - ПРОГРАММА И МЕТОДИКА ИСПЫТАНИЙ по ГОСТ 19.301-79.
В рамках настоящего руководства.
В рамках требований ГОСТ Р 54869-2011.
В рамках требований ГОСТ Р 54869-2011.
В рамках требований ГОСТ Р 54869-2011.
- Стадия ☠ Разработка ☠ Пример ☠ Образец