Разработка программного решения для генерации технических заданий к веб-приложениям (часть 1)

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

Аннотация: в статье выполняется реализация и тестирование программного обеспечения, автоматизирующего формирование документа технического задания к веб-приложениям. Используя каскадную методологию внедрения, ведется сбор функциональных и нефункциональных требований, предъявляемых к будущему софтверному продукту. Проводится моделирование и проектирование бизнес-процессов в моделях AS-IS и TO-BE с применением графических нотаций ARIS VACD и BPMN 2.0. Строится архитектура баз данных, нормализованная до 3НФ, а также карта бизнес-процессов. Этап проектирования завершается подготовкой схемы работы разрабатываемого приложения.
Ключевые слова: разработка технического задания, создание технического задания, техническое задание на разработку, техническое задание на разработку программы, техническое задание на разработку приложения, автоматизация разработки технического задания, разработка ТЗ, разработка ТЗ требования, задание на разработку ТЗ, ТЗ на разработку приложения, ТЗ разработка программы.
СкачатьPDF (статья), PDF (выпуск №25).

В условиях непрерывно развивающегося мира информационных технологий, где время имеет прямое влияние на исход проектов, оптимизация рабочих процессов выходит на первый план. Сфера веб-разработки не является исключением: здесь значимость быстрого и качественного составления технического задания на начальных этапах проекта играет решающую роль. Данный документ ограничивает содержание проекта и является основополагающим. Процесс его подготовки характеризуется высокой трудоемкостью и продолжительностью [1]. Современные организации придерживаются установленной схемы при составлении технического задания, показанной на рис. 1.1.

Процесс составления технического задания

Рис. 1.1. Процесс составления технического задания

Сегодня рынок цифровых технологий переживает значительный рост, однако, несмотря на это, количество программных решений, предназначенных для автоматизации написания технического задания (далее – ТЗ), остается довольно ограниченным. Проведя анализ ряда доступных программных решений в рамках процедуры «Software Selection» (выбор ИТ-продукта для внедрения) [2], был сделан вывод о необходимости разработки собственной системы, так как ни одно из них не покрывало значимую часть верхнеуровневых требований заказчика (табл. 1.1).

Табл. 1.1. Сравнительные характеристики программных решений
Программное решение Масштабируемость и гибкость Удобство использования Функциональность
1 Gagara-web.ru Да Нет Нет
2 TZ-online.site Нет Да Нет
3 Karfidov Lab Нет Да Нет

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

1. Фаза анализа

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

Табл. 1.2. Реестр требований
Требование Описание
1 Автоматизация процесса создания ТЗ Программное решение должно значительно уменьшить время, затрачиваемое на создание технических заданий.
2 Упрощение процесса ввода данных Программное решение должно упрощать процесс ввода данных о проекте, делая его интуитивно понятным.
3 Стандартизация документации Система должна способствовать стандартизации ТЗ, что улучшит их качество и облегчит последующее использование.
4 Гибкость и адаптивность системы Программное решение должно быть гибким и настраиваемым, чтобы удовлетворять различные потребности пользователей.
5 Поддержка многошагового процесса Система должна поддерживать поэтапное создание ТЗ с возможностью промежуточного сохранения и редактирования.
6 Сокращение затрат на подготовку ТЗ Система должна снижать затраты на подготовку ТЗ за счет автоматизации рутинных задач.
7 Повышение уровня безопасности данных Программное решение должно обеспечивать высокий уровень безопасности данных, предотвращая несанкционированный доступ.
8 Сокращение ошибок и улучшение контроля Решение должно уменьшать количество ошибок за счет встроенных механизмов проверки и валидации данных.
9 Обеспечение прозрачности процессов Система должна предоставлять прозрачность процессов создания и утверждения ТЗ, позволяя отслеживать все этапы работы.
10 Улучшение коммуникации Программное решение должно улучшать коммуникации между различными участниками проекта.
11 Обеспечение обратной связи Система должна поддерживать возможность получения обратной связи от пользователей для постоянного улучшения процессов.
12 Повышение удовлетворенности пользователей Программное решение должно быть удобным и эффективным в использовании, чтобы повышать удовлетворенность пользователей.
13 Форма ведения данных о проекте Пользователь программного решения должен иметь возможность вводить данные о проекте через интерактивную форму, включая цели, задачи и требования.
14 Тип технического задания Пользователь программного решения должен иметь возможность выбирать тип требуемого технического задания из предопределенного набора вариантов.
15 Генерация технического задания Пользователь решения должен иметь возможность автоматически генерировать техническое задание на основе введенных данных.
16 Экспорт данных Пользователь должен иметь возможность экспортировать сгенерированное техническое задание в формат PDF для последующего использования и редактирования.
17 Проверка незаполненных данных Пользователь программного решения должен иметь возможность определять незаполненные части брифа для корректного и полного заполнения всех необходимых полей перед генерацией технического задания.

2. Фаза проектирования

После идентификации требований необходимо преступить к проектированию решения. Для наглядного описания работы компании используются различные нотации, представленные набором графических объектов. Существует множество таких нотаций, наиболее популярными из которых являются ARIS VACD и BPMN 2.0, воспользуемся ими [4].

2.1. Описание ключевых бизнес-процессов в модели AS-IS

На рис. 2.1 рассмотрено верхнеуровневое описание бизнес-процесса «Сбор требований и написание технического задания» в модели AS-IS и нотации ARIS VACD.

Описание 1-го уровня процесса «Сбор требований и написание технического задания» в нотации ARIS VACD и модели AS-IS

Рис. 2.1. Описание 1-го уровня процесса «Сбор требований и написание технического задания» в нотации ARIS VACD и модели AS-IS

Ниже продемонстрированы результаты декомпозиции части процессов верхнего уровня с применением BPMN 2.0 (рис. 2.2-2.3).

Декомпозиция процесса «Запросить информацию у клиента» на 2-й уровень описания в нотации BPMN 2.0 и модели AS-IS

Рис. 2.2. Декомпозиция процесса «Запросить информацию у клиента» на 2-й уровень описания в нотации BPMN 2.0 и модели AS-IS

Декомпозиция процесса «Составить техническое задание» на 2-й уровень описания в нотации BPMN 2.0 и модели AS-IS

Рис. 2.3. Декомпозиция процесса «Составить техническое задание» на 2-й уровень описания в нотации BPMN 2.0 и модели AS-IS

2.2. Описание бизнес-процессов в модели TO-BE

Проведение моделирования AS-IS процессов позволило выявить «узкие места» ведения документов технического задания [5]. Модель TO-BE содержит улучшенные бизнес-процессы, автоматизируемые разрабатываемым программным обеспечением, и исключающие наличие выявленных в AS-IS недостатков. На рис. 2.4 дан обновленный процесс «Сбор требований и написание технического задания» в модели TO-BE с применением ARIS VACD, а ниже декомпозиция части его операций на нижестоящие уровни описания (рис. 2.5-2.6).

Описание 1-го уровня процесса «Сбор требований и написание технического задания» в нотации ARIS VACD и модели TO-BE

Рис. 2.4. Описание 1-го уровня процесса «Сбор требований и написание технического задания» в нотации ARIS VACD и модели TO-BE

Декомпозиция процесса «Сгенерировать техническое задание» на 2-й уровень описания в нотации BPMN 2.0 и модели TO-BE

Рис. 2.5. Декомпозиция процесса «Сгенерировать техническое задание» на 2-й уровень описания в нотации BPMN 2.0 и модели TO-BE

Декомпозиция процесса «Предварительно проверить созданное техническое задание» на 3-й уровень описания в нотации BPMN 2.0 и модели TO-BE

Рис. 2.6. Декомпозиция процесса «Предварительно проверить созданное техническое задание» на 3-й уровень описания в нотации BPMN 2.0 и модели TO-BE

2.3. Построение карты процессов

Для получения детального понимания работы и взаимодействия бизнес-процессов была построена карта бизнес-процессов. Карта процессов представляет собой графическое отображение последовательности выполняемых шагов процесса на различных уровнях описания [6]. В рамках данного исследования строились карты процессов для моделей AS-IS и TO-BE.

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

Карта бизнес-процессов в модели AS-IS

Рис. 2.7. Карта бизнес-процессов в модели AS-IS

Карта процессов в модели TO-BE иллюстрирует предполагаемые изменения и улучшения, которые будут внедрены для достижения целевого состояния. В TO-BE устранены найденные недостатки, сокращены избыточные шаги и добавлены новые операции, направленные на автоматизацию и повышение точности.

Карта бизнес-процессов в модели TO-BE

Рис. 2.8. Карта бизнес-процессов в модели TO-BE

Таким образом построенные карты процессов моделей AS-IS и TO-BE использовались в том числе для проведения анализа текущего состояния бизнес-процессов и предложения их обоснованных улучшений.

2.4. Структура баз данных в 3-й НФ

Руководствуясь методологией по управлению корпоративной архитектурой TOGAF, далее описывается структура базы данных, необходимая для автоматизации процесса составления технических заданий в веб-приложении [7]. Спроектированные таблицы баз данных приведены к третьей нормальной форме, что гарантирует минимизацию избыточности информации и предотвращение аномалий при вставке, обновлении и удалении данных. Табл. 2.1 содержит полученный результат нормализации данных, где символом «*» отмечены части составного ключевого идентификатора.

Табл. 2.1. Архитектура данных
Таблица Поле Тип данных Размерность
Шаблон технического задания Название* Сhar 50
Ссылка на шаблон File
Устройства создания ТЗ Название* Сhar 50
Техническое задание Название* Сhar 100
Ссылка на файл File
Дата создания* Timestamp
Менеджер по проектам Фамилия* Сhar 30
Имя* Сhar 30
Отчество* Сhar 30
Номер телефона* Integer 11
Почта Сhar 50
Город Название* Сhar 100
Часовой пояс* TimeZone
Клиент Фамилия* Сhar 50
Имя* Сhar 50
Отчество* Сhar 50
Номер телефона* Сhar 11
Почта Сhar 50

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

ER-диаграмма спроектированных таблиц данных

Рис. 2.9. ER-диаграмма спроектированных таблиц данных

2.5. Карта реализуемого приложения

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

  • главная страница, предназначенная для ввода административной информации, которая затем будет передаваться в заголовок шаблона технического задания и подставляться в соответствующие разделы документа;
  • при выборе типа технического задания «Разработка сайта с 0»:
    • страница ввода данных. Интерфейс страницы позволяет вводить необходимые данные, задавать параметры проекта и формировать начальное техническое задание;
    • экран сгенерированного технического задания, где пользователь может просмотреть, отредактировать и сохранить документ в удобном формате, а также удостовериться в полноте и точности подготовленного задания перед его утверждением и передачей в работу;
  • при выборе типа технического задания «Редизайн сайта»:
    • страница данных, на которой пользователь может вводить информацию о текущем состоянии сайта, а также требования и пожелания по его редизайну;
    • интерфейс сгенерированного технического задания. Здесь пользователь проверяет правильность и полноту информации, вносит необходимые корректировки и сохранят документ для дальнейшего использования.

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

Карта реализуемого программного решения

Рис. 2.10. Карта реализуемого программного решения

Литература

  1. A guide to the project management body of knowledge and the standard for project management, 7th edition. Project Management Institute, 2021. – 369 p.
  2. Гвоздева Т.В., Баллод Б.А. Проектирование информационных систем: учебное пособие. – Ростов н/Д.: Феникс, 2009. – 508 с.
  3. Степанов Д.Ю. Метод формирования ресурсного плана в проектах внедрения ERP-систем на основе бенчмаркинга и оценщика // Высокопроизводительные вычислительные системы и технологии. – 2022. – Т.4, № 1. – c.1-6. – URL: http://stepanovd.com/science/article/135-2022-1-resourceplan.
  4. Dmitry Yu. Stepanov. Novel planning technique for ERP-systems implementation projects // Communications in Computer and Information Science, Springer, Cham. 2022. vol. 1733, pp.115-124. https://doi.org/10.1007/978-3-031-23744-7_9. – URL: https://stepanovd.com/science/article/143-2022-2-planningtechnique.
  5. Катасонова Н.С. RICEFS-классификация разработок и настроек для оценки трудозатрат // Корпоративные информационные системы. – 2023. – №4 (24) – С. 26-37. – URL: https://corpinfosys.ru/archive/2023/issue-24/230-2023-24-ricefclassification.
  6. Хабр страница компании Аксеникс [Электронный ресурс] // Жизненный цикл проекта внедрения ERP-системы на примере коробочных SAP и 1С решений, а также кастомных разработок. Режим доступа: https://habr.com/ru/companies/axenix/articles/799333/ (дата обращения 31.03.2024).
  7. Бобровников А.Э. Введение в управление проектами внедрения ERP-систем. М.: 1С-Паблишинг, 2021. – 320 с.

Выходные данные статьи

Чабиев Э.Т. Разработка программного решения для генерации технических заданий к веб-приложениям (часть 1) // Корпоративные информационные системы. – 2024. – №1 (25) – с. 23-35. – URL: https://corpinfosys.ru/archive/2024/issue-25/287-2024-25-technicalspecification.

Программное решение для генерации технических заданий по разработке веб-приложений

Об авторе

Чабиев Эльсар Тимурович Чабиев Эльсар Тимурович – выпускник кафедры корпоративных информационных систем института информационных технологий РТУ МИРЭА. Тема выпускной квалификационной работы магистра «Программное решение для генерации технических заданий по разработке веб-приложений». Электронная почта для взаимодействия с автором: Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра..

Статьи выпуска №25

  1. Жизненный цикл корпоративных информационных систем (часть 2);
  2. Разработка приложения для генерации технических заданий (часть 1);
  3. Требования к программному обеспечению (часть 1);
  4. ФСБУ и ПБУ как база модуля «Бухгалтерский учет» в КИС предприятия;
  5. Формирование план-графика для проектов внедрения 1С и SAP (часть 1).