Категории

Оформление статей

Если клиентам легко ориентироваться в статьях о ваших продуктах или услугах, вы получаете преимущества:

  • аудитория становится лояльнее — растут продажи, вас рекомендуют,
  • отдел поддержки тратит меньше времени на простые вопросы — их просто нет, либо сотрудники оперативно ссылаются на статьи из вашей Базы знаний вместо того, чтобы расписывать детали.

Рассказываем, как оформить статьи в Базе знаний так, чтобы вашим клиентам и сотрудникам было максимально удобно с ними работать.


Структура

Хорошая структура материала — половина его успеха. Делите статью на разделы, разделы — на подразделы, текст в них — на абзацы, длинные предложения — на короткие. Чем лучше структурирован текст, тем проще его воспринимать.

Содержание статьи

Создавайте кликабельные содержания в начале статей, если статьи длинные. Сделать это можно с помощью html-якорей в режиме «Код».


С помощью якоря пользователь, читающий вашу статью, может сразу переместиться в нужный ему раздел. Например:


Вот так выглядит код содержания этой статьи:


Якори — связка из html-тегов вида <a href="#example"> и <a name="example">. На месте слова example может быть любое придуманное вами слово. Html-тег вида <a href="#example"> делает слово после него кликабельным — при клике пользователь переместится туда, где был установлен html-тег вида <a name="example">.

Логично, что несколько мест в статье — скажем, пункты А, Б и В — могут отсылать читателя в пункт Г. Но отсылать из А, Б и В сразу в два пункта невозможно. Соответственно, использовать тег <a href="#example"> в статье можно несколько раз, а <a name="example"> — только один.

Удобнее всего называть якоря в соответствии с тем, о чём идёт речь в разделе. Например, если из содержания вы отсылаете пользователя в раздел «Как создать задачу», якорный тег можно сделать таким — <a href="#creatingtask">. Соответственно, в месте, куда пользователь будет перенаправлен, нужно будет поставить тег <a name="creatingtask">.

Html-код чувствителен к регистру. Например, якорь <a href="#Viber"> и якорь <a href="#viber"> — разные. Это важно учитывать, чтобы якоря работали корректно.

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


Хештеги

Добавьте несколько хештегов по теме статьи в конце текста — так клиентам будет легче искать нужную информацию в вашей Базе знаний.


Грамотность, ясность и полнота

  • Текст должен быть грамотным — ошибки и опечатки снизят доверие клиентов.
  • Заголовки должны четко отражать суть статьи/раздела/подраздела.
  • Во время написания статьи задумайтесь, какие вопросы могут возникнуть у клиентов, и учитывайте их в статье. Готовый материал можно дать прочесть стороннему человеку. После прочтения хорошего материала у клиента не должно оставаться вопросов.
  • Если в тексте упоминаются функции/сервисы/прочее, о чем у вас уже есть статья в Базе — обязательно сделайте гиперссылку на эту статью. Так вы мотивируете пользователей к изучению вашего продукта и исключите лишние вопросы.
  • Приводите примеры. Важно рассказывать не только о том, как чем-то пользоваться, но и зачем это делать. Читатель должен понимать, какую пользу ему принесёт тот или иной ваш продукт/функция/услуга/и т. д.
  • Иллюстрируйте текст. Редактор Базы знаний поддерживает вставку изображений, GIF и видео с YouTube. Почти всегда лучше один раз что-то показать, чем писать несколько абзацев.
    • Вставить изображение или GIF можно, нажав на кнопку «Изображение» и выбрав файл с компьютера, либо вставив html-код вида в режиме редактирования статьи «Код». В кавычках (в нашем примере — https://site.ru) должна быть указана ссылка на ваше изображение/GIF — её можно скопировать, кликнув по изображению/GIF правой кнопкой мыши и выбрав пункт «Копировать адрес изображения»;
    • Вставить видео с YouTube можно, кликнув по видео правой кнопкой мыши и выбрав пункт «Копировать HTML-код». Скопированный код вставьте в статью в режиме редактирования «Код»;
  • Чтобы текст легче воспринимался, пользуйтесь форматированием — выделяйте важную информацию полужирным, курсивом или цветом так или так, не забывайте о возможности создавать нумерованные или маркированные списки.
  • Важна и последовательность изложения информации. Подумайте, какой порядок изложения будет наиболее правильным для вашего продукта или услуги.

    Например, мы сначала рассказываем о том, как подключить какую-то функцию, затем о её настройке, далее — о возможностях, пользе и кейсах, то есть максимально раскрываем полезность функции, в том числе на примерах.