# Написание содержимого для перевода

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

## О написании содержимого, понятного для перевода

Используйте следующие рекомендации, чтобы убедиться, что создаваемое содержимое можно успешно преобразовать. Дополнительные сведения см [. в руководстве по](/ru/enterprise-server@3.22/contributing/style-guide-and-content-model/style-guide) стилю.

* Используйте примеры, которые являются универсальными и могут быть понятны большинству людей.
* Избегайте примеров, которые являются спорными или культурно характерными для группы.
* Запись в активном голосе.
* Написание простых, коротких и простых предложений.
* Избегайте использования слишком много существительных, которые могут сделать текст неясным.
* Избегайте использования сленга и шутки.
* Избегайте отрицательных предложений.
* Используйте стандартные акронимы в отрасли, когда это возможно, и объясните пользовательские акронимы.
* Используйте показательное настроение.
* Исключите избыточные и слововые выражения.
* Избегайте чрезмерного использования модификаторов с накоплением (строки существительных). Переводчик может неправильно понять, какое существительное является измененным.
* Избегайте невидимых плюралистов, в которых не ясно, если первое существительное должно быть единственной или множественной.
* Избегайте инициализации.
* Избегайте использования неоднозначных модальных вспомогательных команд.
* Избегайте слов, характерных для пола.
* Избегайте предпозиционных фраз.
* Избегайте расплывчатых существительных и существительных (расплывчатый предмет предложения).
* Сохраняйте встроенные ссылки к минимуму. Если они необходимы, предусловите их фразой, например "Дополнительные сведения, см. в разделе "Название ссылки". Кроме того, добавьте соответствующие ссылки в раздел "Дополнительное чтение" в конце раздела.

## Примеры

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

### Избегайте сведений о конкретной стране

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

### Избегайте чрезмерного использования модификаторов с накоплением (строки существительных)

Множество модификаторов с накоплением может привести к неправильным переводам, так как это не легко определить, что изменяет. Например, используйте параметр "Параметры источника по умолчанию для общедоступный репозиторий" вместо "общедоступный репозиторий параметров источника по умолчанию".

### Избегайте невидимых плюралистов

Например, при использовании термина "извлечение файлов" неясно, извлекают ли вы один файл или все файлы. Укажите больше контекста для устранения неоднозначности. В приведенном примере можно использовать "извлечение всех файлов" или "извлечение файла source.md".

### Избегайте инициализации

Например, вместо того, чтобы "прийти к выводу", используйте "заключение".

### Избегайте использования неоднозначных модальных вспомогательных команд.

Избегайте использования таких слов, как "может" и "может". Будьте более ясны, чтобы избежать неоднозначности.

### Избегайте предпозиционных фраз

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

### Избегайте расплывчатых существительных и существительных

Расплывчатые существительные и существительные могут сделать его неясным, кто или что вы ссылаетесь, особенно когда это содержимое должно быть переведено. Например, "Обслуживающие и участники имеют доступ к файлам и комментариям. В запросе на вытягивание они вносят изменения в него". В этом предложении не ясно, вносятся ли изменения в файл или комментарии. Если существительное, как представляется, ссылается на несколько ацедентов, либо переформулирует предложение, чтобы сделать протекedent ясным или заменить его существительным, чтобы устранить неоднозначность.

### Сохраняйте встроенные ссылки к минимуму.

Где это возможно, четко введите ссылки после нашего руководства по стилю. Например, вместо следующего предложения:

```markdown
Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering-oauth-apps/) Note that OAuth2 tokens can be [acquired programmatically](/rest/reference/oauth-authorizations/#create-a-new-authorization), for applications that are not websites.
```

Вместо этого можно использовать следующее:

```markdown
OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see [AUTOTITLE](apps/building-integrations/setting-up-and-registering-oauth-apps/) and [Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization).
```