Жирный шрифт #
Жирным шрифтом выделяются кликабельные элементы интерфейса. Так мы привлекаем внимание пользователя к элементам, с которыми можно взаимодействовать. К ним относятся:
- кнопки,
- разделы,
- блоки,
- кликабельные столбцы таблиц;
- фильтры.
Остальные элементы интерфейса выделяются кавычками. Например, статусы, некликабельные названия столбцов и ролей.
Жирным шрифтом не выделяется важная для пользователя информация — для этого используются плашки.
Подробнее об использовании плашек
Списки #
Списки бывают нумерованные для пошаговых инструкций и маркированные для перечисления элементов.
Поясняющий текст списка #
Перед списком должен быть поясняющий текст. Он связан с первыми словами пунктов грамматически и синтаксически. Список должен быть консистентным, все его пункты должны начинаться с одинаковой части речи.
| ❌ | ✅ |
|---|---|
| Чтобы зарегистрироваться: 1. Перейди в личный кабинет. 2. Введите логин и пароль. 3. Готово. |
Чтобы зарегистрироваться: 1. Перейдите в личный кабинет. 2. Введите логин и пароль. 3. Нажмите Готово. |
Если нумерованный список начинается после заголовка, поясняющий текст не нужен — его роль выполняет заголовок.
После поясняющего текста ставится:
- двоеточие — если пункты списка объясняют то, о чём говорится в поясняющем тексте, или продолжают его;
- точка — если пункты списка прямо не продолжают поясняющий текст.
Пример 1
Чтобы вывести деньги с баланса средств в драмах, напишите нам в чат и укажите:
- SWIFT-код банка получателя,
- номер расчётного счёта,
- фамилию и имя на латинице.
Пример 2
Если на вашем балансе средств больше 100 рублей, вывести сумму меньше не получится. Если сумма меньше, вы можете вывести только полностью всю сумму.
- В разделе Баланс средств нажмите Вывести деньги с баланса средств.
- Укажите:
- сумму вывода,
- ФИО получателя как в паспорте,
- номер лицевого или расчётного счёта в банке получателя,
- БИК банка.
- Нажмите Вывести деньги с баланса средств.
Нумерованные списки #
Нумерованные списки используются в пошаговых инструкциях.
Правила оформления:
- список начинается с арабской цифры с точкой;
- в конце каждого пункта ставится точка;
- пункты списка начинаются с прописной буквы.
| ❌ | ✅ |
|---|---|
| Чтобы вернуть товар: I. оформите заявку и дождитесь согласования, II. верните товар. |
Чтобы вернуть товар: 1. Оформите заявку и дождитесь согласования. 2. Верните товар. |
Маркированные списки #
Маркированные списки используются, когда не нужно перечислять пункты в определённом порядке, не важен порядок действий или пункты равнозначны.
Правила оформления:
- каждый пункт начинается со строчной буквы;
- в конце пунктов списка ставится:
- запятая — если каждый пункт состоит из 1-3 слов и не содержит знаков препинания;
- точка с запятой — если пункты содержат от 4 слов или знаки препинания;
- точка — если пункт последний в списке.
| Ситуация | Пример |
|---|---|
| Не важен порядок действий | Зарегистрируйтесь в личном кабинете. Укажите: • ФИО, • электронную почту. |
| Пункты равнозначны | Стоимость доставки составляет: • в пункт выдачи товаров — 0 рублей; • курьером — 50 рублей. |
| Выбор одного варианта из нескольких | Выберите один из способов доставки: • в пункт выдачи, • курьером. |
Особенности использования #
Предпочтительнее использовать маркированный список, в котором пункты начинаются с маленькой буквы и заканчиваются точкой с запятой.
Если пункты списка состоят из нескольких предложений, лучше оформить их в виде сплошного текста или табов.
Подробнее об использовании табов
Если такие варианты оформления не подходят, каждый пункт маркированного списка должен состоять из максимум 3 предложений, начинаться с заглавной буквы и заканчиваться точкой.
Вложенные списки #
Вложенность списка может быть не больше второго уровня. Из-за большой вложенности пользователю будет сложно фокусироваться на последовательности шагов.
Пример
Стоимость доставки:
- при доставке обычных товаров:
- в пункт выдачи заказов — 0 рублей;
- курьером — 50 рублей;
- при доставке крупногабаритных товаров — 700 рублей.
Ссылки #
В тексте не должно быть много ссылок — перегруженный ссылками текст сложно читать. Текст ссылки должен сообщать, куда перейдет пользователь, а не быть призывом к действию.
| Правила оформления | Пример |
|---|---|
| При использовании знака «→» для описания пользовательского пути ссылка ставится на весь путь. | Перейдите в раздел Настройки → Управление доступом. |
| Предлоги и кавычки не включаются в ссылку — это визуально сократит её. | Напишите нам в чат. |
| Для ссылки не используются слова «здесь» и «по ссылке» — они не информативны. В ссылке указывается статья или конечная точка, куда перейдёт пользователь. | Все электронные чеки можно скачать в личном кабинете в разделе Электронные чеки. |
| Не ставятся ссылки на слова «в статье» и «в разделе». | Перейдите в раздел Заказы и откройте нужный заказ. |
| В ссылке на скачивание файла указывается его расширение. | Стоимость услуг Ozon Банка можно посмотреть в документе Тарифный пакет «Ozon Карта» (PDF). |
| Если название сайта — домен, в ссылке не указывается слово «сайт». | Создайте аккаунт на jdl.com. |
| Если слово «сайт» нельзя опустить, оно добавляется к ссылке. | Создайте аккаунт на сайте Министерства образования и науки. |
| Если ссылка начинается со слова «Подробнее» и ведёт на внешний сайт или ресурс, ссылка ставится на его название и слово «сайт». Такой подход делает текст более однозначным. Например, из текста в примере пользователь сразу поймёт, что слово «тарифы» относится к слову «подробнее», а ссылка указывает на источник. | Подробнее о тарифах на сайте JDL |
| Если ссылка стоит в конце абзаца или пункта списка, она переносится на новую строку. Точка в конце ссылки не ставится. | Укажите имя, фамилию и почту пользователя и выберите тип доступа. Подробнее об уровнях доступа |
| Если список coстоит полностью из ссылок, знаки препинания в конце пунктов списка не ставятся. | Доступные способы оплаты: • Банковская карта • Баланс средств • SberPay |
| Если ссылка ведёт на пошаговую инструкцию, она начинается с наречия «как». | Как изменить способ оплаты заказа |
Примеры оформления ссылок на разные ресурсы:
- на подраздел внутри статьи: Подробнее о тарифах или Как изменить тариф;
- на другую статью в этой документации: Подробнее в статье Тарифы;
- на статью в другой документации в Справке: Подробнее в Справке Ozon Рассрочки;
- на внешний сайт или ресурс: Подробнее на Госуслугах.
Таблицы #
Таблицы используются, чтобы описать или сравнить несколько объектов с похожими характеристиками. Это позволяет визуально упорядочить информацию и помогает читателю ориентироваться в ней.
Оформление шапки таблицы:
- текст начинается с заглавной буквы;
- знаки препинания в конце заголовка таблицы не ставятся, исключение — если текст заголовка заканчивается на «тыс.» или «шт.».
Оформление ячейки таблицы:
- текст начинается с заглавной буквы;
- если содержимое ячейки — неполное предложение из 1-3 слов или текст интерфейса, точка в конце не ставится;
- после полных предложений точка ставится;
- содержимое ячеек в пределах одной колонки должно быть однотипным и согласовываться синтаксически и грамматически с заголовком ячейки.