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

1. Название статей

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

1.1. Общие требования

  • название начинается с существительного в именительном падеже (отвечает на вопрос «что?»);

  • точка в конце названия не ставится;

  • название не должно превышать 5–7 слов.

1.2. Для регламентов

Слово «Регламент» в названии не используется. Название должно описывать процесс или действие.

  • Правильно: «Обработка входящего обращения», «Закрытие сделки», «Документооборот по сделке».

  • Неправильно: «Регламент обработки обращений», «Регламент закрытия сделки».

1.3. Для инструкций

Инструкция описывает последовательность действий. Название не должно начинаться со слова «Как» или содержать вопросительную форму.

  • Правильно: «Создание компании», «Редактирование полей контакта».

  • Неправильно: «Как создать компанию», «Как редактировать поля контакта».

1.4. Для справочных статей

Справочные статьи описывают сущности, термины или общие понятия. В названии используется имя существительное, обозначающее эту сущность.

  • Примеры: «Контакт», «Сделка», «Компания», «Воронка продаж».

2. Заголовки

  1. Начертание: Заголовки всех уровней (H1, H2, H3) никогда не выделяются жирным шрифтом. Для них используются встроенные стили платформы Confluence.

  2. Выравнивание: Все заголовки выравниваются строго по левому краю. Выравнивание по центру или правому краю не допускается.

  3. Оглавление:

    • Оглавление генерируется автоматически средствами Confluence.

    • В оглавлении отображаются заголовки уровня H1 и H2.

    • Заголовки уровня H3 не включаются в оглавление. Глубина вложенности настраивается в свойствах платформы.

3. Текст и абзацы

  1. Стиль: Используется безличный стиль (например, «Необходимо создать компанию», «Проверить наличие дублей»).

  2. Длина абзаца: Абзацы должны быть короткими. Рекомендуемая длина — 1–3 строки. Длинные «простыни» текста не допускаются.

4. Списки

  1. Маркер: Для списков используется символ «•» (точка). Дефис «-» в качестве маркера не используется.

  2. Пунктуация:

    • если пункты списка - короткие фразы, в конце каждого ставится точка с запятой;

    • в конце последнего пункта ставится точка;

    • если пункты - законченные предложения, в конце каждого ставится точка.

  3. Интервалы: Интервалы между пунктами списка не ставятся.

    • Правильно:
      • пункт;
      • пункт;
      • пункт.

    • Неправильно:
      • пункт;

      • пункт;

5. Нумерованные списки

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

Пунктуация применяется та же, что и для маркированных списков.

Пример:

  1. пункт;
  2. пункт;
  3. пункт.

6. Таблицы

  • Таблицы применяются для сроков, KPI и сравнения сценариев.

  • Оформление таблиц должно быть единообразным во всех документах.

7. Иконки и выделение

  • Иконки: Допускается использовать иконки для визуального акцента: 🎯 цель, 📞 звонок, ⚠️ важно, 📌 правило, 📊 контроль. Иконки не заменяют текст.

  • Выделение: Критические требования выделяются жирным шрифтом или маркерами: «Важно!», «Критично», «Обязательно», «Запрещено».

  • Макрос «Предупреждение»: Используется для информации, требующей особого внимания.

    • Когда: критичные требования, важные уточнения, запреты, предупреждения о последствиях.

    • Как: краткий текст (1-3 предложения), внутри допускается жирное выделение, списки не используются.

    • Пример: 

ИНН обязателен. Это критично.

  • Макрос «Примечание»: Используется для:

    • уточнения, на которые нужно обратить внимание;

    • пояснения, как именно выполнять действие;

    • критерии выбора из нескольких вариантов.

    • Пример:

При выборе маршрута ориентироваться на карту провинций.

  • Макрос «Информация»: Используется для:
    • пути хранения файлов и папок;
    • указание на то, что действие не требуется.

    • Примеры:

Если почта содержит имя и фамилию, рекомендуется записать их в имя контакта.

Продажи. Договоры и поручения → [Название контрагента]

8. Изображения

  1. Форматы файлов:

    • PNG - для скриншотов интерфейсов;
    • JPG - для фотографий;
    • GIF - для анимации.

  2. Размер файла: Максимальный размер загружаемого файла - не более 1000 КБ (1 МБ). Тяжёлые изображения необходимо сжимать перед загрузкой.

  3. Выравнивание: Все изображения выравниваются по левому краю.

9. Настройка отображения изображений в Confluence

В Confluence доступны три предустановленных режима отображения изображений: маленький, средний и большой размер. Важно понимать, что эти размеры не являются
фиксированными в пикселях - они рассчитываются относительно исходного размера загруженного файла.

  • Маленький: ширина изображения уменьшается примерно до 25% от оригинала.

  • Средний: ширина изображения уменьшается примерно до 50% от оригинала.

  • Оригинальный: изображение отображается в исходном размере.

Как выбрать подходящий режим:

Тип изображенияРекомендуемый режимПояснение
Вертикальный скриншот (высокий)МаленькийВысокие изображения занимают много места. Уменьшение до 25% сделает их компактнее, не теряя читаемости.
Горизонтальный скриншот (широкий)Средний или оригинальныйЕсли на скриншоте много деталей по ширине, средний размер (50%) часто оптимален. Оригинал используется, когда важна каждая деталь.
GIF-анимацияМаленькийАнимированные изображения лучше смотрятся в компактном формате. Маленький размер (25% от оригинала) делает их аккуратными и не отвлекающими.
Схема процесса или таблицаОригинальныйСхемы и таблицы должны читаться без напряжения, поэтому рекомендуется оставлять оригинальный размер.
Фрагмент интерфейса (кнопка, поле)МаленькийДля показа мелких элементов интерфейса достаточно маленького размера.

Общие принципы:

  1. Никакой горизонтальной прокрутки. Изображение не должно заставлять пользователя прокручивать страницу вправо.
    Если оригинал слишком широкий, использовать средний или маленький режим.

  2. Читаемость важнее размера. Если при уменьшении изображение теряет детали (мелкий текст становится неразборчивым),
    оставлять оригинальный размер.

  3. Единообразие. В рамках одного документа использовать одинаковые режимы отображения 
    для однотипных изображений (например, все скриншоты интерфейса - средний размер).

9.1 Оформление изображений и гифок (макрос «Раскрыть»)

Для вставки изображений и гифок используется макрос «Раскрыть». 
Это позволяет скрыть медиафайл под сворачиваемым блоком.

9.2 Когда нужен заголовок в макросе

Заголовок внутри макроса «Раскрыть» используется только для гифок (анимаций).
Для обычных статичных изображений заголовок не заполняется.

  • Для гифок: в поле «Заголовок» макроса пишется краткое описание того, что показывает анимация.

    • Пример: «Добавление компании из карточки сделки (gif)»

  • Для изображений: поле «Заголовок» не редактируется.

9.3 Примеры оформления

Пример А (гифка):

Пример Б (статичное изображение):

10. Связанные статьи

Если регламент связан с другими документами, в конце
добавляется раздел с кликабельными ссылками на них с помощью макроса "Ссылка"

11. Блочная структура страницы

  • Использование блоков: Весь контент создаётся внутри отдельных блоков (макросов Confluence). Это позволяет перемещать, добавлять или удалять элементы.

  • Как это выглядит: При нажатии на кнопку "Разметка страницы", открывается меню действий.

  • Доступные действия:

    • Добавить раздел - вставить новый блок;

    • Удалить блок - убрать элемент;

    • Переместить блок вверх / вниз - изменить порядок блоков.

  • Зачем это нужно: Блочная структура позволяет быстро переформатировать документ без нарушения вёрстки.