6.03. Базы знаний
Базы знаний
В процессе работы любому работнику может потребоваться помощь. Да, конечно, можно обращаться и «дёргать» знающих, пока те не выгорят и не пошлют куда подальше. И именно для того, чтобы сконцентрировать все нужные знания в одном месте, используется специальный инструмент - база знаний.
★ База знаний — это структурированная коллекция информации, организованная таким образом, чтобы её можно было легко найти, использовать и обновлять. Это обеспечивает хранение и систематизацию знаний. Базы знаний могут относиться к конкретным инструментам - библиотекам, программам, платформам, системам, так и к более мультисферной информации - методологии, регламенты, теория, внутренняя структура и типовые решения задач. Но основное содержание - справочная информация.
★ Какие важнейшие принципы базы знаний?
- Централизация. Информация всегда должна храниться в одном месте, что упростит доступ к ней.
- Структурированность. Данные должны быть организованы по категориям, тегам или другим логическим принципам, что облегчает поиск.
- Доступность. База знаний может быть внутренней (для сотрудников) и публичной (для клиентов).
- Актуальность. База знаний должна регулярно обновляться, чтобы отражать изменения своевременно.
- Поиск и навигация. В базе данных должны использоваться встроенные механизмы поиска, что будет позволять быстро находить нужную информацию.
Так и будет решено множество проблем. Если сотрудник уходит из компании, его знания остаются в базе данных, а не теряются. Новые сотрудники будут быстрее адаптироваться, используя базу знаний как справочник. Именно с этой целью, к примеру, и я создал базу знаний по ГИСОГД и ИСУП, когда работал в структуре оператора этих систем, вложив все свои накопленные знаний и инструкции по работе, чтобы исключить зависимость и обеспечить надёжность работы даже после моего ухода из компании.
База знаний повышает эффективность работы - сотрудники меньше тратят время на поиск решений, так как информация уже систематизирована, а также это позволяет автоматизировать процессы поддержки через самообслуживание, к примеру, при обращении в техническую поддержку, отправлять ссылку на статью, где описывается решение. Помню, я к такому пришёл, когда на первичных стадиях, ещё в самом начале тестирования систем, отправлял однотипные ответы на однотипные вопросы. Тогда появился FAQ (раздел вопросы и ответы), а потом это всё превратилось в инструкции, которые стали основой для базы знаний. Можно избежать такой «эволюции», если изначально строить базу знаний. Клиенты могут самостоятельно находить ответы, что снизит нагрузку на службу поддержки, а единый источник «правды» минимизирует ошибки в коммуникации. Кроме того, база знаний позволяет сохранять решения проблем, лучшие практики и уроки, извлечённые из прошлого опыта.
★ Типы баз знаний:
- внутренние базы знаний (используются сотрудниками компании);
- внешние базы знаний (для клиентов или пользователей);
- технические базы знаний (информация о работе программного обеспечения, API, багах и их исправлениях);
- образовательные базы знаний (для обучения и развития навыков).
Создание базы знаний - многоступенчатый процесс.
Сначала определяются цели - для чего нужна база знаний и кто будет её основными пользователями? Затем выполняется сбор информации - собираются все доступные данные: документы, руководства, ответы на вопросы, решения проблем.
Полученная информация структурируется и организуется в категории, разделы, статьи. Важно предусмотреть удобную навигацию.
После сбора информации нужно выбрать платформу. Существует множество инструментов для создания баз знаний - мы их изучим отдельно. В самой платформе происходит наполнение - создаются статьи, руководства, FAQ. Важно, чтобы информация была понятной и актуальной. Зачастую этим занимаются профессионалы - технические писатели. После первичного заполнения контентом, останется лишь поддержка и обновление - регулярное добавление новых материалов и исправление устаревших данных.
Примеры реальных баз знаний:
- Корпоративные - Microsoft Docs, Atlassian Community;
- Открытые - Wikipedia, Stack Overflow;
- Технические - MDN Web Docs, Kubernetes Documentation.
★ Инструменты.
Создание базы знаний требует выбора подходящего инструмента.
- Confluence - самый популярный инструмент для корпоративных баз знаний. Разработан компанией Atlassian. Он интегрирован с Jira (для управления проектами), имеет удобный интерфейс, поддержку шаблонов и структурированных данных и гибкую настройку прав доступа. Из недостатков - платная подписка.
- MediaWiki - open-source платформа, используемая для создания таких крупных проектов, как Wikipedia. Полностью бесплатная, гибкая, предоставляет мощные возможности, но требует технических навыков (установку на сервер), и интерфейс может показаться устаревшим. Важно отметить, что она больше подойдёт для публичных баз знаний, чем для закрытых.
- Google Docs тоже можно использовать как инструмент для создания текстовых документов, из которых выстроить базу знаний. В рамках Google Workspace он бесплатный, можно легко делиться документами и даже есть совместное редактирование в реальном времени. Из недостатков - нет встроенных механизмов для структурирования данных, больше подойдёт для небольших команд.
- Microsoft Office (SharePoint) - корпоративное решение от Microsoft, которое позволяет создавать базы знаний через SharePoint или OneNote. Здесь есть интеграция с продуктами Microsoft (к примеру Outlook), готовые шаблоны и удобный интерфейс, широкие возможности настройки безопасности и контроля доступа. Но - платная подписка, так как это часть экосистемы Microsoft 365. Для мелких проектов будет избыточным.
- TiddlyWiki - лёгкая, автономная wiki-система, которая работает как один HTML-файл. Не требует установки на сервер (можно локально хранить), но функционал может быть сложным для новичков.
- BookStack - open-source платформа для создания баз знаний, ориентированная на простоту использования. Удобный интерфейс «книга-глава-страница», имеется лёгкая установка и настройка, поддержка Markdown и WYSIWYG редактора. Но возможностей чуть меньше, чем у MediaWiki.
- XWiki - расширяемая wiki-платформа с большим количеством встроенных функций. Множество расширений, встроенная поддержка API, но высокая сложность настроек, что требует технических знаний.
- DokuWiki - лёгкая wiki-система, не требующая базы данных. Простая, бесплатная, производительная. Функционал мал, да и дизайн устаревший, но подойдёт для новичков.
- Wiki.js - современная wiki-платформа, основанная на Node.js. Хороший дизайн, поддержка редакторов, интеграция с GitHub, GitLab и другими системами. Требует установки на сервер.
- Notion - платформа для организации информации и совместной работы. Платная подписка для больших команд, но гибкость и совместное редактирование в реальном времени позволяет создавать много различных инструментов (базы знаний, задачи, заметки).
- Slite ориентирована на команды. Простой, чистый интерфейс, интеграция со Slack, но платная подписка.
- Zendesk Guide - платформа, ориентированная на обслуживание клиентов. Простота использования, интеграция с Zendesk Support, но платная подписка. Больше подойдёт для внешних баз знаний.
- Help Scout Docs - простая платформа для создания баз знаний, ориентированная на поддержку клиентов. Имеется интеграция с Help Scout. Платная подписка.
- Obsidian - локальная система для создания связанных заметок и баз знаний. Работает локально, подойдёт больше для личных проектов или небольших баз знаний.
★ Создание эффективной базы знаний требует тщательного планирования её содержимого и структуры.
Что должно быть в базе знаний?
FAQ (Часто задаваемые вопросы, ЧаВО) - сборник ответов на наиболее распространённые вопросы пользователей. Такой FAQ лучше организовать по категориям (например «Учётная запись», «Настройки», «Интеграции»), и использовать простой язык, избегая технического жаргона.
Пошаговые инструкции - подробные руководства для выполнения конкретных задач. Допустим, «Как создать новую учётную запись?». Это минимизирует ошибки при выполнении действий, позволив работать по «шпаргалке». В такой инструкции важно использовать скриншоты (а можно и анимации, к примеру, GIF) для наглядности, разбивать инструкции на небольшие шаги, и включать ссылки на связанные статьи или ресурсы.
Справочные материалы - детальная информация о продукте, его функциях или возможностях. Сюда относится техническая документация, описание интерфейса, функционала, глоссарий терминов. Это помогает пользователям глубже понять продукт и является основным источником информации для разработчиков и продвинутых пользователей. Здесь используется чёткая структура по разделам, подразделам.
SDK и инструменты разработчика - информация для профессионалов, включая API, SDK, библиотеки с примерами кода. Это позволяет разработчикам эффективнее работать с продуктом. Поэтому сюда добавляется подробная документация, с параметрами, примерами кода, ссылками.
Видеоуроки - материалы в формате видеозаписей, демонстрирующие использование продукта или решение задач. Наглядный формат помогает лучше понять материал, удобен для пользователей, которые предпочитают видео тексту. Но здесь есть «ленивый» подход, когда выкладывается видео семинара, а есть «сложный» подход, который является идеальным - вместо многочасовых записей, видео короткие (5-10 минут), добавляются таймкоды для быстрого перехода к нужной части, и добавляется описание видео.
Список известных проблем - коллекция известных ошибок, багов и их решений. К примеру, если «Ошибка 404 при загрузке файла» - указывается, как исправить. Это поможет пользователям самостоятельно решать проблемы и уменьшит количество повторяющихся обращений в техническую поддержку. Но это показывает все проблемы и недоработки, может сказаться на репутации (если выложить недоработку, прямо будет видно, что вместо исправления проблемы - решение возложили на пользователей). Чтобы сделать более грамотно, нужно указывать статус проблемы («В работе»).
Структура - логическая организация контента для удобства навигации. Тут должна быть иерархичность «Категории - Подкатегории - Статьи», теги и метки по ключевым словам, и навигация (хлебные крошки, меню, фильтры). Чтобы грамотно спроектировать структуру, нужно сначала создать логическую карту сайта перед заполнением контента. В дальнейшем важно использовать шаблоны для статей, чтобы сохранять единообразие. Категории должны быть логически связаны. Разметка должна выделять заголовки (H1, H2, H3) для структурирования текста, а важные моменты выделяются жирным шрифтом или курсивом.