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

Правила написания статей в FAQ

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

  1. При написании статьи нужно использовать шаблон Практическое руководство (How-to article).
  2. Заголовок статьи должен быть кратким и ёмким, чтобы из него было понятно о чем пойдет речь в статье.
  3. В начале статьи в двух предложениях должна быть раскрыта «боль» сотрудника, которую эта статья решает.
  4. Каждую статью необходимо снабжать метками, чтобы можно было быстро найти статьи одной тематики.
  5. Используйте заголовки и макрос Таблица Контента, для вывода содержимого статьи в её начале.
  6. Каждая статья должна содержать скриншоты интерфейсов, чтобы сотрудникам было удобно ориентироваться в контексте статьи.
  7. Большие скриншоты должны размещаться в макрос expand.
  8. Если в статье добавляется видео, оно выводит с помощью макроса multimedia и скрывается в макрос expand.
  9. Статья должна содержать пошаговое описание решения вопроса, который стоит перед сотрудником.
  10. Названия полей и элементов выделяются жирным шрифтом. Дополнительно размещаем скриншот интерфейса в виде ссылки или в макросе expand.
  11. После того, как статья написана, внимательно прочтите её ещё раз и поправьте неточности.
  12. После сохранения дайте прочитать статью коллеге.
  13. Если вы создаете раздел, в котором будут находиться статьи, обязательно размещайте в нем макрос Просмотр дочерних элементов и отмеченной галкой Показать потомков.