Простой английский для всех: советы по написанию технических текстов | Журнал "Вольт"
Сб. Дек 5th, 2020


Перевод статьи «Обычный английский для всех».

От редакции Techrocks. Хотя эта статья не предназначена специально для программистов, мы полагаем, что советы из нее будут полезны и для разработчиков. Прежде всего, они позволят вам улучшить качество вашей документации в проектах. И даже если в вашей компании есть отдельные специалисты по написанию документации, не стоит забывать о личных проектах. Когда вы выводите свои приложения на рынок, вы все равно будете писать для них описания и инструкции.

Кроме того, вам, вероятно, случится задать вопросы на специализированных форумах и ответить на них.

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

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


Под выражением «простой английский» подразумевается ясный и лаконичный английский.

Техническое письмо отличается от художественной литературы. Цель технической документации – сделать сложную техническую информацию простой для понимания. Следовательно, простой английский – важный аспект технического письма. Благодаря его использованию ваши тексты будут более доступными, лаконичными и читабельными.

Почему простой английский?

  • Для многих английский не родной язык. Но из тех, кто его знает, гораздо больше людей понимают простую версию языка, чем сложную.
  • Простой английский переводить легче. Распространенные, повседневные английские слова и фразы с большей вероятностью будут иметь точные аналоги в других языках.
  • Простой английский легче понять. Читатель сможет сосредоточиться на технических концепциях, а не на расшифровке предложений.

Базовые знания английского языка

Точки вместо запятых

По возможности используйте короткие предложения.

Старайтесь не объединять запятыми более двух предложений.

Отдавайте предпочтение активному голосу

Например, лучше написать

«X() reads a new file»

(«X () читает новый файл»),

но нет

«A new file is read by X()»

(«Новый файл читается X ()»).

Удалить прилагательные

Большинство прилагательных не несут полезной информации. Например, предложение

«This well-written function reads a new file»

(«Эта хорошо написанная функция читает новый файл»)

можно свести к

«This function reads a new file»

(«Эта функция читает новый файл»).

Постарайтесь как можно быстрее перейти к сути и не терять тему.

Инклюзивный язык и предрассудки

Старайтесь вообще не использовать местоимения. Если без этого не обойтись,

  1. используйте «они» вместо «он» или «она», и
  2. «Люди», «люди», «все» вместо «девушки» или «парни».

Редакторы Techrocks отмечают приведенные выше советы:

  1. Местоимение «они» используется довольно часто (и чаще) в статьях на английском языке. Примеры – такие предложения, как «Если пользователь хочет …, он should… ». Это« он »в английском языке чаще всего заменяется на« они », иногда на« она ».
  2. В исходной статье есть ссылка на страницу heyguys.cc, которая объясняет, почему использование слов «парни» и «девушки» – это плохо. «Привет, ребята» – обычное приветствие, но оно не нейтрально с гендерной точки зрения. Оно адресовано мужчинам или парням, и все остальные могут чувствовать себя исключенными из этой группы, хотя говорящий может не иметь таких намерений ». Поэтому лучше сказать (и написать) «всем привет», «привет народ», «привет друзья» и т. Д.

Избегайте слов, которые можно интерпретировать расистски («черный список», «хозяин», «раб» и т. Д.).

Старайтесь не использовать такие фразы, как «это просто, вам просто нужно…», «этот шаг очень простой» и т. Д. То, что просто для одного человека, может оказаться непростым для другого. Не будем раздражать читателя такими выражениями.

Активно ищите в своих письмах проявления предрассудков. Даже выбор имен в примерах (в зависимости от контекста) может повлиять на некоторые группы людей. Мы, вероятно, никогда не сможем быть полностью беспристрастными, но попробовать стоит.

Избегайте жаргона, используйте общие слова

В технической документации уже полно сложных терминов. Не нужно его еще больше усложнять. Хороший способ избавиться от жаргона – позволить разным людям читать текст.

Имейте в виду, что сленг – это тоже жаргон.

Дополнительные советы

Планирование

Хорошая практика – спланировать свой документ до того, как вы начнете его писать. Обратите внимание на следующие моменты:

  • какова ваша целевая аудитория?
  • какого размера должен быть документ?
  • каков более широкий контекст?

Структура

Начните с грубого наброска конструкции. Затем попробуйте выделить каждое понятие в отдельный раздел. Четкая структура и заголовки улучшают читаемость.

Руководства по стилю

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



Source link

Добавить комментарий

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