Интерфейсы Discourse и документация в настоящее время пересматриваются и редактируются для приведения в соответствие с этими рекомендациями. Мы стремимся к полной согласованности в кратчайшие сроки.
При написании материалов для Discourse обратите внимание на следующие правила форматирования текста. Эти правила применяются ко всему тексту, особенно в документации и интерфейсе Discourse.
Регистр букв
При написании документации или текста интерфейса по умолчанию используйте регистр предложения (то есть с заглавной буквы пишется только первое слово фразы).
Важные напоминания:
- Заголовки, названия и имена категорий используют регистр предложения.
- Названия функций Discourse не пишутся с заглавной буквы, за исключением следующих случаев:
Не используйте для названий функций никакого другого форматирования, включая жирный шрифт, курсив, обратные кавычки, кавычки или что-либо ещё.
Исключения в использовании регистра букв:
- Аббревиатуры всегда должны писаться с заглавными буквами в соответствии с правилами.
- Названия продуктов и брендов должны писаться с заглавной буквы в соответствии с их бренд-гайдами.
- Названия плагинов и тем должны писаться с заглавной буквы в соответствии с правилами.
- При упоминании элементов меню, подписей к кнопкам или параметров форм пишите с заглавной буквы только первую букву первого слова — например: «Нажмите кнопку «Новая тема», чтобы начать писать».
- Если в интерфейсе что-то написано с заглавной буквы по уважительной причине, используйте тот же регистр при написании документации об этом.
- Названия категорий и URL-слэги всегда пишутся со строчных букв.
В случае сомнений используйте регистр предложения.
Точки
Не используйте точку в следующих случаях:
- Всплывающие подсказки, подписи к изображениям или другие элементы интерфейса, состоящие только из одного предложения
- Подписи к кнопкам
- Элементы меню
- Элементы списка, не содержащие глагол
Используйте точку в следующих случаях:
- Обычные предложения
- Всплывающие подсказки, подписи к изображениям или другие элементы интерфейса, состоящие более чем из одного предложения
- Элементы списка, содержащие глагол
- Альтернативный текст (
alt) для изображений
Оговорка для элементов списка: Если вы составляете список со смешанными элементами (то есть некоторые требуют точки, а некоторые — нет), используйте точки для всех элементов.
Акцентирование
Для акцентирования слов по умолчанию используйте курсив. Вы также можете использовать жирный шрифт, если считаете, что это уместно в контексте.
Обратные кавычки
Используйте обратные кавычки (`) для встроенного кода, примеров URL-адресов и названий настроек. Не используйте их ни для каких других целей.
Блоки кода
При включении блоков кода указывайте язык программирования везде, где это возможно, добавляя его сразу после открывающей ограды (первичные три обратные кавычки) — например, ```css.
