User Documentation Некоторые моменты, о которых следует помнить при отправке материала в эту документацию:
- Изображения: избегайте скриншотов в формате jpg, размытых и слишком маленьких. Заменяйте их на более крупные изображения в формате png. Делайте все скриншоты шириной от 1500 до 2500 пикселей, учитывая, что на их основе будет создан набор адаптивных изображений разных размеров и форматов, включая webp. Смотрите наши советы по улучшению скриншотов.
- Заголовки: используйте заголовки вместо жирных строк. Такие жирные строки не создают семантическую структуру документа и будут отмечены средством проверки доступности Joomla. Располагайте их в логической иерархии: не перескакивайте с H2 на H4, пропуская H3. Не используйте H1 в своих материалах, так как на странице может быть только один H1 — заголовок материала.
- Нажмите: используйте это слово только для нажатия на кнопку. Не используйте его для выбора чего-либо из списка настроек: там следует использовать «Выберите». Изначально слово «Нажмите» использовалось для действий мышью и не подходит для пользователей клавиатуры или сенсорной панели.
- Пунктуация: у нас много списков терминов, которые начинаются с жирного слова или группы слов, за которыми следует двоеточие или точка, иногда внутри жирной группы, а иногда вне её. Для единообразия не выделяйте жирным двоеточие или точку. Как в списке, который вы сейчас читаете.
- Слова, требующие внимания: см. этот список в руководстве для разработчиков. Например, обратите внимание на слова back-end, front-end и directory, которые находятся в столбце недопустимых слов.
- Менеджер: этот термин часто использовался в Joomla 3, например, в «Article Manager», «Menu Manager» или «User Manager». В Joomla 4+ он практически исчез. Теперь используйте то, что указано в строке заголовка страницы панели управления, например, страница списка «Материалы», страница списка «Меню: Пункты меню» или страница списка «Модули (Сайт)».
- Единообразное использование «в» или «на»: как в «Выберите кнопку Справка в/на Панели инструментов» или «в/на Странице». Эти места можно рассматривать как контейнеры, поэтому предпочтительным является слово «в».