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