Как разработчики, мы знаем, что при создании отличного программного обеспечения в Интернете действуют две истины:
— Ответ где-то есть.
— Он нам нужен *прямо сейчас*.
Сегодня мы запускаем новый формат документации под названием Guides (Руководства), направленный именно на эти две истины. Guides — это легко усваиваемые инструкции для API Twilio, которые объясняют, как выполнять распространенные задачи с той скоростью, которую требует современный программист. Вместе с этим новым контентом вы также можете заметить некоторые обновления дизайна, призванные поставить код во главу угла в нашей документации.
Хотите отслеживать переписку между двумя телефонными номерами на Ruby? Или собирать DTMF-тона на PHP? Или подтверждать доставку сообщения на C#?
Guides предоставляют информацию для выполнения одной задачи, а контент разработан для быстрого усвоения.
Помимо нового контента, мы также внедрили несколько новых обновлений дизайна, чтобы помочь вам быстрее находить код. На настольных дисплеях с достаточным количеством пикселей Guides представляют новый механизм для быстрого доступа к деталям реализации API. Мы называем эту экспресс-полосу CodeRail.
CodeRail выводит искомый код из основного текста в отдельную третью колонку, отделенную от пояснительного текста. При прокрутке руководства для получения дополнительной информации CodeRail обновляется вместе с вами, чтобы соответствующий код всегда был перед глазами.
Более того, над каждым примером расположены быстрые ярлыки для копирования этого кода в выбранный вами редактор. Если вы хотите получить код и попробовать его в своем приложении, просто нажмите кнопку «Копировать в буфер обмена», чтобы получить пример и вставить его в предпочитаемый вами текстовый редактор.
Как и остальная наша документация, мы приложили большие усилия, чтобы Guides хорошо работали на вашем мониторе и соответствовали вашему стилю кодирования. Guides поставляются со светлой и темной темами, которые можно переключать в зависимости от вашей среды. Быстро переключайтесь между ними, чтобы устроить дискотеку прямо в своей документации.
Дизайн также адаптивен для мобильных устройств, чтобы CodeRail сворачивался в основной текст, когда вам нужно быстро освежить знания по определенной теме на ходу.
Мы очень ценим ваш отзыв об этом новом формате документации — поделитесь своими мыслями в комментарии ниже или отправьте электронное письмо нашим друзьям из команды Developer Education. Также следите за Twitternets, так как на этой неделе мы будем отмечать техническую документацию с хэштегом #docsweek. Мы очень рады поделиться Guides со всеми вами и с нетерпением ждем ваших отзывов!