Техническое задание (или сокращенно ТЗ) - это полное описание работы с данными, на основании которого производится реализация необходимой задачи исполнителем.
ТЗ может содержать как общее описание необходимой задачи, так и более углубленное. Это зависит от договоренности с испольнителем, продуманности задачи и наличия знаний по возможной реализации.
Для примера рассмотрим ТЗ на создание формы подписки.
Изначально у нас есть доступ в личный кабинет Mailigen, знание, что у Mailigen есть API и макет (картинка) желаемой формы подписки.
- Для начала нужно форму подписки создать по макету, все отсупы, цвета, текст и поля уже заданы в изначальном макете, поэтому в этом примере не будет расписано создание формы.
- Далее, необходимо определить какая это будет форма подписки? Статичная или появляющаяся после просмотра страницы определенное количество времени? Будет ли она перекрывать страницу? Допустим, были приняты следующие решения:
- Форма подписки должна появляться после 20 секунд просмора страницы.
- Форма будет появляться как лайтбокс, то есть появляться поверх сайта, затемняя всю остальную область.
- После закрытия формы она не должна открываться еще раз 1 день.
- После подписки форма больше не должна появляться.
- Далее идет сама форма. Какие поля должны быть обязательными? Нужно ли производить проверку введенных данных? Есть ли скрытые поля с дополнительной информацией?
- Поле электронногоо адреса должно быть обязательно заполнено.
- Нельзя подписаться, пока не будет отмечено согласие с политикой конфиденциальности.
- Должна проводиться общая проверка правильности данных для электронных адресов.
- Скрытых полей нет.
- Что будет происходить с данными при нажатии кнопки «Подписаться»?
- Подписчика необходимо с помощью API передать в Maligen.
Итак, все решения приняты, теперь нужно оформить их в ТЗ:
- Форма должна появляться после 20 секунд нахождения на сайте как Лайтбокс, затеняя остальной сайт.
- При закрытии формы она больше не показывается в течение одного дня.
- При успешной подписке форма больше не показывается никогда.
- Для успешной подписки должно быть заполнено поле «Электронный адрес» и отмечена галочкой опция «Согласен с политикой конфиденциальности».
- При нажатии на кнопку «Подписаться» электронный адрес должен передаваться по API в Mailigen.
- Ключ API: ххх. (Более подробно о создании ключа API можно прочитать в статье «Как создать и использовать ключ API?»)
- Необходимый список: «Подписчики с сайта».
- Документация API: https://dev.mailigen.com/.
- При ошибке подписки ошибка должна сохраняться в логе, а подписчику выводиться сообщение: «При подписке произошла ошибка, попробуйте еще раз или обратитесь к нам в чат за помощью».
- При успешной подписке подписчику выводиться сообщение: «Спасибо за подписку!».
Заметьте, что технической части здесь почти нет, по большей части идет описание что и как должно происходить с формой.
Тем не менее, чем больше подробностей будет указано в ТЗ, тем меньше вероятность ошибки или нежелательного поведения в задаче.
