#какэтоработает #вопросвлоб
Всем привет! Сегодня мы рассмотрим ситуацию, с которой не так давно столкнулись. Разбор этой ситуации ещё полезен тем, что одной из наших коллег подобный кейс задали на собеседовании. Так что этот пост для рубрик и про практические решения, и про собеседования.
Как выкатить документацию на другом языке, если у вас нет ни времени, ни ресурсов
Представим, что у вас появилась производственная необходимость срочно выпустить документацию на другом языке.
Сразу оговоримся, что подобный подход — это способ потушить пожар, а не выстроить систему правильно.
Подготавливаемся
1️⃣ Узнайте, на сколько языков нужно перевести документацию.
2️⃣ Узнайте, в каких странах вы должны выйти, нужны ли вам домены в этой стране.
3️⃣ Изучите требования законодательства относительно данных в этих странах. Например, нужно ли разворачивать сервис документации на мощностях местных ЦОДов.
4️⃣ Запросите требования вашей службы информационной безопасности.
5️⃣ Уточните, все ли сервисы вашего продукта локализованы в нужных странах. От этого зависит, все ли функциональности будут доступны в этой стране. Если не все, готовьтесь скрывать часть документации.
Заручаемся поддержкой
6️⃣ Возьмите у команды продукта переводы текстов интерфейса.
7️⃣ В условиях сжатых сроков и отсутствия ресурсов мы будем использовать искусственный перевод. Расскажите владельцу продукта о ваших планах, аргументируйте каждое решение. Владелец продукта и менеджер продукта должны быть вашими союзниками, используйте свой талант переговорщика.
Работаем с текстами
8️⃣ Приготовьте на основе переводов словари значений русский — иностранный, столько пар, сколько языков. Эти словари вы сможете использовать в качестве контекста для искусственного перевода. (Помним, что у нас нет времени и ресурсов, поэтому ИИ — наш выход).
9️⃣ Если вам требуются нераспространённые языки, сформируйте словари английский — иностранный. Если у вас изначально есть английская документация, ИИ с английского на редкие языки порой переводит лучше, чем с русского.
1️⃣0️⃣ Подготовьте иноязычные исходники в нужной вам разметке. Загрузите в ИИ в качестве контекста наши словари и с помощью промпта запросите перевод. В идеале лучше настроить интеграцию с системами построчного перевода, но мы помним, что у нас нет времени и ресурсов. Вы можете использовать агенты и прописывать им правила — в этом случае перевод может быть лучше.
Строим, собираем, разворачиваем, тестируем
1️⃣1️⃣ Проработайте архитектуру документации и процессы, которые позволят разворачивать документацию в нужных конфигурациях и на нужных адресах. Это может быть непростой работой и занять приличное количество времени. Если у вас есть помощники-девопсы, вам повезло.
1️⃣2️⃣ Если у вас в продукте есть нелокализованные сервисы, подготовьте скрипты, которые позволят скрывать описания конкретных функциональностей в конкретных странах (на конкретных доменах). Если вы не умеете это делать, вам могут это рассказать наши ИИшные друзья. Для них это несложно, и они в этом практически не ошибаются.
1️⃣3️⃣ Если вы поставляете публичную документацию, позаботьтесь о том, чтобы поисковые системы правильно проиндексировали её. Для этого снабдите страницы нужными метаданными.
1️⃣4️⃣ Протестируйте сборку и развёртывание документации в тестовых окружениях.
Публикуем
1️⃣5️⃣ Получите согласование от владельца и менеджера продукта и опубликуйте документацию. И да поможет вам бог.
Можно ли поддерживать такую документацию в актуальном состоянии? — Да, если реализовать непрерывную локализацию, о которой мы расскажем в других постах.
Всем привет! Сегодня мы рассмотрим ситуацию, с которой не так давно столкнулись. Разбор этой ситуации ещё полезен тем, что одной из наших коллег подобный кейс задали на собеседовании. Так что этот пост для рубрик и про практические решения, и про собеседования.
Как выкатить документацию на другом языке, если у вас нет ни времени, ни ресурсов
Представим, что у вас появилась производственная необходимость срочно выпустить документацию на другом языке.
Сразу оговоримся, что подобный подход — это способ потушить пожар, а не выстроить систему правильно.
Подготавливаемся
1️⃣ Узнайте, на сколько языков нужно перевести документацию.
2️⃣ Узнайте, в каких странах вы должны выйти, нужны ли вам домены в этой стране.
3️⃣ Изучите требования законодательства относительно данных в этих странах. Например, нужно ли разворачивать сервис документации на мощностях местных ЦОДов.
4️⃣ Запросите требования вашей службы информационной безопасности.
5️⃣ Уточните, все ли сервисы вашего продукта локализованы в нужных странах. От этого зависит, все ли функциональности будут доступны в этой стране. Если не все, готовьтесь скрывать часть документации.
Заручаемся поддержкой
6️⃣ Возьмите у команды продукта переводы текстов интерфейса.
7️⃣ В условиях сжатых сроков и отсутствия ресурсов мы будем использовать искусственный перевод. Расскажите владельцу продукта о ваших планах, аргументируйте каждое решение. Владелец продукта и менеджер продукта должны быть вашими союзниками, используйте свой талант переговорщика.
Работаем с текстами
8️⃣ Приготовьте на основе переводов словари значений русский — иностранный, столько пар, сколько языков. Эти словари вы сможете использовать в качестве контекста для искусственного перевода. (Помним, что у нас нет времени и ресурсов, поэтому ИИ — наш выход).
9️⃣ Если вам требуются нераспространённые языки, сформируйте словари английский — иностранный. Если у вас изначально есть английская документация, ИИ с английского на редкие языки порой переводит лучше, чем с русского.
1️⃣0️⃣ Подготовьте иноязычные исходники в нужной вам разметке. Загрузите в ИИ в качестве контекста наши словари и с помощью промпта запросите перевод. В идеале лучше настроить интеграцию с системами построчного перевода, но мы помним, что у нас нет времени и ресурсов. Вы можете использовать агенты и прописывать им правила — в этом случае перевод может быть лучше.
Строим, собираем, разворачиваем, тестируем
1️⃣1️⃣ Проработайте архитектуру документации и процессы, которые позволят разворачивать документацию в нужных конфигурациях и на нужных адресах. Это может быть непростой работой и занять приличное количество времени. Если у вас есть помощники-девопсы, вам повезло.
1️⃣2️⃣ Если у вас в продукте есть нелокализованные сервисы, подготовьте скрипты, которые позволят скрывать описания конкретных функциональностей в конкретных странах (на конкретных доменах). Если вы не умеете это делать, вам могут это рассказать наши ИИшные друзья. Для них это несложно, и они в этом практически не ошибаются.
1️⃣3️⃣ Если вы поставляете публичную документацию, позаботьтесь о том, чтобы поисковые системы правильно проиндексировали её. Для этого снабдите страницы нужными метаданными.
1️⃣4️⃣ Протестируйте сборку и развёртывание документации в тестовых окружениях.
Публикуем
1️⃣5️⃣ Получите согласование от владельца и менеджера продукта и опубликуйте документацию. И да поможет вам бог.
Можно ли поддерживать такую документацию в актуальном состоянии? — Да, если реализовать непрерывную локализацию, о которой мы расскажем в других постах.