Перейти к основному содержимому

Шаблон Технического Задания

Используйте этот шаблон для создания всех новых ТЗ в проекте Magnet.


Метаданные

ПараметрЗначение
Дата созданияYYYY-MM-DD
Дата последнего измененияYYYY-MM-DD
Статус апрува✅ Одобрено / ⏳ На рассмотрении / ❌ Не требуется
Дата апруваYYYY-MM-DD (если одобрено)

Опишите, зачем нужна эта функциональность, какую проблему она решает.


2.1. Пользовательские сценарии

Опишите основные use cases.

2.2. Бизнес-логика

Опишите ключевые правила, расчеты, валидации.

2.3. UI/UX требования

Если применимо: макеты, wireframes, описание интерфейса.


3.1. Архитектура

Схема компонентов, модулей, взаимодействия между сервисами.

3.2. Описание технической реализации

Подробное описание, какая и где должна быть добавлена логика.


4. Проблемы и компромиссы

4.1. Известные ограничения

Технические или бизнес-ограничения, с которыми придется работать.

  1. Ограничение 1
    • Описание
    • Влияние на решение

4.2. Технический долг

Что придется сделать «не идеально» сейчас, чтобы уложиться в сроки.

  • Описание технического долга 1
  • План по устранению (когда, как)

4.3. Риски

Потенциальные проблемы и план их митигации.


5. Вопросы на дополнительное обсуждение

Неясные моменты, требующие уточнения перед началом разработки.

  • Вопрос 1: Описание вопроса

    • Кому адресовано: Имя/роль
  • Вопрос 2: Описание вопроса

    • Кому адресовано: Имя/роль

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

6.1. Этапы разработки

  • Этап 1: Проектирование архитектуры
  • Этап 2: Разработка backend API
  • Этап 3: Разработка frontend
  • Этап 4: Тестирование
  • Этап 5: Деплой

6.2. Критические зависимости

От каких других задач/команд зависит выполнение этого ТЗ.


8. Документация

Какая документация должна быть обновлена/создана.

  • API документация (Swagger)
  • Обновление README
  • Обновление Engineering docs
  • Инструкции для пользователей

9. Ссылки

Укажите ссылки на связанные документы, ТЗ, макеты и т. д.