Статья #
Статья состоит из названия, описания, введения и основного текста. Основной текст делится на смысловые блоки с помощью заголовков.
Название #
Название отображается в начале статьи и в левом меню. Оно отражает суть статьи и состоит максимум из 4 слов — это помогает пользователю быстро найти статью в левом меню. Обычно название статьи начинается с существительного.
В конце названия знаки препинания не ставятся.
Введение #
Введение — это первый абзац в статье, который кратко рассказывает, о чём в ней говорится. Оно краткое, информативное и состоит максимум из 4 предложений. Это опциональный элемент, который желательно добавлять в объёмные сложные статьи.
Заголовок #
Заголовок кратко рассказывает, о чём говорится в разделе или подразделе. Из заголовков собирается оглавление статьи, которое помогает пользователю ориентироваться по ней.
В заголовках не используются вопросительные формулировки. Лучше начать заголовок с существительного или глагола в инфинитиве. Это поможет кратко рассказать, о чём говорится в подразделе, и избежать повторения вопросительных наречий в оглавлении.
| ❌ | ✅ |
|---|---|
| Как заполнить бланк | Заполнить бланк |
| Как можно оплатить заказ | Способы оплаты |
Если раздел объёмный, информацию внутри него лучше разделить на подразделы. Для оглавления разделов используются заголовки второго уровня, для оглавления подразделов — заголовки третьего уровня.
В конце заголовка знаки препинания не ставятся.
Описание #
Описание отображается на разводящей странице. Оно находится под названием статьи и кратко рассказывает о том, какую информацию пользователь в ней найдёт. Описание состоит из одного предложения, не повторяет название статьи и не начинается с вопросительного наречия.
В конце описания знаки препинания не ставятся.
| ❌ | ✅ |
|---|---|
| Работа с товарами В этом разделе рассказываем про работу с товарами. |
Работа с товарами Загрузка и модерация товаров, штрихкоды и сертификаты |
| Работа с товарами Как загрузить товары? Как добавить штрихкод и работать с сертификатами? |
Работа с товарами Загрузка товаров, штрихкоды и сертификаты |
Страница «О сервисе» #
Страница «О сервисе» — это разводящая страница с краткой информацией о сервисе, которому посвящён раздел. Она может содержать:
- описание сервиса и важную информацию о нём;
- ссылку на сервис;
- навигацию по популярным статьям;
- часто задаваемые вопросы о сервисе.
Разводящая страница #
Разводящая страница — это краткое содержание раздела. Обычно она состоит из названия раздела и навигации по статьям, которые в него входят.
Навигация состоит из блоков с названием и кратким описанием статей. Блоки находятся в порядке, который соответствует пользовательскому пути — это помогает пользователю найти нужную информацию в разделе.
На разводящей странице может быть краткое описание раздела, полезные ссылки и ответы на частые вопросы пользователей.
Порядок статей в меню #
Статьи в левом меню находятся в том порядке, который соответствует пути пользователя.
Если несколько статей объединены под одной вкладкой, они тоже находятся в порядке, соответствующем пути пользователя.