Как писать техническую документацию на английском
Техническая документация должна быть точной и однозначной: читатель ищет ответ, а не литературу. В английском здесь важны короткие предложения, единые термины и предсказуемая структура. Разберём приёмы, которые делают текст понятным с первого прочтения.
Практические советы
1. Определяйте термин один раз
При первом употреблении дайте краткое определение, дальше используйте одно и то же слово без синонимов.
2. Пишите в настоящем времени
Формы вроде The system sends a request звучат чётче, чем сложные временные конструкции.
3. Один шаг — одно действие
Не объединяйте несколько операций в одном пункте, иначе читатель легко пропустит этап.
4. Используйте повелительный наклон
Open the file, click Save, enter your password — прямые инструкции понятнее описательных фраз.
5. Добавляйте примеры
Короткий пример команды или настройки снимает половину вопросов у пользователя.
6. Проверяйте единообразие
Одинаковые названия кнопок, полей и файлов по всему тексту экономят время и снижают ошибки.
Примеры с переводом
| English | Перевод |
|---|---|
| Open the settings menu and select Privacy. | Откройте меню настроек и выберите раздел Конфиденциальность. |
| The server returns an error if the token has expired. | Сервер возвращает ошибку, если срок действия токена истёк. |
| Save the file before you run the script. | Сохраните файл перед запуском скрипта. |
Частые вопросы
Нужны ли в документации сложные термины?
Только если они стандартны в вашей области. Иначе дайте простое объяснение рядом.
Как быть с пассивом?
В инструкциях лучше активный залог: он прямо говорит, кто выполняет действие.
Сколько должно быть примеров?
Хотя бы один на каждый важный шаг или команду, чтобы читатель мог свериться.