Ошибки в английском в IT-документации
В технической документации важна однозначность. Размытые фразы и разные термины для одного понятия путают читателя. Хорошая документация пишется просто, последовательно и без лишних слов.
Практические советы
1. Используйте один термин
Если функция называется config, не называйте её settings в другом месте. Единый словарь избавляет читателя от путаницы.
2. Пишите короткими предложениями
Одна мысль — одно предложение. Длинные конструкции с несколькими условиями трудно понять при чтении.
3. Держите активный залог
Фраза The system sends a request яснее, чем A request is sent. Активный залог прямо называет исполнителя действия.
4. Убирайте лишние слова
Обороты вроде in order to лучше заменить на to. Краткость повышает понятность технического текста.
5. Проверяйте инструкции на практике
Пройдите шаги так, как их видит читатель. Так вы находите пропущенные детали и неоднозначные места.
Примеры с переводом
| English | Перевод |
|---|---|
| Click the Save button to apply changes. | Нажмите кнопку Save, чтобы применить изменения. |
| The server returns an error code. | Сервер возвращает код ошибки. |
| This option is available to admins only. | Эта опция доступна только администраторам. |
Частые вопросы
Насколько простым должен быть язык?
Настолько, чтобы понял новый пользователь. Если читателю приходится перечитывать фразу, её стоит переписать.
Нужно ли объяснять термины?
Да, при первом упоминании. Даже опытные пользователи ценят, когда сложное понятие объяснено кратко.
Как избежать двусмысленности?
Пишите конкретно, избегайте it и this без указания объекта. Ясные подлежащие убирают большинство неоднозначностей.