Урок из полного доступа, первые уроки курса бесплатно Официальный курс Mistral AI Cookbook на русском
Урок 83 · Текст · ~5 мин

Как писать контент для разработчиков

Урок 83 из 154 курса «Mistral AI Cookbook»: официальный курс Mistral AI Cookbook (Мистраль) на русском языке. Урок входит в платный доступ; первые уроки курса бесплатно.

О чём урок

Документация для разработчиков, как правило, более техническая, чем общий контент, но к ней применимы те же принципы тональности: будьте доброжелательны и непринужденны, четки и ясны, и готовы прийти на помощь.

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

Примеры кода показывают, как использовать элемент API для реализации конкретной функциональности. Они могут включать:

  • Простые однострочные примеры, вкрапленные в текст.
  • Короткие, самодостаточные примеры, иллюстрирующие конкретный момент.
  • Более длинные примеры, иллюстрирующие несколько функций, сложные сценарии или лучшие практики.

Разработчики используют примеры кода для:

  • Оценки API на этапе планирования.
  • Изучения языка или технологии.
  • Написания и отладки кода.

Многие разработчики копируют примеры кода из документации непосредственно в свои проекты.

  • Создавайте лаконичные примеры, охватывающие ключевые задачи. Начинайте с простейшего полезного примера и постепенно наращивайте сложность.
  • Приоритизируйте часто используемые элементы и элементы, которые могут быть трудны для понимания или сложны в использовании.
  • Не используйте примеры кода для иллюстрации очевидных моментов или надуманных сценариев.
  • Оставляйте сложные примеры для учебных пособий и пошаговых руководств, где вы можете предоставить пошаговое объяснение.
  • Добавьте введение, чтобы описать сценарий и объяснить все, что может быть неясно из кода. Перечислите требования и зависимости.
  • Предоставьте разработчикам простой способ копирования и запуска кода.
  • Проектируйте код для повторного использования. Помогите разработчикам определить, что нужно изменить. Добавляйте комментарии для объяснения неочевидных деталей — не констатируйте очевидное.
  • Показывайте ожидаемый вывод либо в отдельном разделе после кода, либо в комментариях к коду.
  • Пишите безопасный код. Никогда не прописывайте учетные данные жестко. Используйте заполнители, такие как os.environ["MISTRAL_API_KEY"] или "your-api-key".
  • Показывайте обработку исключений только тогда, когда это неотъемлемая часть примера.
  • Всегда компилируйте и тестируйте свой код перед публикацией.
  • Каждый блок кода должен иметь языковой тег: ```python, ```typescript, ```bash.
  • Используйте стиль кода (обратные кавычки) для всех программных элементов в тексте: имена функций, параметры, методы…

План урока

  1. Примеры кода
  2. Планирование примеров кода
  3. Написание примеров кода
  4. Правила форматирования кода
  5. Команды установки менеджера пакетов

Урок входит в полный доступ. Полный текст и видео открываются после оплаты. Первые уроки каждого курса бесплатны.

Откройте полный доступ

Вы прошли бесплатные уроки. Выберите тариф, чтобы продолжить обучение.

Курсы Mistral AI 1 490 ₽ Разовый платёж, навсегда
  • Все курсы от Mistral AI (1 шт.)
  • Именной сертификат по каждому пройденному курсу
Оплатить
Полный доступ 4 900 ₽ Разовый платёж, навсегда
  • Все 77 курсов от 11 AI-провайдеров
  • Библиотека промптов и новые курсы
Оплатить

Безопасная оплата через Robokassa: СБП, карты, электронные кошельки. Доступ откроется в этом браузере и придёт письмом. Уже оплатили? Восстановить доступ

Полезные гиды