Техническая документация: перевод и проверка

Техническая документация: перевод и проверка

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

Ошибка в шаге или единице измерения приводит к поломке или травме, а не просто к неудобству.

Что входит в документацию

Руководства, инструкции, схемы, подписи на устройстве, сообщения об ошибках, сервисные бюллетени. Каждый тип имеет свои требования к точности и объёму.

Переводчик должен понимать, где заканчивается описание и начинается предупреждение о безопасности.

Терминология

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

Для деталей и узлов важны точные названия: «плата» и «модуль» могут означать разное.

Предупреждения

Предупреждения о безопасности переводятся с особой осторожностью: смягчение формулировки недопустимо. Если в оригинале сказано «обязательно», перевод не может сказать «желательно».

Формулировки согласуются с принятыми в отрасли, а не со стилистическими предпочтениями.

Шаги и последовательность

Нумерация шагов должна совпадать с оригиналом. Добавление или удаление шага меняет процедуру и может привести к ошибке.

Если шаг непонятен, это вопрос к автору, а не повод переписать по-своему.

Единицы и обозначения

Единицы измерения, маркировки и обозначения деталей не переводятся, а сохраняются. При необходимости рядом даётся пояснение.

Проверьте, что десятичные разделители соответствуют языку перевода и не меняют значение.

Иллюстрации и подписи

Подписи на схемах должны совпадать с текстом и с маркировкой на устройстве. Расхождение сбивает читателя в самый неподходящий момент.

Если изображение содержит текст, его нужно перевести или заменить, а не оставить на исходном языке.

Интерфейс и сообщения

Строки интерфейса, сообщения об ошибках и названия пунктов меню переводятся единообразно. Пользователь ищет ту же формулировку, что видит на экране.

Длина строк ограничена, поэтому перевод подбирается с учётом места.

Стиль

Техническая документация пишется короткими предложениями и повелительными конструкциями. Многословие мешает следовать инструкции.

При этом сокращение не должно убирать условие или ограничение.

Проверка

Перевод проверяется по процедуре: можно ли выполнить шаги, не заглядывая в оригинал. Ошибки находятся именно при попытке выполнить инструкцию.

Отдельно проверяются числа, единицы и названия деталей по списку.

Согласование с инженером

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

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

Память переводов

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

Обновляйте базу после каждого релиза документации.

Версии документации

Документация обновляется вместе с продуктом. Важно, чтобы перевод соответствовал той версии, для которой он сделан.

Указывайте версию и дату в переводе так же, как в оригинале.

Типичные ошибки

Первая — переводить обозначения деталей. Вторая — менять порядок шагов. Третья — смягчать предупреждения.

Четвёртая — оставлять подписи на схемах без перевода.

Подготовка к переводу

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

Уточните, какая версия документа считается актуальной. В технической документации часто параллельно живут несколько редакций, и перевод устаревшей версии — напрасная работа.

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

Составьте список терминов и согласуйте его с инженером до перевода. Правки терминологии после готовности текста обходятся дороже.

Работа с таблицами

Таблицы технических характеристик переводятся построчно с сохранением структуры. Единицы измерения, допуски и условия указываются точно, без округления.

Если таблица не помещается на страницу после перевода, лучше перестроить оформление, чем сокращать данные.

Заголовки столбцов должны быть понятны без чтения основного текста. Сокращения расшифровываются в примечании.

Проверьте, что значения не сместились при копировании в новый файл: это распространённая ошибка при работе с таблицами.

Согласование изменений

Если в оригинале обнаружена ошибка, не исправляйте её молча. Сообщите о ней и дождитесь решения: возможно, это не ошибка, а особенность версии.

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

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

История изменений помогает понять, почему появилась та или иная формулировка.

Обучение и передача

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

Ведите короткие заметки о решениях: почему выбран этот термин и где он встречается. Новый переводчик потратит меньше времени на вход.

Передача материалов включает файлы, глоссарий и список открытых вопросов. Без этого работа начинается заново.

Проведите короткую встречу с новым исполнителем: полчаса объяснений экономят недели переписки.

Итог

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

Терминология, предупреждения и подписи проверяются отдельно и с участием специалиста.

Чек-лист

• Термины согласованы.
• Предупреждения не смягчены.
• Шаги совпадают с оригиналом.
• Единицы сохранены.
• Подписи переведены.
• Процедура проверена действием.
• Версия указана.

Частые вопросы

Можно ли адаптировать инструкцию?

Только если это не меняет процедуру.

Кто проверяет техническую точность?

Инженер или специалист по продукту.

Нужно ли переводить маркировки?

Обычно нет, но нужны пояснения.