Учебные материалы: Новый формат документации от Twilio

Мы с огромным энтузиазмом представляем новый формат документации от Twilio — наши Учебные материалы. Они предлагают пошаговые аннотированные руководства по примерам приложений Twilio и призваны проложить для вас четкий путь к внедрению в продакшен.

Для этих интерактивных туров мы попытались переосмыслить, какой может быть документация для разработчиков. Учебные материалы ориентированы на код и напоминают среду разработки (IDE), представляя примеры приложений Twilio в привычном контексте с использованием вашего любимого веб-фреймворка.

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

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

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

В Учебных материалах мы попытались перевернуть это соотношение текста и кода. Код не должен *иллюстрировать* повествование — код должен *быть* повествованием.

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

Написанные на тех веб-фреймворках, которые вы используете, мы постарались сделать каждый учебный материал нетривиальным и готовым к продакшену примером использования Twilio. В отличие от простых примеров на чистом языке программирования, мы ориентировались на фреймворки, которые, скорее всего, уже есть в вашем продакшене.

Вы можете узнать, как реализовать SMS- и MMS-уведомления в Django, Rails, Laravel, Express и ASP.NET MVC. Вы можете внедрить функцию «Звонок по клику» на Java с использованием сервлетов и Spring MVC. Всего доступно 109 учебных материалов для 19 различных сценариев использования Twilio Voice, SMS, Client и IP Messaging.

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

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

Учебные материалы созданы для решения этой задачи — они охватывают промежуточные и продвинутые сценарии использования Twilio с учетом сохранения данных и сложной конфигурации. Например, «Напоминания о встречах в Django» показывает, как использовать Celery для отправки напоминаний в нужное время. «Уведомления о времени прибытия в Rails» обновляет модели ActiveRecord для отображения изменения статуса заказа при доставке.

Цель Учебных материалов — помочь вам выйти за рамки начального успеха с Twilio и быстро внедрить нужное решение в продакшен.

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

Исходный код каждого учебного материала распространяется под лицензией MIT с открытым исходным кодом. Как и вспомогательные библиотеки Twilio, Учебные материалы доступны под лицензией MIT, что позволяет использовать их по вашему усмотрению.

21 разработчик вложил свои силы в создание Учебных материалов на протяжении полутора лет — мы искренне надеемся, что они будут полезны в вашей работе с Twilio. Попробуйте их уже сегодня и поделитесь своим мнением.

Несколько наших любимых примеров:

Будем рады услышать ваше мнение — напишите нам.