Примеры форматирования

На этой странице представлены все доступные варианты форматирования в нашей документации.

Это образец форматирования. Все названия, параметры, шаги и значения на этой странице являются условными. Они не описывают реальный продукт или функцию.

1. Информационные блоки

Выделяйте важную информацию с помощью цветных блоков.

Совет — Полезный совет, который упрощает работу.

Примечание — Дополнительная информация, которую стоит знать.

Важно — Обратите внимание на это, прежде чем продолжить.

Предупреждение — Критически важная информация, которая поможет избежать проблем.

2. Пошаговые инструкции

Проведите читателя через процесс с помощью пронумерованных шагов.

Подготовьте элемент

Откройте страницу-пример и найдите элемент, который хотите изменить.

Заполните данные

Введите пример названия и краткое описание в поля формы.

Сохраните изменения

Выберите Сохранить, чтобы сохранить изменения.

Проверьте результат

Проверьте обновлённый элемент и убедитесь, что он выглядит ожидаемо.

3. Вкладки

Показывайте разные варианты или версии одного и того же содержимого.

Вариант A

Пример варианта A

Пример использования:

1 пример элемента
Базовая функция
Стандартная поддержка

4. Карточки навигации

Быстрые ссылки на связанные разделы.

Начало работы Настройки аккаунта Безопасность Организации

5. Разворачиваемые секции

Скрывайте дополнительные сведения, которые читатель может развернуть при необходимости.

Какие форматы файлов поддерживаются?

Это пример ответа. В этом образце поддерживаются следующие форматы:

Первый формат
Второй формат
Третий формат

Как отменить изменение?

Пример шагов:

Откройте страницу-пример
Выберите «Отменить»
Подтвердите выбор

Изменение отменяется сразу.

Можно ли изменить этот параметр позже?

Да, это пример ответа. Изменения вступают в силу после следующего сохранения.

6. Структура файлов

Покажите организацию папок и файлов.

- - План проекта.pdf
  - Бюджет.xlsx
  - Презентация.pptx
Заметки.txt

7. Таблицы

Упорядочивайте данные по строкам и столбцам.

Функция	Вариант A	Вариант B	Вариант C
Элементы	1	10	100
Размер	Малый	Средний	Большой
Поддержка	Базовая	Стандартная	Расширенная
Пользовательская настройка	Нет	Да	Да

8. Контент на всю ширину

Контент, который выходит за пределы обычной ширины страницы.

Этот блок занимает всю ширину страницы. Такой формат удобен для важных объявлений и широких изображений.

9. Примеры кода

Для технических пользователей, которым нужно видеть код.

Код в строке: используйте Ctrl+S, чтобы сохранить, или Cmd+S на Mac.

Блок кода с подсветкой синтаксиса:


{
  "name": "John Smith",
  "email": "john@example.com",
  "mode": "A",
  "active": true
}

10. Комбинированный пример

Так несколько элементов работают вместе.

Следуйте этим примерным шагам, чтобы настроить пример рабочего пространства.

Выберите режим

Режим A

Используйте режим A для простого примера рабочего процесса.

Настройте параметры

Для примера настройте следующее:

Пример параметров

Просмотрите параметры примера:

Откройте меню примера
Проверьте «Пример списка»
Удалите ненужные элементы

Пример уведомлений

Настройте примеры уведомлений:

Ежедневная сводка — пример краткого обзора
Мгновенные оповещения — пример срочных обновлений
Еженедельный отчёт — пример общего обзора

Подключение внешнего сервиса

Подключите сервис-пример для синхронизации элементов:

Сервис A
Сервис B
Сервис C

Пригласите участников

Только пример: приглашённые пользователи получили бы сообщение с инструкциями по присоединению.

Итоги

Элемент	Лучше всего подходит для
Информационные блоки	Выделение советов, предупреждений и важных заметок
Шаги	Проведение пользователей через процессы
Вкладки	Показ альтернатив или вариантов
Карточки	Навигация к связанному контенту
Разворачиваемые секции	Вопросы и ответы (FAQ) и дополнительные сведения
Структура файлов	Показ организации файлов
Таблицы	Сравнение функций или данных
Контент на всю ширину	Важные объявления
Примеры кода	Техническая информация