1. Home
  2. Docs
  3. Инструкции по работе с Confluence
  4. Статьи
  5. Правила оформления статей

Правила оформления статей

Пишите короткое и понятное название для статьи.

Форматирование статьи

Используйте встроенные возможности форматирования:

Используйте заголовки, для разбития смысловых блоков, выделяя их:

Разбивайте текст на абзацы (в одном абзаце 4-5 предложений) — так его будет легче воспринимать.

Если что-то перечисляете — используйте списки (в статье Правила оформления списков (перечней) можно почитать о них подробнее):

Пишите понятно, иллюстрируя страницы скриншотами (или видеоинструкциями). Скриншоты и видео должны прикрепляться к статьям через функцию «Вставить файлы и изображения»:

Большие скриншоты скрывайте в макрос Раскрыть (expand).

Чтобы разделить контент статьи на блоки, используйте секции:

Упоминание пользователей

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

Совет: рекомендуем изучить статьи (link) про работу с макросами в Confluence. Они помогают организовать и вывести нужный контент на страницах статей.