Я долго откладывал базу знаний. Казалось — ну какие там инструкции, кому это нужно. А потом сам три вечера не мог вспомнить, как я настроил SMB-подключение полгода назад. И понял: если я забываю свой же код — что говорить про пользователей. Так появился Knowledge.
Поиск, который понимает с полуслова
Начинаете вводить вопрос — статьи находятся на лету. «Как загрузить файл», «Почему не приходит письмо», «Где настроить тему» — ищется и по заголовкам, и по тексту. Не нужно угадывать название раздела или помнить номер страницы.
Структура, в которой не заблудишься
Все статьи разложены по разделам, как главы в хорошей книге:
- Начало работы — регистрация, профиль, обзор интерфейса
- Блог — как писать посты, управлять категориями, модерировать комментарии
- Генеалогия — всё о модуле Forest: от создания персоны до экспорта в GEDCOM
- Облако — работа с файлами, тома, тарифы, общие папки
- Администрирование — настройка сервера, пользователей, безопасности
В каждом разделе — статьи с подробными инструкциями, содержанием и перекрёстными ссылками. Как Wikipedia, только про вашу платформу.
Версии и история
Каждая статья версионируется. Если правка что-то сломала — можно откатиться к предыдущей редакции. Я сделал это специально: документация не должна терять историю. Сегодня поправили формулировку, завтра вернули старое — всё сохраняется.
Рекомендуемые статьи
В левой колонке всегда видно несколько избранных статей — самое важное, отобранное вручную. Начните с них, если не знаете, с какой стороны подойти к платформе.
Обратная связь, которая работает
В конце каждой статьи — две кнопки: «Помогло» и «Нет». Ваша оценка помогает мне понимать, какие статьи надо улучшить. А если нашли ошибку — есть кнопка «Сообщить об ошибке», и я сразу получаю уведомление.
Закладки — ваша личная библиотека
Нашли полезную статью? Сохраняете в закладки в один клик. Все сохранённые статьи собираются в блоке «Мои закладки» — персональная подборка самого нужного. Не надо держать в голове десяток URL.
Wiki-ссылки — как в настоящей энциклопедии
В тексте статей есть двойные квадратные скобки: [[Как загрузить файл]]. Это ссылки между статьями. Пишете их — и они превращаются в кликабельные переходы. Нажали — и вы уже в связанной статье. Если такой статьи пока нет — ссылка подсвечивается красным, чтобы вы знали: её надо создать.
Хорошая документация — это не «потом напишу». Это уважение к пользователю, который пришёл с вопросом.
Откройте базу знаний
Инструкции, ответы на частые вопросы и всё, что нужно, чтобы разобраться с платформой — уже там.