Документация и база знаний

Что входит в эту категорию

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

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

Личные знания и знания небольшой команды относятся к заметкам и вики. Очередь тикетов, куда приходят вопросы без ответа, это поддержка клиентов.

Структура решает, найдут ли что-нибудь

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

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

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

Теги и подсказки похожих статей помогают, когда их поддерживают. Вручную их долго никто не поддерживает, поэтому предпочитайте продукты, которые строят связи по содержанию.

Написание, ревью и поддержание правдивости страниц

Документация гниёт тихо. Страница, верная в марте, к сентябрю превращается в тикет, и по ней ничего не заметно.

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

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

Публикация и вопрос поиска

Публичный справочный центр это сайт, и вести себя он должен как сайт.

• Чистые адреса, переживающие реорганизацию, с редиректами там, где это невозможно.
• Редактируемые заголовки и описания для каждой статьи, а не сгенерированные из первой строки.
• Быстрые страницы без тяжёлого приложения, которое загружается раньше, чем появится текст.
• Карты сайта, обновляющиеся при публикации, а не по расписанию, о котором никто не помнит.
• Собственный домен, чтобы материалы копили авторитет вашего сайта, а не сайта вендора.

За последний пункт стоит побороться внутри компании. Документация часто лучший по эффективности контент софтверной компании, и размещение её на поддомене вендора отдаёт этот трафик.

Измерение и единственная метрика, которая важна

Просмотры страниц почти ничего не говорят. Две цифры говорят многое.

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

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

Как тарифицируются эти продукты

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

Следите за тремя границами. Собственные домены, версионирование и единый вход (SSO) обычно находятся на ступень выше начального тарифа. Четвёртая граница это глубина аналитики. Вендоры, которые продают справочный центр вместе с продуктом для поддержки, часто оценивают его как дополнение, а не включают в цену, и это одна из привычек, собранных в материале что скрывают страницы с тарифами.

Прежде чем решиться, экспортируйте всё и прочитайте результат. Markdown или чистая разметка означают, что вы можете уйти. Проприетарный формат означает, что архив в заложниках.

Справочный центр с нуля

Первая версия должна быть до неловкости маленькой.

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

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

Затем позвольте структуре сложиться самой. После тридцати статей категории становятся очевидными, а навязывать их на пятой статье значит всё равно потом перестраивать.

Публикуйте поисковые запросы без результата как очередь на написание. Это единственный контент-план в этой категории, который никогда не кончается и никогда не ошибается.