Как составить техническое задание на интеграцию


  1. Открываем гугледок — шаблон по ссылке: https://goo.gl/zFudes
  2. Создаем копию
  3. Задаем необходимый заголовок и имя документа
  4. Через настройки доступа даем делаем документ видимым / редактируемым для других участников проекта
  5. Ссылка для общего доступа получается довольно длинной. Например: https://docs.google.com/document/d/1zgiDiCycGsluTHz8nTl722qar5t1aJdj74VS6tFivcM/edit?usp=sharing 
    Для удобства можно сократить ее с помощью сервиса: https://goo.gl. На выходе получится короткая удобная ссылка вида: https://goo.gl/zFudes
  6. Можно начать ТЗ с вводных слов: кратко описать задачу, общие тезисы. В водной части ТЗ можно также перечислить полезные ресурсы: ссылки на документацию по API, ссылки на примеры реализаций.
    Далее, разбивая подзаголовками на части или этапы пишем основную суть.
    Для наглядного изображения кода в ТЗ, кроме обязательного использования шрифта Courier New, рекомендуется использовать выделение кода светло-желтым (2) цветом.
         
    в случае большого и сложного кода, для лучшей наглядности, можно дополнительно использовать сервис подсветки синтаксиса. Например: http://highlight.hohli.com
      

Примеры ТЗ:

https://goo.gl/htPX3X

Вы можете скопировать шаблон и изменить его под свои нужды.
Если вам понравился материал, поделитесь с друзьями и коллегами.

Свежие статьи раз в неделю

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

Популярное в базе знаний:

Редполитика Email Soldiers

Редполитика Email Soldiers — это свод правил, которыми мы пользуемся, когда пишем статью в наш блог, пост в соцсети, рабочее письмо или любой другой материал от лица компании.

Наш робот бесплатно сообщит вам об ошибках доставки на mail.ru

Через наш сервис можно подписаться на уведомления из постмастера Mail.ru. ...

Правила дизайна и вёрстки email рассылок

Основные требования к дизайну и вёрстке email, чтобы письмо корректно отображалось в почтовых клиентах.

Что такое utm-метки и зачем они нужны

Простая, понятная и иллюстрированная инструкция по использованию utm-меток в ссылках. Зачем нужны, как проставлять, как пользоваться, какие лучшие практики

Анатомия емейл-маркетинга

Из чего же сделан наш емейл-маркетинг.

Подход Agile Results

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