Дизайн контента: как оформлять статьи в Базе знаний, чтобы их читали?

Не секрет, что при большой информационной нагрузке важную роль играет не только сам текст и его смысл, но и оформление. Статьи для Баз знаний – не исключение. Их используют для работы сотрудники службы поддержки, сервисные службы – те, кому важно быстро находить четкие ответы на вопросы и получать максимум пользы от корпоративной информации.

И задача не в том, чтобы просто красиво оформить текст, а сделать его информативным, удобным в работе и легко находимым. Правильно оформленную статью легче и интереснее читать, информация усваивается лучше, а коллеги меньше устают и больше концентрируются.

Так как же писать и оформлять статьи так, чтобы их охотно читали?

1. Избегайте длинных «портянок» и безликих текстов. Такой текст сложно воспринимается, тяжело усваивается и мало запоминается. Если информации много, используйте списки, таблицы, часть информации замените схемами или оживите иллюстрациями.

2. Не заставляйте читателя бесконечно скролить длинный текст. Делайте все, чтобы избежать прокрутки на странице. Важно, чтобы пользователь мог получить всю необходимую информацию, охватив взглядом экран. Для этого в статьях используйте вкладки – табы и коллапсы. Так вы структурируете текст по подтемам, и пользователям будет удобнее читать.

3. Для каждого типа статей используйте свои шаблоны. Привычная структура подачи материала поможет пользователям лучше ориентироваться в тексте и быстрее находить нужную информацию. Например, у нас в системе есть больше 20 готовых преднастроенных шаблонов (новости, товар, быстрый ответ, скрипты, продукты и др.). А еще вы можете создавать их сами и редактировать уже готовые (про них мы поговорим ниже).

Примеры шаблонов:

4. Название статьи должно быть коротким и емким. Если вы понимаете, что смысл не раскрыт, используйте альтернативные заголовки. Альтернативный заголовок хорошо индексируется и имеет высокий приоритет. Если пользователь будет искать статью и введет в поисковую строку слово или фразу из альтернативного заголовка, то нужная статья сразу окажется в поисковой выдаче. Еще в названии лучше не использовать нижние подчеркивания, кавычки и другие символы. Зато их можно использовать, если нужно, в альтернативном заголовке.

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

Пример 1, оглавление справа:

Пример 2, оглавление перед текстом:

6. Старайтесь разбивать статьи по темам и писать короткие тексты – пусть лучше из одной статьи получится 2 или 3.

Например, нужно написать регламент по переводам для юридических и физических лиц. В этом случае лучше разбить текст на 2 отдельные статьи. Тогда вносить изменения, которые коснулись, к примеру, только информации для юридических лиц, будет намного проще.

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

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

7. Используйте в работе сценарии, скрипты и интерактивные инструкции. Эти инструменты помогают превращать сложные и длинные тексты в удобные пошаговые действия. Также скрипты активно используются в клиентском сервисе.

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

Лучше не создавать очень длинные скрипты: редактировать их будет достаточно сложно и неудобно. По возможности, разбивайте их на тематические отдельные инструкции. Старайтесь сокращать описание, чтобы каждый шаг не превращался в отдельный текст.

У нас в системе пользователь может создавать и редактировать скрипты в виде блок-схем с помощью конструктора. В визуальном редакторе любой сложный алгоритм диалога или инструкции можно набросать за пару минут.

Дальше блок-схема превращается в пошаговый инструмент с кнопками, который удобен для операторов службы поддержки или для адаптации нового сотрудника.

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

1. Используйте ссылки и связанные объекты, чтобы пользователю было удобнее переходить на статьи по смежным тематикам.

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

Ссылаться можно на другие статьи, документы, страницы или витрины, а также на внешние системы, например, на таск-трекеры.

В нашей системе есть готовые интеграции с Яндекс.Трекером, с Kaiten и с Jira. Если вы ссылаетесь на задачу в трекере, то в статье можно увидеть ссылку на эту задачу и ее актуальный статус.

2. Если у вас есть повторяющаяся информация, которая используется в разных статьях, например, реквизиты компании, то в нашей системе для этого есть отдельный шаблон, который называется «Фрагмент». Его можно многократно использовать в разных статьях, скриптах и документах. Смысл в том, что при смене реквизитов вам нужно будет внести изменения только в этот шаблон. Информация обновится автоматически во всех статьях, где она используется.

1. Следите за размером, весом и качеством графических и видеофайлов. Делайте так, чтобы пользователю было удобно просматривать контент, в т.ч. со смартфона.

2. Не перестарайтесь с оформлением. Главная задача – сделать информацию простой, удобной и легкой для восприятия. Визуальное оформление должно помогать в этом.

3. Процессы лучше оформлять в виде блок-схем и графиков. В нашей системе это удобно делать непосредственно в статье через инструменты draw.io, PlantUML и Mermaid.

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

5. Используйте простые шрифты. Это могут быть фирменный шрифт компании или стандартные шрифты. Если вы хотите использовать фирменный шрифт, то лучше сразу установить его в настройках системы и задать нужный размер, чтобы использовать эти значения по умолчанию. Избегайте слишком декоративных шрифтов, они плохо читаются.

6. Фон статьи должен быть контрастным по отношению к тексту и не ярким. Лучшее и классическое сочетание – светлый фон и черный или темный текст.

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

А если это официальный регламент или статья «Какие документы необходимы для оформления ипотеки», то иллюстрации тут будет мешать – лучше использовать нумерованный или маркированный список.

В общеобразовательных статьях будут легко усваиваться видео уроки, иллюстрации и картинки. Пользователю будет удобно, если сплошной длинный текст будет разбит по абзацам.

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

1. Если вы храните документы в форматах PDF, Word, Excel и т.д., то размещайте их в папках. Правила создания и использования иерархического дерева и папок:

2. Создавайте преднастроенные, то есть частично заполненные, шаблоны. Если у вас есть статьи, которые регулярно повторяются и похожи по оформлению, например, карточки товара, протоколы встреч или скрипты для колл-центра, то будет удобнее один раз создать шаблон и каждый раз его заполнять, чем создавать с нуля.

3. Используйте глоссарий – словарь специальных терминов. С его помощью можно подсветить термины и аббревиатуры в тексте.

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

5. Перед тем как создавать статью, проанализируйте, кто будет ее читать и зачем - от этого будет зависеть оформление.

Например, если вы планируете, что ваши пользователи будут выгружать статью в виде файлов (doc, pdf), чтобы распечатать или отправить клиенту (партнеру и т.д.), то убедитесь, что в статье нет видео, вставок iframe, таблицы с большим количеством столбцов, вертикального разделителя текста и табов (вкладок). Такие элементы при конвертации в документ будут бесполезны. Лучше создавать статью «линейно» и использовать больше текста, сохраняя структуру и разбивку на заголовки - так она будет сохранять вид файла.

В конечном итоге, нет никакого «секретного ингредиента» при оформлении текстов – соблюдая эти несложные правила, написать удобный текст для Базы знаний сможет каждый.

Важно не пропускать подготовительную работу, то есть, четко определить, для кого и зачем вы пишете. Можно выяснить у коллег, какие тексты им были бы более полезны. А дальше – пишите, используя правила и инструменты оформления. Хорошо, если возможности базы знаний, которую вы используете, будут широкими и гибкими.

Самое главное – создавайте легкий, логичный и структурированный текст, который вовлекает в чтение и будет полезен. Тогда тексты будут рабочими инструментами, а не скучной обязанностью.