На Горох

Техническое задание на рефакторинг программного кода

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

  • 12 разделов в структуре
  • Word готовый файл для скачивания
Гарантия уникальности Поддержка 24/7
Как создана эта работа

Не одна нейросеть, а команда ИИ‑агентов

Техническое задание собирает мультиагентный конвейер из 6 ролей. Каждая отвечает за свой этап — от постановки цели до вёрстки файла — и работает с результатом предыдущей. Так получается цельная работа, а не набор ответов чат‑бота.

Оплатить 350 руб. 235 руб.
Паспорт работы

Цель, объём и требования

Эти поля агент‑аналитик формирует до написания текста — по ним строится вся работа.

Цель технического задания

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

Объём работ

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

Функциональные требования

FR-1: Оптимизация базы данных

Провести оптимизацию SQL запросов для снижения времени отклика системы.

Высокий
FR-2: Рефакторинг модуля аутентификации

Улучшить логику аутентификации пользователей для повышения безопасности системы.

Высокий
FR-3: Удаление дублирующегося кода

Выявить и удалить дублирующийся код в ключевых модулях системы.

Средний
FR-4: Улучшение логики обработки ошибок

Реализовать более информативную и структурированную обработку ошибок.

Средний
FR-5: Документирование кода

Добавить комментарии и документацию к ключевым функциям и классам.

Средний
FR-6: Рефакторинг модуля отчётности

Упростить и сделать более понятным модуль формирования отчётов. Повысить скорость.

Низкий
FR-7: Пересмотр структуры хранения данных

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

Низкий

Нефункциональные требования

  1. Производительность: Время отклика системы не должно превышать 2 секунды.
  2. Доступность: Система должна быть доступна 99.9% времени.
  3. Безопасность: Код должен соответствовать стандартам OWASP.
  4. Масштабируемость: Система должна выдерживать увеличение нагрузки в 2 раза.
  5. Поддержка: Код должен быть легко поддерживаемым и адаптируемым.
  6. Читаемость: Код должен соответствовать общепринятым стандартам кодирования.
  7. Тестируемость: Необходимо обеспечить возможность проведения автоматизированного тестирования.

Критерии приёмки

  1. Все функциональные требования реализованы -> Обеспечен запуск и корректная работа функций.
  2. Время отклика системы не превышает 2 секунды -> Подтверждено нагрузочным тестированием.
  3. Код соответствует стандартам кодирования -> Проверено автоматическим анализатором кода.
  4. Уровень покрытия кода тестами не менее 80% -> Подтверждено инструментами покрытия кода.

Результаты и артефакты

  1. Рефакторинговый код
  2. Документация по внесенным изменениям
  3. Отчет о проведенном рефакторинге
  4. Скрипты автоматизированного тестирования
  5. Результаты нагрузочного тестирования

Вехи проекта

Анализ кода и планирование

Завершён анализ текущего кода и составлен план рефакторинга.

Срок: 2024-03-15
Рефакторинг основных модулей

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

Срок: 2024-04-15
Тестирование и отладка

Проведено тестирование и отладка рефакторингового кода.

Срок: 2024-05-01
Документирование и сдача проекта

Подготовлена документация и проект сдан заказчику.

Срок: 2024-05-15

Временная шкала

Предполагаемое время реализации – 3 месяца. Ключевые этапы: анализ, рефакторинг, тестирование и документирование.

Бюджет

Оценочный бюджет: 800 000 – 1 200 000 рублей.

Ограничения и допущения

  1. Ограниченный бюджет проекта.
  2. Необходимость обеспечения непрерывной работы системы в процессе рефакторинга.
  3. Использование существующей инфраструктуры.
  4. Ограниченный срок реализации проекта.

Основные риски

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

Заинтересованные стороны

Руководитель школы

Утверждение ТЗ и контроль выполнения проекта.

Заместитель директора по ИТ

Координация работы команды и предоставление доступа к системе.

Руководитель отдела разработки

Организация и контроль процесса рефакторинга.

Преподаватели

Тестирование системы и предоставление обратной связи.

Роли в реализации ТЗ

Технический лидер

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

Разработчик

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

Тестировщик

Проводит тестирование рефакторингового кода, выявляет и регистрирует дефекты. Участвует в разработке тестовой документации и сценариев.

Системный аналитик

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

Интерфейсы и интеграции

Интеграция с используемой СУБД (PostgreSQL), системой управления обучением (Moodle) и сервисом аутентификации (LDAP).

Безопасность и защита данных

Код должен соответствовать требованиям безопасности OWASP. Данные пользователей должны быть зашифрованы и защищены от несанкционированного доступа.

Тестирование и валидация

Тестирование включает в себя модульное тестирование, интеграционное тестирование и системное тестирование. Приемка осуществляется заместителем директора по ИТ и руководителем отдела разработки.

Поддержка и сопровождение

Гарантийный период 3 месяца после сдачи проекта. SLA: исправление критических ошибок в течение 24 часов.

Необходимые ресурсы

Необходима команда разработчиков (2 человека), тестировщик (1 человек) и инфраструктура для разработки и тестирования.

Наименование компании

Техническое задание на рефакторинг программного кода

Выполнил: ФИО

Содержание

  • Введение 1
  • Обзор существующей системы 2
  • Цели и задачи рефакторинга 3
  • Функциональные требования 4
  • Нефункциональные требования 5
  • Архитектура и дизайн 6
  • План реализации 7
  • Тестирование и контроль качества 8
  • Развертывание и внедрение 9
  • Поддержка и сопровождение 10
  • Риски и смягчающие меры 11
  • Список литературы 12

Введение

Содержимое раздела

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

Обзор существующей системы

Содержимое раздела

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

Цели и задачи рефакторинга

Содержимое раздела

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

Функциональные требования

Содержимое раздела

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

Нефункциональные требования

Содержимое раздела

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

Архитектура и дизайн

Содержимое раздела

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

План реализации

Содержимое раздела

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

Тестирование и контроль качества

Содержимое раздела

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

Развертывание и внедрение

Содержимое раздела

Описание процесса развертывания рефакторингового кода в производственной среде. Определение шагов по минимизации рисков и обеспечению непрерывной работы системы.

Поддержка и сопровождение

Содержимое раздела

Описание условий поддержки и сопровождения системы после рефакторинга, включая гарантийный период, SLA и порядок обработки обращений. Планирование регулярных обновлений и улучшений.

Риски и смягчающие меры

Содержимое раздела

Идентификация потенциальных рисков, связанных с проектом рефакторинга, и разработка мер по их снижению. Анализ вероятности возникновения рисков и их влияния на проект.

Список литературы

Содержимое раздела

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

Получи Такое техническое задание

Готовый файл Word
Практическая ценность
Точные формулировки
Соответствие стандартам
Учет сроков
Минимизация ошибок
Контроль качества

Создать Техническое задание на любую тему за 5 минут

Создать

#2446086

Готовим вашу копию…
Похожие работы

Другие работы в разделе «Техническое задание»

Все работы раздела