Активный залог #
В документации используется активный залог. У предложений в активном залоге обычно более понятная конструкция: в них есть действие и лицо, которое его совершает. В инструкциях активный залог помогает пользователю понять, кто должен совершать действие — он или кто-то другой.
| ❌ | ✅ |
|---|---|
| Заказ будет доставлен. | Курьер доставит заказ. |
| Нужно загрузить сертификаты и пройти модерацию. | Загрузите сертификаты и отправьте товар на модерацию. |
Исключение из правила — предложения, в которых субъект не важен, и нужно сделать акцент на произошедшем событии. В таких случаях можно использовать пассивный залог.
| ❌ | ✅ |
|---|---|
| Вы сохранили изменения. | Изменения сохранены. |
Текст от первого лица #
Мы пишем текст от первого лица, реже — от лица Ozon.
Когда в предложении говорится о сервисе со словом «Ozon» в названии, использование первого лица помогает избежать повторения слова «Ozon».
| ❌ | ✅ |
|---|---|
| Ozon предоставляет пользователям Ozon Premium… | Мы предоставляем пользователям Ozon Premium… |
Порядок элементов #
Порядок элементов в инструкции должен соответствовать пользовательскому пути. Не нужно выносить в начало предложения то действие, которое пользователь выполнит последним.
| ❌ | ✅ |
|---|---|
| Нажмите Изменить, когда перейдёте в Настройки в личном кабинете. | Откройте личный кабинет и в разделе Настройки нажмите Изменить. |
Начинать предложение нужно с цели действия. Пользователь должен с первых слов понять, стоит ли читать предложение, или его можно пропустить.
| ❌ | ✅ |
|---|---|
| Нажмите Изменить, когда перейдёте в Настройки в личном кабинете. Так вы измените настройки профиля. | Чтобы изменить настройки профиля, откройте личный кабинет и в разделе Настройки нажмите Изменить. |
Длина предложения #
Предложение не должно быть длинным и сложным для восприятия. Идеальная длина — до 15 слов.
Некоторые элементы указывают на то, что предложение слишком длинное или сложное. Например, точка с запятой внутри предложения, текст в скобках или несколько однородных членов подряд.
Точка с запятой внутри предложения #
Если внутри предложения есть точка с запятой, значит, оно слишком длинное и сложное. Такое предложение можно разделить на два.
Текст в скобках #
Если текст в скобках важен, его нужно вынести из скобок, а если не важен — убрать. Исключение — расшифровки аббревиатур.
Однородные члены предложения #
В предложении не должно стоять больше трёх однородных членов подряд. Такое предложение становится сложным для понимания.