Как спроектировать пайплайн перевода

Превращайте изменения исходного контента в готовые к использованию переводы: определите ответственных и правила проверки, доставки и восстановления.

Пайплайн перевода проходит полный цикл, когда изменённый исходный контент становится доступен в переводе и готов к использованию в нужной системе. Генерация — лишь часть процесса. Рабочий процесс также должен определять нужную версию, получать её переводы, сохранять принятые результаты и решать, что можно публиковать.

Начните с одного реального типа контента: каталогов переводов в репозитории, статей CMS или записей приложения. У них разные ответственные и способы доставки. Если рабочий процесс обрабатывает все три типа одинаково, легко упустить решения, от которых зависит, безопасно ли использовать результат.

Определите ответственных за каждый переход #

Для каталогов переводов в репозитории можно принять такие решения:

ПереходРешение
Исходный контент готов к переводуПереводить проверенный исходный контент из зафиксированного коммита по доверенному триггеру, который исключает сгенерированные переводы.
Работа начинаетсяИспользовать явно заданные движок локализации, локали, формат и принятые базовые версии. Получать одобрение на запуск, если оно требуется.
Переводы готовы к принятиюНазначенные проверяющие изучают нужные изменения, а нерешённые вопросы остаются на виду.
Результат возвращаетсяСкачанные ресурсы после валидации попадают в пул-реквест с переводами.
Контент доходит до читателейИзменение включается в релиз приложения и проходит предусмотренные в нём проверки ресурсов.
Результат нужно отменитьВосстановить заведомо исправные ресурсы и соответствующую конфигурацию или базовые версии.

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

Выбирайте инструменты по их зоне ответственности #

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

Studio хранит настройки перевода и принятые решения. DevTools позволяет запускать обработку программно и на основе файлов. Radar предоставляет доступные данные измерений и расследований. Эти возможности можно сочетать — их не обязательно внедрять одну за другой.

Изучите, как у выбранного провайдера работают ручной и автоматический режимы, обработка черновиков и права доступа, а также что происходит при отключении. Подключение, которое публикует контент в CMS, и подключение, которое открывает пул-реквест в репозитории, различаются тем, на каком этапе результат считается принятым.

Сохраняйте связь между версиями #

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

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

Продумайте, что делать с нерешёнными вопросами #

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

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

Сделайте данные о качестве понятными #

Определите вопросы, важные для релиза, в том числе для переводов, созданных вне Lingo.dev. Измерения помогают найти результаты, которым нужна проверка. При этом система измерений не обязана отвечать за принятый контент или решать, что публиковать.

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

Проверьте полный цикл перед масштабированием #

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

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