Привет, Хабр! Я работаю техническим писателем в компании documentat.io, мы занимаемся заказной разработкой технической документации, в том числе на английском языке.
В своей первой статье я разобрал, пожалуй, самые распространённые ошибки, которые допускают русскоязычные айтишники при написании документации на английском. Пожалуйста, прочитайте её, если ещё не.
В этой статье разберём другую разновидность подводных камней английского — двусмысленные конструкции. Даже носители языка иногда упускают их из виду. А ведь любое двусмысленное выражение может затруднить понимание текста, особенно для пользователя, который только начинает разбираться в предмете. Каждая запинка при чтении приближает пользователя к тому, чтобы бросить документацию и пойти дёргать техподдержку или писать про продукт гадости в интернете. Таким образом, двусмысленность в конечном счёте может стоить бизнесу денег.
Неопределившиеся определители
В первой статье мы посмотрели, как длинные цепочки определяющих существительных затрудняют чтение, и поняли, как решать эту проблему добавлением предлога:
❌ The field contains the system error message text identifier
✅ The field contains the text identifier of the system error message
Но затруднённое чтение — это полбеды. Намного хуже, когда неосторожное употребление цепочек определяющих существительных приводит к двусмысленности:
❓ It is convenient to use the analytics system log viewer
✅ It is convenient to use the viewer of the analytics system log
✅ It is convenient to use the log viewer that is the part of the analytics system
Обе интерпретации в теории имеют смысл, а значит, перефразируя закон Мёрфи: если что-то можно понять неправильно, кто-то это поймёт неправильно.
Даже если читатель вскоре догадается из контекста, что именно имелось в виду, мы уже заставили его догадываться, вместо того чтобы просто дать ему нужную информацию. То есть документация стала работать чуть хуже.
Чтобы цепочка существительных стала двусмысленной, ей совсем необязательно быть длинной. Проблема в том, что средневековые англичане такие:
— А зачем нам эти бесполезные восемь падежей? Выкинем этот хлам, оставим только два.
— И как же мы теперь будем определять, что к чему относится?
— Ну так, примерно почувствуем.
В результате двусмысленность может возникнуть и в коротких словосочетаниях из трёх и даже двух слов. Давайте разберёмся, что с этим можно сделать на примерах:
❓ The method returns new resume views Здесь непонятно, относится ли new к резюме или к просмотрам? Починить такого рода проблему можно старым добрым добавлением предлогов и артиклей: ✅ The method returns new views of the resume Будьте бдительны со словом new, оно часто приводит к подобным двояким трактовкам. |
❓ Satellite information Это информация со спутника или о спутнике? Проблема в том, что без контекста бывает непонятно, как именно определяющее существительное относится к основному, т. е. через какой предлог это можно переформулировать: for, of, by, about, from и т. д. Чинится явным указанием предлога: ✅ Information from a satellite |
❓ Sample requests are listed below Двусмысленность этого примера многие англоязычные авторы из IT, кажется, не замечают. Он часто встречается в контексте API и не вызывает вопросов у разработчиков. Но я знаю случай, когда переводчик, который недостаточно хорошо понимал предметную область, попал в ловушку. Проблема в том, что определяющее слово sample может отвечать на разные вопросы:
Источник: https://habr.com/ru/companies/documentat/articles/775102/
Поделиться ссылкой:
Интересные статьиИнтересные статьи
В предыдущей статье я рассказал, как создать блок-дизайн c софт-процессором Microblaze, ethernet в режиме SGMII и SPI flash. В этой статье я расскажу про то, как собрать и настроить образ линукса, как...
Yealink предоставляет множество инструментов для траблшутинга, среди которых присутствуют как средства моментальной диагностики (утилиты, команды), так и опции сбора логов. В данной статье мы кр...
В третьей части ищем ошибку при удалении задачи из списка дел, и попутно путешествуем во времени разбираемся со стеком вызовов в отладчике.
В данной статье я хочу предоставить переработанную и упорядоченную выжимку документации по настройке "флагов строгости" tsconfig.json. Статья будет полезна как тем, кто т...
В этой статье продолжаем делиться впечатлениями от поездки в Лондон на AngularConnect 2019. Сегодня расскажем, как все происходило, о докладах второго дня и о том, что полезного мы привезли домой...
|