В этом документе собраны рекомендации по написанию статьей в справочный центр, их оформлению и доведению до пользователей.
- При написании статьи нужно использовать шаблон Практическое руководство (How-to article).
- Заголовок статьи желательно делать кратким и ёмким, чтобы из него было понятно о чем пойдет речь в статье.
- В начале статьи в двух предложениях рекомендуется раскрыть «боль» сотрудника, которую эта статья решает.
- Каждую статью необходимо снабжать метками, чтобы можно было быстро найти статьи одной тематики.
- Используйте заголовки и макрос Таблица Контента, для вывода содержимого статьи в её начале.
- К каждой статье нужно добавлять скриншоты интерфейсов, чтобы сотрудникам было удобно ориентироваться в контексте статьи.
- Большие скриншоты рекомендуется размещать в макрос expand.
- Если в статье добавляется видео, оно выводит с помощью макроса multimedia и скрывается в макрос expand.
- Необходимо, чтобы статья содержала пошаговое описание решения вопроса, который стоит перед сотрудником.
- Названия полей и элементов выделяются жирным шрифтом. Дополнительно размещаем скриншот интерфейса в виде ссылки или в макросе expand.
- После того, как статья написана, внимательно прочтите её ещё раз и поправьте неточности.
- После сохранения дайте прочитать статью коллеге.
- Если вы создаете раздел, в котором будут находиться статьи, обязательно размещайте в нем макрос Просмотр дочерних элементов и отмеченной галкой Показать потомков.